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

Retrieve an event destination

Contributors
PDFs

GET /support/ems/destinations/{name}

Introduced In: 9.6

Retrieves event destinations.

  • event notification destination show

  • event notification show

Parameters

Name Type In Required Description

name

string

path

True

Destination name

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

certificate

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.
Example response 
{
  "_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

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

self

href

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

_links

name

string

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.