Update Status Page

Change a status page’s name, branding, settings, visibility, password or custom domain

Overview

Updates one or more properties of a status page. Only the fields you send are changed. PATCH and PUT are interchangeable: both accept the same body and apply a partial update.

PATCH /api/projects/{projectId}/status-pages/{id}
PUT /api/projects/{projectId}/status-pages/{id}

To change which monitors appear on the page, use Manage Status Page Monitors.

Authentication

Header	Required	Description
X-API-Key	Yes	Your API key (Authorization: Bearer {jwt} also works). API keys need the read_write scope.
X-Project-ID	Yes	Must be the same project UUID as in the URL.
Content-Type	Yes	application/json

Required access: project admin.

Path parameters

Parameter	Type	Description
projectId	UUID	The project
id	UUID	The status page

Request body

All fields are optional.

Field	Type	Description
name	string	1-255 characters
description	string	Page description
branding	object	Merged into the existing branding. Same keys as Create Status Page.
settings	object	Merged into the existing settings (see below)
status	string	draft, published or archived
is_published	boolean	Shortcut for status: true means published, false means draft
custom_domain	string | null	Custom domain, or null to remove it. Requires Pro or Scale.
is_password_protected	boolean	Require a password to view the page
password	string	At least 8 characters. Write-only; never returned.

subdomain cannot be changed; if sent, it is ignored. If you send both status and is_published they must agree (published with true), otherwise the request fails with VALIDATION_ERROR. To publish or unpublish only, see Publish Status Page.

Settings

The same settings as Create Status Page, plus:

Field	Type	Description
auto_publish_enabled	boolean	Automatically post incidents for monitors that opt in
auto_publish_severities	string[]	Severities that are posted automatically (default ["critical","major"])

Custom domains

Sending custom_domain stores the domain and resets its verification to unverified. The page keeps using its subdomain URL until the domain is verified. Complete DNS verification and certificate issuance from the dashboard (Status pages, then the page’s domain settings).

Plan restrictions

Change	Requirement
Set custom_domain to a value	Pro or Scale (removing a domain works on every plan)
settings.show_powered_by: false	Scale

Response

200 OK

{
  "success": true,
  "data": {
    "status_page": {
      "id": "0b7c3a52-7d57-4c35-9f0e-5a3b6f1f2a10",
      "project_id": "6ba7b810-9dad-41d1-80b4-00c04fd430c8",
      "name": "Acme Status",
      "subdomain": "acme-production",
      "status": "published",
      "is_public": true,
      "color_scheme": "dark",
      "timezone": "UTC",
      "custom_domain": null,
      "custom_domain_verified": false,
      "updated_at": 1790000500000,
      "branding": { "defaultTheme": "dark", "primaryColor": "#0066CC" }
    }
  }
}

The response contains the full status page object (abbreviated here). It does not include monitors; fetch the page for those. See Get Status Page.

Errors

Status	Code	Cause
400	VALIDATION_ERROR	Invalid body, or status and is_published disagree
400	PROJECT_ID_REQUIRED / INVALID_PROJECT_ID	X-Project-ID header missing or not a UUID
401	AUTHENTICATION_REQUIRED	Missing or invalid credentials
403	INSUFFICIENT_PERMISSIONS	Caller is not a project admin
403	ACCESS_DENIED	The page belongs to another project
403	FEATURE_NOT_AVAILABLE	Custom domain on Free, or show_powered_by: false below Scale
403	API_KEY_ORGANIZATION_MISMATCH	The API key belongs to a different organization than the project
403	READ_ONLY_API_KEY	The API key has the read scope
404	RESOURCE_NOT_FOUND	The status page does not exist

Example

cURL

curl -X PATCH https://api.uptimeio.com/api/projects/YOUR_PROJECT_ID/status-pages/YOUR_STATUS_PAGE_ID \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-Project-ID: YOUR_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Status",
    "branding": { "defaultTheme": "dark" },
    "settings": { "incident_history_days": 30 }
  }'