Alerts API - GET an alert recipient

Applies to NAM 2019

This documentation is a work in progress. Please see the NAM REST API Explorer in your NAM Console for a 'Swaggerized' exploration of the NAM Console Public REST API.

Returns the recipient specified by ID.

GET
  • url https://{console-host}:{console-port}/cxf/api/v1/config/alerts/recipients/{id}

Parameters

Parameter Type Description In Required
id

Recipient ID.

path required

Response format

The AlertPublicRestErrorResponse object

Element Type Description
errorCode string
errorMessage string

The ScriptRecipient object

Element Type Description
id integer
enabled boolean
description string
executable string
parameters string
recipientType string
  • USER = email recipient
  • TRAP = SNMP trap recipient
  • MOBILE = Slack recipient
  • SCRIPT = Script recipient

The TrapRecipient object

Element Type Description
id integer
enabled boolean
host string
port integer
readCommunityName string
recipientType string
  • USER = email recipient
  • TRAP = SNMP trap recipient
  • MOBILE = Slack recipient
  • SCRIPT = Script recipient

Response codes

Code Description
200

Recipient with given name.

400

The request was invalid.

404

The recipient was not found.

409

More than one recipient with the specified ID was found.