Get overall status of a status page

Returns the overall status indicator and active incidents for the status page identified by the custom domain.

GET /api/v1/status.json

Get overall status of a status page

cURL

curl --request GET \
  --url https://{custom_domain}/api/v1/status.json

200

{
  "page": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "time_zone": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "status": {
    "indicator": "none",
    "description": "<string>"
  },
  "incidents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "investigating",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "monitoring_at": "2023-11-07T05:31:56Z",
      "resolved_at": "2023-11-07T05:31:56Z",
      "impact": "none",
      "shortlink": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "page_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "incident_updates": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "body": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "display_at": "2023-11-07T05:31:56Z",
          "custom_tweet": "<string>",
          "deliver_notifications": true,
          "tweet_id": "<string>"
        }
      ]
    }
  ]
}

Response

200

application/json

status found

page · object

Show child attributes

status · object

Show child attributes

incidents · object[]

Show child attributes