Alerts

Get Alert by id

Changed on

Get Alert by id

get/v1/private/alerts/{id}

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/alerts/{id}
  • Auth
    none declared

Path parameters

idstring uuid required

Response

Alert resource

idstring uuid
namestring
enabledboolean
alert_type'general' | 'slack' | 'pagerduty'
metadataobject
custom_fieldsobject

Optional user-defined key/value pairs, added as top-level keys of the alert's EventBridge event detail. Keys must not collide with the event's own keys.

created_atstring date-time
created_bystring
last_updated_atstring date-time
last_updated_bystring
project_idstring uuid

Optional project scope for this alert. When set, the alert is scoped to the specified project. Do NOT also provide a 'scope:project' trigger config — the system will create it automatically from this field. Sending both project_id and a scope:project trigger config will result in an error.

Changes

  • b50ceafbe639Revision changes
    • info

      added the optional property to the response with the status

  • b9b9c770fc73Revision changes
    • warning

      added the new filter:guardrail_type enum value to the //// response property for the response status