Skip to main content
REST API reference
A newer release of this product is available.

Retrieve the software or firmware download status

Obtains the current download status of software or firmware, helping you monitor ongoing download progress.

HTTP method and endpoint

GET /cluster/software/download

Introduced in

ONTAP 9.7

Usage notes

Retrieves the software or firmware download status.

  • cluster image package check-download-progress

Parameters

Name Type In Required Description

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Specify the fields to return.

return_timeout

integer

query

False

Response

Status: 200, Ok
Name Type Description

code

integer

Code corresponds to download message

message

string

Download progress details

state

string

Download status of the package

Example response
{
  "code": "10551496",
  "message": "Package download in progress",
  "state": "success"
}

Error

Status: Default, Error
Name Type Description

error

error

Example error
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.