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

Retrieves the history details for software installation requests

PDFs

learn more

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

GET /cluster/software/history

Introduced In: 9.6

Retrieves the history details for software installation requests.

  • cluster image show-update-history

Learn more

Parameters

Name Type In Required Description

node.uuid

string

query

False

Filter by node.uuid

  • Introduced in: 9.7

node.name

string

query

False

Filter by node.name

  • Introduced in: 9.7

end_time

string

query

False

Filter by end_time

  • Introduced in: 9.7

state

string

query

False

Filter by state

  • Introduced in: 9.7

start_time

string

query

False

Filter by start_time

  • Introduced in: 9.7

to_version

string

query

False

Filter by to_version

  • Introduced in: 9.7

from_version

string

query

False

Filter by from_version

  • Introduced in: 9.7

fields

array[string]

query

False

Specify the fields to return.

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

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

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[software_history]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "end_time": "2019-02-02 20:00:00 +0000",
      "from_version": "ONTAP_X1",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "start_time": "2019-02-02 19:00:00 +0000",
      "state": "successful",
      "to_version": "ONTAP_X2"
    }
  ]
}

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

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

software_history

Name Type Description

end_time

string

Completion time of this installation request.

from_version

string

Previous version of node

  • example: ONTAP_X1

  • readOnly: 1

  • Introduced in: 9.7

  • x-nullable: true

node

node

start_time

string

Start time of this installation request.

state

string

Status of this installation request.

to_version

string

Updated version of node

  • example: ONTAP_X2

  • readOnly: 1

  • Introduced in: 9.7

  • x-nullable: true

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