AlertsResource


Create an alert


POST https://example.com/api/cloud/alerts

Roles : [ROLE_USERS_MANAGE_ALERTS]

Content-Type : alert Accept : alert

Error Codes

  • GEN-4 - Not enough permissions to perform this action
  • MONITORING-26 - The alert name is required
  • MONITORING-27 - The supplied collection of alarms is null or empty

Example

List alerts


Returns all available alerts

GET https://example.com/api/cloud/alerts

Roles : [ROLE_USERS_VIEW_ALERTS]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
has String Filter that supports wildcards to apply to alert name and description. By default null.
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
state String Filter by alert state. Possible values: 'all', 'active' or 'inactive'
muted Boolean Filter by mute state. Empty or one of: 'muted' or 'unmuted'

Accept : alerts

Error Codes

  • GEN-4 - Not enough permissions to perform this action

Example

Delete an alert


DELETE https://example.com/api/cloud/alerts/{alert}

Roles : [ROLE_USERS_MANAGE_ALERTS]

Example

Get an alert


GET https://example.com/api/cloud/alerts/{alert}

Roles : [ROLE_USERS_VIEW_ALERTS]

Accept : alert

Error Codes

  • GEN-4 - Not enough permissions to perform this action
  • MONITORING-23 - Alert not found

Update an alert


PUT https://example.com/api/cloud/alerts/{alert}

Roles : [ROLE_USERS_MANAGE_ALERTS]

Content-Type : alert Accept : alert

Error Codes

  • GEN-4 - Not enough permissions to perform this action
  • MONITORING-23 - Alert not found

Example

List alarms of an alert


GET https://example.com/api/cloud/alerts/{alert}/alarms

Roles : [ROLE_USERS_VIEW_ALERTS]

Accept : alarms

Error Codes

  • GEN-4 - Not enough permissions to perform this action
  • MONITORING-23 - Alert not found

Example