Skip to main content

Retrieve AutoSupport message history

Contributors
PDFs

GET /support/autosupport/messages

Introduced In: 9.6

Retrieves AutoSupport message history from all nodes in the cluster.

There can be a short delay on invoked AutoSupport messages showing in history, dependent on processing of other AutoSupports in the queue.

  • system node autosupport history show

Learn more

Parameters

Name Type In Required Description

node.uuid

string

query

False

Filter by node.uuid

node.name

string

query

False

Filter by node.name

destination

string

query

False

Filter by destination

state

string

query

False

Filter by state

generated_on

string

query

False

Filter by generated_on

index

integer

query

False

Filter by index

subject

string

query

False

Filter by subject

error.message

string

query

False

Filter by error.message

error.code

integer

query

False

Filter by error.code

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.

max_records

integer

query

False

Limit the number of records returned.

return_timeout

integer

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[autosupport_message]

List of messages invoked on the node
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "destination": "http",
      "error": {
        "code": "53149746",
        "message": "Could not resolve host: test.com"
      },
      "generated_on": "2019-03-25 17:30:04 -0400",
      "index": 9,
      "message": "invoked_test_autosupport_rest",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "state": "sent_successful",
      "subject": "WEEKLY_LOG",
      "type": "test",
      "uri": "https://1.2.3.4/delivery_uri"
    }
  ]
}

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

error

Last error during delivery attempt. Empty if "status=sent-successful".

Name Type Description

code

integer

Error code

message

string

Error message

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

autosupport_message

Name Type Description

destination

string

Destination for the AutoSupport

error

error

Last error during delivery attempt. Empty if "status=sent-successful".

generated_on

string

Date and Time of AutoSupport generation in ISO-8601 format

index

integer

Sequence number of the AutoSupport

message

string

Message included in the AutoSupport subject

node

node

state

string

State of AutoSupport delivery

subject

string

Subject line for the AutoSupport

type

string

Type of AutoSupport collection to issue

uri

string

Alternate destination for the AutoSupport

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.