Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Status Pages

Create status page

Creates a new status page in an unpublished state. Use the dedicated publish status page endpoint to publish the page after creation.

post/api/v2/statuspages

Query parameters

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",
      "components": [
        {
          "name": "API",
          "position": 0,
          "type": "component"
        },
        {
          "components": [
            {
              "name": "Login",
              "position": 0,
              "type": "component"
            },
            {
              "name": "Settings",
              "position": 1,
              "type": "component"
            }
          ],
          "name": "Web App",
          "position": 1,
          "type": "group"
        },
        {
          "name": "Webhooks",
          "position": 2,
          "type": "component"
        }
      ],
      "domain_prefix": "status-page-us1",
      "email_header_image": "data:image/png;base64,pQSLAw0KGgoAAAANSUhEUgAAAQ4AASJKFF",
      "favicon": "data:image/png;base64,kWMRNw0KGgoAAAANSUhEUgAAAEAAAABACA",
      "name": "Status Page US1",
      "subscriptions_enabled": true,
      "type": "public",
      "visualization_type": "bars_and_uptime_percentage"
    },
    "type": "status_pages"
  }
}

Response

Created

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"
    }
  ]
}