Retrieve a collection of event destinations
Retrieves a list of event destinations, which helps you understand where event notifications are sent within your system. Use this information to manage and configure event notifications effectively.
HTTP method and endpoint
GET /support/ems/destinations
Introduced in
ONTAP 9.6
Usage notes
Retrieves a collection of event destinations.
Related ONTAP commands
-
event notification destination show -
event notification show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
destination |
string |
query |
False |
Filter by destination |
filters.name |
string |
query |
False |
Filter by filters.name |
certificate.ca |
string |
query |
False |
Filter by certificate.ca |
certificate.serial_number |
string |
query |
False |
Filter by certificate.serial_number |
name |
string |
query |
False |
Filter by name |
type |
string |
query |
False |
Filter by type |
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.
|
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[records] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": "3",
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"certificate": {
"ca": "VeriSign",
"serial_number": "1234567890"
},
"destination": "administrator@mycompany.com",
"filters": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "important-events"
}
],
"name": "Admin_Email",
"type": "email"
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
certificate
Certificate information is valid for the "rest_api" type.
| Name | Type | Description |
|---|---|---|
ca |
string |
Client certificate issuing CA |
serial_number |
string |
Client certificate serial number |
filters
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
records
| Name | Type | Description |
|---|---|---|
_links |
||
certificate |
Certificate information is valid for the "rest_api" type. |
|
destination |
string |
Event destination |
filters |
array[filters] |
|
name |
string |
Destination name. Valid in POST. |
type |
string |
Type of destination. Valid in POST. |
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. |