Docs

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

Sign in Start free

Update a status page

Updates selected status-page settings, including branding, publication, appearance, notifications, history and public address.

PUT https://app.upfour.io/v1/status-pages/{pageID}
PUT https://app.upfour.io/v1/status-pages/{pageID}

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

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs status_page.write.
Path
Body
Appearance12
hide_from_search_engines
remove_branding
show_not_monitored_as_green
Publication and notifications8
is_published
subscribable
automatic_reports
automatic_reports_notify
Access and history6
password_protected

2 more fields are only available in JSON.

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

Parameters

FieldTypeDescription
pageID required uuid path parameter

Body

The 5 fields most calls use come first; the rest are grouped below.

application/json required 33 fields

company_namestring · nullable
In the app: Company name
subdomainstring · nullable
In the app: Public page slug
company_urlstring · nullable
contact_urlstring · nullable
announcementstring · nullable
In the app: Announcement
Appearance23 fields
accent_colorstring · nullable
appearanceStatusPageAppearance · nullable

Layout and brand surface. Omitted leaves the stored value unchanged (on create: none chosen), null resets it to the default design, an object is validated and stored: version must be 1, layout is required, ground defaults to paper, header_light and header_dark are #RRGGBB or empty.

In the app: Layout
Nested fields 5 fields
FieldTypeDescription
ground optional string one ofpaperwhitecool Empty is stored as paper.
header_dark optional string #RRGGBB or empty for the platform default.
header_light optional string #RRGGBB or empty for the platform default.
layout optional string one ofessentialbrandoverview
version optional integer Must be 1.
designstring · nullable

No effect since Plan 82; accepted and stored only.

design_template_applicationDesignTemplateApplication · nullable
Nested fields 4 fields
FieldTypeDescription
apply_assets optional boolean Replaces the page's images (and logo_url) with the template's.
apply_css optional boolean Fills custom_css from the template when the request sets none.
expected_revision optional integer The template revision the caller looked at (at least 1); a different stored revision is a conflict.
template_id optional uuid
header_layoutstring · nullable

No effect since Plan 82; accepted and stored only.

logo_urlstring · nullable
custom_cssstring · nullable
In the app: Custom CSS
custom_jsstring · nullable

Not supported: a non-empty value is rejected.

google_tag_idstring · nullable

Not supported: a non-empty value is rejected; empty clears it.

themestring · nullable
hide_from_search_enginesboolean · nullable
remove_brandingboolean · nullable
show_not_monitored_as_greenboolean · nullable
uptime_decimalsinteger · nullable
Publication and notifications8 fields
is_publishedboolean · nullable
In the app: Publish status page
subscribableboolean · nullable
automatic_reportsboolean · nullable
automatic_reports_notifyboolean · nullable
auto_report_open_template_iduuid · nullable
auto_report_resolve_template_iduuid · nullable
reply_to_emailstring · nullable
In the app: Reply-to address for status e-mails
minimum_incident_lengthinteger · nullable
Access and history6 fields
passwordstring · nullable

Write-only; an empty value keeps the current password. Responses carry password_protected only.

In the app: Password
password_protectedboolean · nullable
custom_domainstring · nullable

Ignored. Connect a domain with PUT /status-pages/{pageID}/custom-domain.

default_languagestring · nullable
In the app: Default language
history_daysinteger · nullable
In the app: How many days to display?
timezonestring · nullable

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data StatusPage
StatusPage · 61 fields
FieldTypeDescription
accent_color string
announcement string
appearance StatusPageAppearanceResponse · nullable null until a layout was chosen; the page then renders the default design (essential layout, paper ground).
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.
automatic_reports boolean
automatic_reports_notify boolean
company_name string
company_url string
contact_url string
created_at string (date-time)
custom_css string
custom_domain string
custom_domain_certificate_status string one ofnonependingissuedfailedunknown
custom_domain_status string one ofnonepending_dnsqueuedprovisioningactivefaileddisabledconflict_requires_review
custom_js string Not supported: always empty.
default_language string · nullable Language of the page's own communication; null inherits from the client, then the company default.
design string No effect since Plan 82; accepted and stored only.
google_tag_id string Not supported: always empty.
header_layout string No effect since Plan 82; accepted and stored only.
hide_from_search_engines boolean
history_days integer
id uuid
is_published boolean
logo_url string
minimum_incident_length integer
organization_id uuid
password_protected boolean
remove_branding boolean
show_not_monitored_as_green boolean
subdomain string
subscribable boolean
theme string
timezone string
updated_at string (date-time)
uptime_decimals integer
access_restricted boolean Whether any visitor gate (password, e-mail codes, IP allowlist or access token) is on. Only in GET /status-pages.
auto_report_open_template_id uuid
auto_report_resolve_template_id uuid
client_id uuid
custom_domain_attempts integer
custom_domain_cleanup_requested_at string (date-time)
custom_domain_dns_target string
custom_domain_error string
custom_domain_last_checked_at string (date-time)
custom_domain_next_retry_at string (date-time)
custom_domain_pending_expires_at string (date-time)
custom_domain_ploi_tenant string
custom_domain_provisioned_at string (date-time)
custom_domain_verification_token string Value of the up4-status-verification TXT record that proves ownership of the domain.
custom_domain_verified_at string (date-time)
favicon_url string
logo_asset_url string
logo_dark_asset_url string
platform_url string
public_url string Where the page is reachable: the custom domain once active, else the platform address.
reply_to_email string
subscriber_count integer Confirmed, active subscribers. Only in GET /status-pages.

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.
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.