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

Retrieve the configuration for an automatic update

Contributors
PDFs

GET /support/auto-update/configurations

Introduced In: 9.10

Retrieves the configuration for automatic updates.

Parameters

Name Type In Required Description

uuid

string

query

False

Filter by uuid

description.code

string

query

False

Filter by description.code

description.message

string

query

False

Filter by description.message

action

string

query

False

Filter by action

category

string

query

False

Filter by category

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: 1

  • 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[auto_update_configuration]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "action": "confirm",
      "category": "disk_fw",
      "description": {
        "code": "string",
        "message": "string"
      },
      "uuid": "572361f3-e769-439d-9c04-2ba48a08ff47"
    }
  ]
}

Error

Status: Default, Error
Name Type Description

error

returned_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

description

Description of the configuration row. ONTAP Message Codes

Code Description

131072401

Storage Firmware

131072402

SP/BMC Firmware

131072403

System Files
Name Type Description

code

string

Argument code

message

string

Message argument

auto_update_configuration

Name Type Description

_links

_links

action

string

The action to be taken by the alert source as specified by the user.

category

string

Category for the configuration row.

description

description

Description of the configuration row.

ONTAP Message Codes

Code — Description

131072401 — Storage Firmware

131072402 — SP/BMC Firmware

131072403 — System Files

uuid

string

Unique identifier for the configuration row.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.