Alerting Monitor API#
Alerting Monitor is an Observability Management Service that exposes API for configuring alerts.
Download the Alerting Monitor API in OpenAPI YAML format
- GET /v1/projects/{projectName}/alerts#
Gets a list of alert instances
- Parameters:
projectName (string) – unique projectName for the resource
- Query Parameters:
alert (string) – Filters the alert definitions by name
host (string) – Filters the alerts by Host ID
cluster (string) – Filters the alerts by cluster ID
app (string) – Filters the alerts by application or deployment ID
active (boolean) – Shows active alerts
suppressed (boolean) – Shows suppressed alerts
- Status Codes:
200 OK – The list of alert instances is retrieved successfully
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- GET /v1/projects/{projectName}/alerts/definitions#
Gets a list of alert definitions
- Parameters:
projectName (string) – unique projectName for the resource
- Status Codes:
200 OK – The list of alert definitions is retrieved successfully
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- GET /v1/projects/{projectName}/alerts/definitions/{alertDefinitionID}#
Gets details of a single alert definition by its ID value
- Parameters:
alertDefinitionID (string) – ID of an alert definition (UUID format)
projectName (string) – unique projectName for the resource
- Status Codes:
200 OK – The alert is found
404 Not Found – Not Found
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- PATCH /v1/projects/{projectName}/alerts/definitions/{alertDefinitionID}#
Updates (patch) details of a single alert definition
- Parameters:
alertDefinitionID (string) – ID of an alert definition (UUID format)
projectName (string) – unique projectName for the resource
- Status Codes:
204 No Content – The alert definition is updated successfully
400 Bad Request – Bad Request
404 Not Found – Not Found
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- GET /v1/projects/{projectName}/alerts/definitions/{alertDefinitionID}/template#
Gets details of a rendered alerting rule based on alert template and values
- Parameters:
alertDefinitionID (string) – ID of an alert definition (UUID format)
projectName (string) – unique projectName for the resource
- Query Parameters:
rendered (boolean) – Specifies if template values will be rendered
- Status Codes:
200 OK – The rendered alerting rule based on alert template, is found
404 Not Found – Not Found
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- GET /v1/projects/{projectName}/alerts/receivers#
Gets a list of alert receivers
- Parameters:
projectName (string) – unique projectName for the resource
- Status Codes:
200 OK – The list of alert receivers is retrieved successfully
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- GET /v1/projects/{projectName}/alerts/receivers/{receiverID}#
Gets details of a single alert receiver by its ID value
- Parameters:
receiverID (string) – ID of a receiver (UUID format)
projectName (string) – unique projectName for the resource
- Status Codes:
200 OK – The alert receiver is found
404 Not Found – Not Found
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable
- PATCH /v1/projects/{projectName}/alerts/receivers/{receiverID}#
Updates (patch) details of a single alert receiver
- Parameters:
receiverID (string) – ID of a receiver (UUID format)
projectName (string) – unique projectName for the resource
- Status Codes:
204 No Content – The alert receiver is updated successfully
400 Bad Request – Bad Request
404 Not Found – Not Found
500 Internal Server Error – Internal Server Error
503 Service Unavailable – Service Unavailable