Alerts API - GET specified alert definition

Applies to NAM 2019+

Returns the alert with the specified name.

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


Parameter Type Description In Required
name string

Alert name

path required

Response format

The AlertPublicRestErrorResponse object

Element Type Description
errorCode string
errorMessage string

The AlertPublicRest object

Element Type Description
name string

Alert name. Must be unique if you want to use the API.

type string
  • METRIC_ALM = Real user performance (probe)
  • TRANSMETRIC_ALM = Operation sequences
  • TRANSACTIVE_METRIC_ALM = Enterprise synthetic
  • CITRIXMETRIC_ALM = Citrix/WTS hardware
  • LINK_ALM = Network link
  • METRIC_ALM_P2P = Internetwork traffic
  • TIERMETRIC_ALM = Application user experience
  • AMD_DRIVER_ALM = NAM Probe driver statistics
  • AMD_INTERFACE_ALM = NAM Probe interface statistics
  • AMD_SERVER_ALM = NAM Probe server statistics
  • ESM_METRIC_ALM = Agent health statistics (obsolete)
  • SYSTEM = System Maintanance (this type is for internal purposes only, it is not allowed in API)
description string
definition AlertDefinition
detectionSettings AlertDetectionSettings
propagationSettings AlertPropagationSettings
notificationSettings AlertNotificationSettings
recipientIds integer[]

Identifiers of recipients that will receive alert notifications.

namServers string[]

List of NAM Servers on which the alert definition resides.

The AlertNotificationSettings object

Element Type Description
disabled boolean

If set to true, no notification will be send out of this alert.

aggregated boolean

Aggregate notifications for this alert into a single email. Applies only to email notifications.

message string

Type the message to send when the alert occurs. (To display metric/dimension values or use macros, the mnemonics enclosed in {} need to be used. The format is different than in the UI).

subject string

Email subject.

snmpmessage string

Message for SNMP traps.

The AlertPropagationSettings object

  • entrySignalProperties = Raise alert after conditions are met for the specified number of consecutive intervals
  • exitSignalProperties = Cancel alert after conditions are not met for the specified number of consecutive intervals
  • abortSignalProperties = Abort alert after the specified time
  • recallSignalProperties = Reissue alert after the specified number of intervals
Element Type Description
entrySignalProperties AlertSignalPropertiesIntervals
exitSignalProperties AlertSignalPropertiesIntervals
abortSignalProperties AlertSignalPropertiesMinutes
recallSignalProperties AlertSignalPropertiesIntervals
notifyNoTraffic string

Defines what to do when no traffic was observed:

  • NOTIFIABLE_ON_RAISING = The alert conditions are met
  • NOTIFIABLE_ON_CANCELLING = The alert conditions are not met
  • UNNOTIFIABLE = Perform no action and wait for traffic

The AlertSignalPropertiesMinutes object

Element Type Description
minutes integer
description string

The AlertSignalPropertiesIntervals object

Element Type Description
intervals integer
description string

The AlertDetectionSettings object

Element Type Description
disabled boolean

Is alert disabled?

timeRange integer

Note: 1 is a special value meaning 1 monitoring interval. Other values specify a time range in minutes.

frequency integer

Note: 1 is a special value meaning 1 monitoring interval. Other values specify a time range in minutes. Frequency must be less than or equal to timeRange.

The AlertDefinition object

Element Type Description
dimensionConditions AlertCondition[]
metricConditions AlertCondition[]
outputFilter string

The AlertCondition object

Element Type Description
id string

Metric or dimension ID.

filter string

Filter value for the specified metric or dimension. For metrics, it should start with <, >, <=, or >=

filterType string
  • NONE = for internal purposes only. Do not use
  • DIMENSION = Dimension and Filter
  • DIMENSION_FILTER_ONLY = Only filtering for dimension
  • METRIC_VALUE = Metric value type condition
  • METRIC_BASELINE_ABSOLUTE = Absolute baseline type condition
  • METRIC_BASELINE_RELATIVE = Relative baseline type condition
  • METRIC_AUXILARY = Auxiliary metric
negateFilter boolean

If true, the value of the filter will be negated.

expression string

Compound metric expression. Ignored for dimension type conditions.

Response codes

Code Description

Alert with specified name.


The request was invalid.


The alert was not found.


More than one alert with the specified name was found.


Using GET https://address/cxf/api/v1/config/alerts/definitions/, we retrieve a list of alerts.

To see the details on the second alert in the list ("Application performance of an application (front-end)"), we make the same call but with the full name of the alert added to the call:

GET https://address/cxf/api/v1/config/alerts/definitions/Application performance of an application (front-end)

and get the whole definition of the named alert: