Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Templates
GETAlertingSince 1.0SynchronousAuth Required

ListAlertTemplates

List message templates with optional filtering by name, format, and source

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • searchString

    Name fuzzy search filter Name fuzzy search filter

  • formatString

    Filter by format: markdown, html, json, or plain_text Filter by format: markdown, html, json, or plain_text

  • sourceString

    Filter by source: builtin or custom Filter by source: builtin or custom

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of message templates

    Example: (nested array)

    • uuidString

      Unique identifier of the template

      Example: tmpl-001

    • nameString

      Human-readable template name

      Example: Default Email Template

    • formatString

      Template format: markdown, html, json, or plain_text

      Example: markdown

    • contentString

      Template content with variable placeholders

      Example: # Alert: {{.AlertName}}

    • sourceString

      Template source: builtin or custom

      Example: builtin

    • createDateString

      Timestamp when the template was created

      Example: 2026-01-15T08:00:00Z

    • lastOpDateString

      Timestamp of the last template modification

      Example: 2026-01-15T08:00:00Z

  • totalInteger

    Total number of matching templates

    Example: 8

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Offset from start of result set

    Example: 20

Endpoint

GET/api/v1/alerting/templates

/api/v1/alerting/templates

Operation ID

ListAlertTemplates

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/templates' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 8,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history