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.

Expensive properties

There is an added cost to retrieving values for these properties. They are not included by default in GET results and must be explicitly requested using the fields query parameter.

  • connectivity.*

  • 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

Security certificate object reference

connectivity

connectivity

destination

string

Event destination

filters

array[filters]

name

string

Destination name. Valid in POST.

system_defined

boolean

Flag indicating system-defined destinations.

type

string

Type of destination. Valid in POST.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "ca": "VeriSign",
    "name": "cert1",
    "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",
  "system_defined": 1,
  "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

Security certificate object reference

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

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.