Skip to main content
ZStack
Alerting & Response/Alert Templates

RenderAlertTemplate

Render a template with sample data to preview the output

POST/api/v1/alerting/templates/render

Operation ID

RenderAlertTemplate

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

application/json

Body Fields

  • content
    String

    Template content to render

    Example: # Alert: {{.AlertName}}

  • format
    String

    Template format for rendering

    Example: markdown

  • payload
    String

    JSON payload data for template variable substitution

    Example: {"AlertName": "High CPU"}

  • alarmType
    String

    Payload dataset: resource (default) or event; no type inference from payload fields

    Example: event

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • output
    String

    Rendered template output

    Example: # Alert: High CPU

  • error
    String

    Error message if rendering failed

    Example: connection refused

Change History

View all change history

  • Change Time

    AddedRequest body fields alarmType
    View API

  • Change Time

    AddedRequest parameters Accept-Language
    View API