Alert definitions service overview

View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert.

Learn more about alerts in our documentation.

Authentication and permissions

To use the Alert definitions service API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.

PresetsPermissionDescription
Alertsalerts:ReadConfigGrants access to read alerts
alerts:UpdateConfigRequired to create, update, or delete alerts

Common error response codes

Status CodeDescription
400 Bad RequestResponse code 400
401 UnauthorizedResponse code 401
500 Internal Server ErrorResponse code 500

Constants

Alert definitions service overview

View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert.

Learn more about alerts in our documentation.

Authentication and permissions

To use the Alert definitions service API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.

PresetsPermissionDescription
Alertsalerts:ReadConfigGrants access to read alerts
alerts:UpdateConfigRequired to create, update, or delete alerts

Common error response codes

Status CodeDescription
400 Bad RequestResponse code 400
401 UnauthorizedResponse code 401
500 Internal Server ErrorResponse code 500

Constants