Skip to main content

Retrieve information about an AutoSupport message

Contributors
PDFs

GET /support/autosupport/messages/{node.uuid}/{index}/{destination}

Introduced In: 9.14

Retrieves information about a single Autosupport message.

Parameters

Name Type In Required Description

node.uuid

string

path

True

Node UUID

index

string

path

True

AutoSupport message sequence number

destination

string

path

True

The destination for this AutoSupport message.

  • enum: ["smtp", "http", "noteto", "retransmit"]

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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
Example response 
{
  "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

error

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

Name Type Description

code

integer

Error code

message

string

Error message

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

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.