Skip to main content
ZStack
Alerting & Response/Alert Templates

GetAlertTemplateMockPayload

Get a mock alert payload for template preview and testing

GET/api/v1/alerting/templates/mock-payload

Operation ID

GetAlertTemplateMockPayload

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

Query Parameters

  • alarmType
    String

    Mock dataset: resource (default) or event

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • payloadJson
    String

    JSON mock payload for template preview

    Example: {"AlertName": "Sample Alert"}

Change History

View all change history

  • Change Time

    AddedRequest parameters alarmType
    View API