Get an alert by identifier Deprecated

View as Markdown
GET /api/alerts/alert/{alertId}
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/alerts/alert/{alertId}

Refer to Spaces for more information.

Deprecated in 7.13.0. Use the get rule API instead.

Path parameters

  • alertId string Required

    The identifier for the alert.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • actions array[object]
    • alertTypeId string
    • apiKeyOwner string | null
    • createdAt string(date-time)

      The date and time that the alert was created.

    • createdBy string

      The identifier for the user that created the alert.

    • enabled boolean

      Indicates whether the alert is currently enabled.

    • executionStatus object
      Hide executionStatus attributes Show executionStatus attributes object
      • lastExecutionDate string(date-time)
      • status string
    • id string

      The identifier for the alert.

    • muteAll boolean
    • mutedInstanceIds array[string] | null
    • name string

      The name of the alert.

    • notifyWhen string
    • params object

      Additional properties are allowed.

    • schedule object
      Hide schedule attribute Show schedule attribute object
      • interval string
    • scheduledTaskId string
    • tags array[string]
    • throttle string | null
    • updatedAt string
    • updatedBy string | null

      The identifier for the user that updated this alert most recently.
  • 401 application/json

    Authorization information is missing or invalid.

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string
    • statusCode integer

      Value is 401.
GET /api/alerts/alert/{alertId} 
curl \
 --request GET 'https://localhost:5601/api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35' \
 --header "Authorization: $API_KEY"