Create a client template

Creates a Client template containing optional monitors, Alert plans or status pages.

POST https://app.upfour.io/v1/client-templates

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs client.write.

Body

namerequired

More fields1

description

1 more field is only available in JSON.

Headers

Idempotency-KeyheaderGenerated automatically when empty. How it works

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope client.write stable Idempotency-Key supported returns 201

Body

application/json required 3 fields

namestringrequired

All other fields31 fields

descriptionstring

specTemplateSpec

What a new client gets: monitors, alert plans and status pages. Omitted stores an empty template.

Nested fields 29 fields

Field Type Description

escalation_policies optional TemplateEscalationPolicy[]

Each item · 7 fields

Field Type Description

description optional string

name optional string

steps optional TemplateEscalationStep[]

Each item · 4 fields

Field	Type	Description
`after_seconds` optional	integer	Seconds after the incident starts, not negative.
`channel` optional	string one of`""email`	email notifies through the company-wide default email channel; set either channel or targets, not both.
`targets` optional	uuid[]	Ids of alert channels that belong to the whole company, not to one client.
`urgency` optional	string one of`""smsvoicehighlow`

monitors optional TemplateMonitor[]

Each item · 12 fields

Field	Type	Description
`alert_type` optional	string one of`statuskeywordkeyword_absenceexpected_status_code`	Omitted means status.
`dns_query` optional	string
`dns_type` optional	string one of`AAAAAMXCNAMETXTNS`	Omitted means A.
`host_from` optional	string	Host of a tcp or ping monitor, used when tcp_host is empty; takes the same placeholders.
`http_method` optional	string	Omitted means HEAD.
`interval` optional	integer	Check interval in seconds; 0 or omitted means 180.
`kind` optional	string one of`httptcppingdns`
`name` optional	string
`name_from` optional	string	Monitor name, used when name is empty. Placeholders {{domain}}, {{client_name}}, {{contact_email}} and {{client_slug}} are filled when the template is applied.
`tcp_host` optional	string
`tcp_port` optional	integer
`url` optional	string	Address to check; takes the same placeholders as name_from.

status_pages optional TemplateStatusPage[]

Each item · 7 fields

Field	Type	Description
`apply_design_assets` optional	boolean	Also copies the design's brand images; needs design_template_id.
`apply_design_css` optional	boolean	Also copies the design's custom CSS; needs design_template_id.
`design_template_id` optional	uuid · nullable	A status page design of the company the page starts from.
`include_all_monitors` optional	boolean
`name` optional	string	Page name with placeholders; empty becomes the client name followed by status.
`subdomain` optional	string	Address of the page; a taken one gets a numeric suffix. Empty uses subdomain_from, then the client slug.
`subdomain_from` optional	string	Same as subdomain, with the placeholders of name_from.

Returns

A successful request returns 201 with application/json.

Response fields 1 top-level fields

Field Type Description

data ClientTemplateView

ClientTemplateView · 15 fields

Field Type Description

created_at string (date-time)

description string

design_templates object[] · nullable The status page designs the spec refers to.

Each item · 7 fields

Field	Type	Description
`id`	uuid
`asset_kinds`	string[]
`includes_css`	boolean
`layout`	string
`missing`	boolean	True, with only id present, when the design no longer exists.
`name`	string
`revision`	integer

id uuid

name string

organization_id uuid

spec any The spec as stored: the monitors, escalation_policies and status_pages lists described in the request, each optional.

updated_at string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
404	`design_template_not_found`	The design template does not exist or is not visible to the caller. When: A design template id in the path or body that is unknown or not visible to the caller. Fix: List design templates and use an id from the list.
404	`not_found`	The requested resource does not exist or is outside the caller's scope.
403	`permission_denied`	The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

curl -s -X POST "https://app.upfour.io/v1/client-templates" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "description": "One website monitor per client.", "name": "Website starter", "spec": { "monitors": [ { "interval": 180, "kind": "http", "name_from": "{{domain}}", "url": "https://{{domain}}" } ] } }'

const res = await fetch("https://app.upfour.io/v1/client-templates", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ description: "One website monitor per client.", name: "Website starter", spec: { monitors: [ { interval: 180, kind: "http", name_from: "{{domain}}", url: "https://{{domain}}", }, ], }, }), }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/client-templates", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "description": "One website monitor per client.", "name": "Website starter", "spec": { "monitors": [ { "interval": 180, "kind": "http", "name_from": "{{domain}}", "url": "https://{{domain}}", }, ], }, }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "description": "One website monitor per client.", "name": "Website starter", "spec": { "monitors": [ { "interval": 180, "kind": "http", "name_from": "{{domain}}", "url": "https://{{domain}}" } ] } }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/client-templates", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "description": "One website monitor per client.", "name": "Website starter", "spec": { "monitors": [ { "interval": 180, "kind": "http", "name_from": "{{domain}}", "url": "https://{{domain}}" } ] } } JSON; $ch = curl_init("https://app.upfour.io/v1/client-templates"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "created_at": "2026-10-27T09:00:00Z", "description": "One website monitor per client.", "design_templates": [], "id": "00000000-0000-4000-8000-000000000001", "name": "Website starter", "organization_id": "00000000-0000-4000-8000-000000000002", "spec": { "monitors": [ { "interval": 180, "kind": "http", "name_from": "{{domain}}", "url": "https://{{domain}}" } ] }, "updated_at": "2026-10-27T09:00:00Z" } }