Alerts API - GET all alert recipients

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 all alert recipients.

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

Parameters

Parameter Type Description In Required
recipientType

Include only recipients of the specified type.

query optional
filter

Include only recipients containing the specified text.

query optional

Possible values

Possible values for the schema element:

  • USER
  • TRAP
  • MOBILE
  • SCRIPT

Response format

The MobileRecipient object

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

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 UserRecipient object

Element Type Description
id integer
enabled boolean
user User
username string
recipientType string
  • USER = email recipient
  • TRAP = SNMP trap recipient
  • MOBILE = Slack recipient
  • SCRIPT = Script recipient

The User object

Element Type Description
login string
firstName string
lastName string
email string

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
default

All recipients added to the NAM Console.