Every variable a notification template can reference.

GET

/api/v1/notification-channels/template-variables

curl --request GET \
  --url https://example.com/api/v1/notification-channels/template-variables \
  --header 'Authorization: Bearer <token>'

Served rather than documented so the editor’s list and the renderer’s context cannot disagree — they are the same list.

Authorizations

• bearer

Responses

200

The template variables, with what each one means and whether every alert carries it

Media typeapplication/json

Array<object>

One name a notification template may reference.

object

always_present

required

Whether every alert carries it. A variable that is not always present is undefined when absent: it renders as empty text, and {{ name | default("…") }} supplies a fallback.

boolean

description

required

What the value means.

string

name

required

The name to write between {{ }}.

string

Example^generated

[
  {
    "always_present": true,
    "description": "example",
    "name": "example"
  }
]

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role below Admin

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}