v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Status Pages

Update status page

Updates an existing status page's attributes. Note: Publishing and unpublishing via the enabled property will be deprecated on this endpoint. Use the dedicated publish and unpublish status page endpoints instead.

patch/api/v2/statuspages/{page_id}

Path parameters

page_idstring uuid required

Example:1234abcd-12ab-34cd-56ef-123456abcdef

The ID of the status page.

Query parameters

delete_subscribersboolean

Whether to delete existing subscribers when updating a status page's type.

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Request body

Example request

{
  "data": {
    "attributes": {
      "company_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAIKMMMM",
      "domain_prefix": "status-page-us1-east",
      "email_header_image": "data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF",
      "enabled": false,
      "favicon": "data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA",
      "name": "Status Page US1 East",
      "subscriptions_enabled": false,
      "type": "internal",
      "visualization_type": "bars_only"
    },
    "id": "1234abcd-12ab-34cd-56ef-123456abcdef",
    "type": "status_pages"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "components": [
        {
          "components": [
            {
              "type": "component"
            }
          ],
          "type": "component"
        }
      ],
      "type": "public",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "relationships": {
      "created_by_user": {
        "data": {
          "type": "users"
        }
      },
      "last_modified_by_user": {
        "data": {
          "type": "users"
        }
      }
    },
    "type": "status_pages"
  },
  "included": [
    {
      "type": "users"
    }
  ]
}