Preview a client template

Previews a Client template for a Client using supplied name, slug, contact email and domain values.

POST https://app.upfour.io/v1/client-templates/{templateID}/dry-run

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

Authorization

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

Path

templateIDpath · requiredPart of the request path.

Body

client_idrequired The client to preview the template for.

More fields4

client_name Fills {{client_name}}. client_slug Fills {{client_slug}}. contact_email Fills {{contact_email}}. domain Fills {{domain}}. Required when the template uses it.

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 200

Parameters

Field	Type	Description
`templateID` required	uuid	path parameter

Body

application/json required 5 fields

client_iduuidrequired

The client to preview the template for.

All other fields4 fields

client_namestring

Fills {{client_name}}.

client_slugstring

Fills {{client_slug}}.

contact_emailstring

Fills {{contact_email}}.

domainstring

Fills {{domain}}. Required when the template uses it.

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data TemplateDryRunResult

TemplateDryRunResult · 32 fields

Field Type Description

monitors TemplateMonitorPreview[] · nullable

Each item · 11 fields

Field Type Description

alarm_route_status string one ofconfiguredwithout_alarm_route

name string

channels MaterializedChannel[]

Each item · 4 fields

Field	Type	Description
`id`	uuid
`name`	string
`scope`	string
`type`	string

warnings MaterializeError[]

Each item · 3 fields

Field	Type	Description
`kind`	string one of`templatemonitormonitor_alarm_routepolicystatus_page`
`message`	string
`name`	string

policies TemplatePolicyPreview[] · nullable

Each item · 7 fields

Field Type Description

channels MaterializedChannel[] · nullable

Each item · 4 fields

Field	Type	Description
`id`	uuid
`name`	string
`scope`	string
`type`	string

name string

step_count integer

status_pages TemplateStatusPagePreview[] · nullable

Each item · 11 fields

Field Type Description

design TemplateStatusPageDesignPreview · nullable

TemplateStatusPageDesignPreview · 8 fields

Field	Type	Description
`apply_assets`	boolean
`apply_css`	boolean
`asset_kinds`	string[] · nullable
`id`	uuid
`includes_css`	boolean
`layout`	string
`name`	string
`revision`	integer

name string

subdomain string

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.
409	`design_template_conflict`	The design template was changed after the caller read it. When: Updating or applying a design template that was changed after the caller read it. Fix: Reload the template and apply the change again.
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.

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/00000000-0000-4000-8000-000000000001/dry-run" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "client_id": "00000000-0000-4000-8000-000000000002", "client_name": "Globex Corporation", "domain": "globex.example" }'

const res = await fetch("https://app.upfour.io/v1/client-templates/00000000-0000-4000-8000-000000000001/dry-run", { method: "POST", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ client_id: "00000000-0000-4000-8000-000000000002", client_name: "Globex Corporation", domain: "globex.example", }), }); console.log(res.status, await res.json());

import os import requests res = requests.post( "https://app.upfour.io/v1/client-templates/00000000-0000-4000-8000-000000000001/dry-run", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "client_id": "00000000-0000-4000-8000-000000000002", "client_name": "Globex Corporation", "domain": "globex.example", }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "client_id": "00000000-0000-4000-8000-000000000002", "client_name": "Globex Corporation", "domain": "globex.example" }`) req, _ := http.NewRequest("POST", "https://app.upfour.io/v1/client-templates/00000000-0000-4000-8000-000000000001/dry-run", 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' { "client_id": "00000000-0000-4000-8000-000000000002", "client_name": "Globex Corporation", "domain": "globex.example" } JSON; $ch = curl_init("https://app.upfour.io/v1/client-templates/00000000-0000-4000-8000-000000000001/dry-run"); 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": { "monitors": [ { "alarm_route_status": "configured", "channels": [ { "id": "00000000-0000-4000-8000-000000000003", "name": "Email · anna@example.com", "scope": "organization", "type": "email" } ], "name": "globex.example" } ], "policies": [], "status_pages": [] } }