Skip to main content
ZStack
Alerting & Response/Alert Templates

GetAlertTemplateVariableReference

Get the variable reference documentation for template authoring

GET/api/v1/alerting/templates/variables

Operation ID

GetAlertTemplateVariableReference

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of available template variables

    Example: (nested array)

    • path
      String

      Variable path in the template data model

      Example: .AlertName

    • type
      String

      Data type of the variable (text, number, or boolean)

      Example: text

    • description
      String

      Description of what the variable contains

      Example: Name of the alert rule

    • example
      String

      Example value for the variable

      Example: High CPU Usage

    • group
      String

      Variable group for documentation organization

      Example: alert