Skip to main content
POST
Create a template

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Headers

Idempotency-Key
string

Replays the stored response for 24h when the same key is sent again (1–255 visible ASCII)

X-DevHelm-Client
string

Calling surface and version, e.g. cli/1.4.0 or sdk-js/2.0.0

Path Parameters

id
string<uuid>
required

Body

application/json
kind
enum<string>
required

INCIDENT or MAINTENANCE; ignored when replacing a template

Available options:
INCIDENT,
MAINTENANCE
Example:

"INCIDENT"

name
string
required

Name shown in the template picker, unique per status page

Maximum string length: 120
title
string
required

Incident or maintenance title; may use {{page.name}} and the maintenance variables

Maximum string length: 500
impact
enum<string> | null

Impact level (default: MAJOR)

Available options:
NONE,
MINOR,
MAJOR,
CRITICAL
initialStatus
enum<string> | null

Status the incident starts in (default: INVESTIGATING; always INVESTIGATING for maintenance)

Available options:
INVESTIGATING,
IDENTIFIED,
MONITORING,
RESOLVED
components
object[] | null

Components the template marks, with their status

Maximum array length: 200
stages
object | null

Message per stage, keyed by status (INVESTIGATING, IDENTIFIED, MONITORING, RESOLVED)

notifySubscribers
boolean | null

Whether incidents from this template notify subscribers (default: true)

defaultDurationMinutes
integer<int32> | null

Maintenance only: default window length in minutes (1–10080)

Required range: 1 <= x <= 10080
autoResolve
boolean | null

Maintenance only: complete the window automatically when it ends

reminderLeadMinutes
integer<int32>[] | null

Maintenance only: minutes before the window to remind subscribers (5–20160 each)

Maximum array length: 5

Maintenance only: minutes before the window to remind subscribers (5–20160 each)

Required range: 5 <= x <= 20160

Response

Created

data
object
required