Skip to main content

Retrieve a collection of event destinations

Contributors
PDFs

GET /support/ems/destinations

Introduced In: 9.6

Retrieves a collection of event destinations.

  • event notification destination show

  • event notification show

Parameters

Name Type In Required Description

type

string

query

False

Filter by type

destination

string

query

False

Filter by destination

system_defined

boolean

query

False

Filter by system_defined

  • Introduced in: 9.10

syslog.transport

string

query

False

Filter by syslog.transport

  • Introduced in: 9.12

syslog.port

integer

query

False

Filter by syslog.port

  • Introduced in: 9.12

syslog.format.message

string

query

False

Filter by syslog.format.message

  • Introduced in: 9.12

syslog.format.timestamp_override

string

query

False

Filter by syslog.format.timestamp_override

  • Introduced in: 9.12

syslog.format.hostname_override

string

query

False

Filter by syslog.format.hostname_override

  • Introduced in: 9.12

access_control_role.name

string

query

False

Filter by access_control_role.name

  • Introduced in: 9.13

name

string

query

False

Filter by name

filters.name

string

query

False

Filter by filters.name

certificate.serial_number

string

query

False

Filter by certificate.serial_number

  • maxLength: 40

  • minLength: 1

certificate.ca

string

query

False

Filter by certificate.ca

  • maxLength: 256

  • minLength: 1

certificate.name

string

query

False

Filter by certificate.name

  • Introduced in: 9.11

connectivity.state

string

query

False

Filter by connectivity.state

  • Introduced in: 9.11

connectivity.errors.node.uuid

string

query

False

Filter by connectivity.errors.node.uuid

  • Introduced in: 9.11

connectivity.errors.node.name

string

query

False

Filter by connectivity.errors.node.name

  • Introduced in: 9.11

connectivity.errors.message.arguments.message

string

query

False

Filter by connectivity.errors.message.arguments.message

  • Introduced in: 9.11

connectivity.errors.message.arguments.code

string

query

False

Filter by connectivity.errors.message.arguments.code

  • Introduced in: 9.11

connectivity.errors.message.message

string

query

False

Filter by connectivity.errors.message.message

  • Introduced in: 9.11

connectivity.errors.message.code

string

query

False

Filter by connectivity.errors.message.code

  • Introduced in: 9.11

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

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

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

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[records]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "access_control_role": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "admin"
      },
      "certificate": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "ca": "VeriSign",
        "name": "string",
        "serial_number": 1234567890
      },
      "connectivity": {
        "errors": [
          {
            "message": {
              "arguments": [
                {
                  "code": "string",
                  "message": "string"
                }
              ],
              "code": "4",
              "message": "entry doesn't exist"
            },
            "node": {
              "_links": {
                "self": {
                  "href": "/api/resourcelink"
                }
              },
              "name": "node1",
              "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
            }
          }
        ],
        "state": "fail"
      },
      "destination": "administrator@mycompany.com",
      "filters": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "important-events"
        }
      ],
      "name": "Admin_Email",
      "syslog": {
        "format": {
          "hostname_override": "string",
          "message": "string",
          "timestamp_override": "string"
        },
        "port": 514,
        "transport": "string"
      },
      "system_defined": 1,
      "type": "email"
    }
  ]
}

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

access_control_role

Indicates the access control role that created the event destination and is used to control access to the destination based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.

Name Type Description

_links

_links

name

string

Role name

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

Name Type Description

_links

_links

ca

string

Client certificate issuing CA

name

string

Certificate name

serial_number

string

Client certificate serial number

arguments

Name Type Description

code

string

Argument code

message

string

Message argument

message

Information to be displayed to the user.

Name Type Description

arguments

array[arguments]

Message arguments

code

string

Unique message code.

message

string

User message.

node

Name Type Description

_links

_links

name

string

uuid

string

errors

Error object included in the event of connectivity failure.

Name Type Description

message

message

Information to be displayed to the user.

node

node

connectivity

Name Type Description

errors

array[errors]

A list of errors encountered during connectivity checks.

state

string

Current connectivity state.

filters

Name Type Description

_links

_links

name

string

format

Name Type Description

hostname_override

string

Syslog Hostname Format Override. The supported hostname formats are no_override (hostname format based on the syslog.format.message property i.e. fqdn if syslog.format.message is rfc_5424, hostname_only if syslog.format.message is legacy_netapp), fqdn (Fully Qualified Domain Name) and hostname_only.

message

string

Syslog Message Format. The supported message formats are legacy_netapp (format: <PRIVAL>TIMESTAMP [HOSTNAME:Event-name:Event-severity]: MSG) and rfc_5424 (format: <PRIVAL>VERSION TIMESTAMP HOSTNAME Event-source - Event-name - MSG).

timestamp_override

string

Syslog Timestamp Format Override. The supported timestamp formats are no_override (timestamp format based on the syslog.format.message property i.e. rfc_3164 if syslog.format.message is legacy_netapp, iso_8601_local_time if syslog.format.message is rfc_5424), rfc_3164 (format: Mmm dd hh:mm:ss), iso_8601_local_time (format: YYYY-MM-DDThh:mm:ss+/-hh:mm) and iso_8601_utc (format: YYYY-MM-DDThh:mm:ssZ).

syslog

Name Type Description

format

format

port

integer

Syslog Port.

transport

string

Syslog Transport Protocol.

records

Name Type Description

_links

_links

access_control_role

access_control_role

Indicates the access control role that created the event destination and is used to control access to the destination based on role-based access control (RBAC) rules. If created by the 'admin' user, the field is unset.

certificate

certificate

Specifies the client-side certificate used by the ONTAP system when mutual authentication is required. This object is only applicable for rest_api type destinations. Both the ca and serial_number fields must be specified when configuring a certificate in a PATCH or POST request. The name field is read-only and cannot be used to configure a client-side certificate.

  • Introduced in: 9.6

connectivity

connectivity

destination

string

Event destination

filters

array[filters]

name

string

Destination name. Valid in POST.

syslog

syslog

system_defined

boolean

Flag indicating system-defined destinations.

type

string

Type of destination. Valid in POST.

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.