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

Support EMS destinations name endpoint overview

Contributors
PDFs

Overview

Manages a specific instance of a destination. There are limits to the information that can be modified once a destination is created. For example, a destination's type cannot be changed but the underlying details of the type can be modified. See the documentation for /support/ems/destinations for details on the various fields in a destination.

Examples

Retrieving a specific destination instance

# API
GET /api/support/ems/destinations/snmp-traphost

# Response
200 OK

# JSON Body
{
"name": "snmp-traphost",
"type": "snmp",
"destination": "",
"filters": [
  {
    "name": "default-trap-events",
    "_links": {
      "self": {
        "href": "/api/support/ems/filters/default-trap-events"
      }
    }
  }
],
"_links": {
  "self": {
    "href": "/api/support/ems/destinations/snmp-traphost"
  }
}
}

Updating an existing destination (change of e-mail address)

# API
PATCH /api/support/ems/destinations/test-destination

# JSON Body
{
"destination": "support@mycompany.com"
}

# Response
200 OK

Deleting an existing destination

# API
DELETE /api/support/ems/destinations/test-destination

# Response
200 OK