Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Get a status page design template

Returns the design specification, stored asset information, and current revision.

GET https://app.upfour.io/v1/status-page-design-templates/{templateID}
GET https://app.upfour.io/v1/status-page-design-templates/{templateID}
Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs status_page.read.
Path

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 status_page.read stable returns 200

Parameters

FieldTypeDescription
templateID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data StatusPageDesignTemplate
StatusPageDesignTemplate · 32 fields
FieldTypeDescription
accent_color string
asset_kinds string[] · nullable one oflogologo_darkfavicon The images the template stores, in the order logo, logo_dark, favicon.
assets StatusPageDesignTemplateAssetInfo[] · nullable
Each item · 4 fields
FieldTypeDescription
content_type string
kind string one oflogologo_darkfavicon
sha256 string
size_bytes integer
created_at string (date-time)
description string
ground string one ofpaperwhitecool
header_dark string
header_light string
id uuid
includes_css boolean
layout string one ofessentialbrandoverview
name string
revision integer Starts at 1 and rises with every update.
spec StatusPageDesignTemplateSpecResponse
StatusPageDesignTemplateSpecResponse · 12 fields
FieldTypeDescription
accent_color string #RRGGBB or empty for the platform default.
appearance StatusPageAppearanceResponse
StatusPageAppearanceResponse · 5 fields
FieldTypeDescription
ground string one ofpaperwhitecool Empty is stored as paper.
header_dark string #RRGGBB or empty for the platform default.
header_light string #RRGGBB or empty for the platform default.
layout string one ofessentialbrandoverview
version integer Must be 1.
custom_css string At most 64 KiB; must not contain </style.
includes_css boolean Must be true for custom_css to be non-empty.
logo_url string External logo address, copied as text and never downloaded; only kept together with brand images.
theme string one ofsystemlightdark Empty is stored as system.
version integer
theme string one ofsystemlightdark
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.
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.