Powered by Redocly

Custom Alerts

Invoke the alert operation

Action to raise an alert for an application. NOTE: both custom alert id and custom alert name need to be the same when raising an alert and then clearing the alert. Otherwise the correlation between the two will not work.

SecurityaccessToken
Request
Request Body schema:
id
required
string

The custom identifier of the alert. This could be a unique identifier of the entity effected by the fault causing the alert. As an example it could be a unique identifier of the failing service instance (replica) of an application on a site.

name
required
string

The custom name of the specific alert. This should be a unique name describing the alert.

description
required
string

The description of the reason behind the alert.

severity
required
string <enumeration>
  • warning: The 'warning' severity level indicates the detection of a potential or impending service-affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service-affecting fault.
  • minor: The 'minor' severity level indicates the existence of a non-service-affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service-affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the resource.
  • major: The 'major' severity level indicates that a service- affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the resource and its full capability must be restored.
  • critical: The 'critical' severity level indicates that a service- affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a resource becomes totally out of service and its capability must be restored.

The severity of the alert.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/alert
Request samples 
id: 57b6a309-30ca-4e8a-97a9-0404cc53817b
name: my-alert
description: Failed because of eaddrinuse
severity: critical

Invoke the clear operation

Action to clear a previously raised alert. NOTE: both custom alert id and custom alert name need to be the same when raising an alert and then clearing the alert. Otherwise the correlation between the two will not work.

SecurityaccessToken
Request
Request Body schema:
id
required
string

The custom identifier of the alert. This could be a unique identifier of the entity effected by the fault causing the alert. As an example it could be a unique identifier of the failing service instance (replica) of an application on a site.

name
required
string

The custom name of the specific alert. This should be a unique name describing the alert.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/clear
Request samples 
id: 57b6a309-30ca-4e8a-97a9-0404cc53817b
name: my-alert
➔ Next to Subtenant Application Deployments