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

Retrieves the software or firmware download status

PDFs

learn more

  • [doc /cluster/software](#docs-cluster-cluster_software)

GET /cluster/software/download

Introduced In: 9.7

Retrieves the software or firmware download status.

  • cluster image package check-download-progress

Learn more

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

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.
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response