Instatus API docs - Instatus help

Get started with the API

All endpoints are under the URL https://api.instatus.com. They generally follow the REST architecture.

All requests must be encoded as JSON with the Content-Type: application/json header.

Responses from the Instatus API, including errors, are encoded as JSON as well.

Authentication

Requests to Instatus API must provide an API token through the Authorization header:

You can get your API key from User settings → Developer settings

Authorization: Bearer <API_KEY>

Errors

All API endpoints contain a code and message within the error responses.

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

Status Values

Possible page statuses:

UP
HASISSUES
UNDERMAINTENANCE

Possible component statuses:

OPERATIONAL
UNDERMAINTENANCE
DEGRADEDPERFORMANCE
PARTIALOUTAGE
MINOROUTAGE
MAJOROUTAGE

Possible incident statuses:

INVESTIGATING
IDENTIFIED
MONITORING
RESOLVED

Possible maintenance statuses:

NOTSTARTEDYET
INPROGRESS
COMPLETED

Jump to an endpoint:

Status pages

Get your status pages

Endpoint:

GET /v1/pages

Example response:

[
  {
    "id": "ckf01fonve9i40a32oas5b0uw",
    "subdomain": "nasa",
    "name": "Nasa",
    "logoUrl": null,
    "faviconUrl": null,
    "websiteUrl": null,
    "customDomain": null,
    "publicEmail": null,
    "twitter": null,
    "status": "UP",
    "subscribeBySms": null,
    "language": "en",
    "useLargeHeader": true,
    "brandColor": "#111",
    "okColor": "rgba(51, 177, 126, 1)",
    "disruptedColor": null,
    "degradedColor": null,
    "downColor": null,
    "noticeColor": null,
    "unknownColor": null,
    "googleAnalytics": null,
    "smsService": null,
    "htmlInMeta": null,
    "htmlAboveHeader": null,
    "htmlBelowHeader": null,
    "htmlAboveFooter": null,
    "htmlBelowFooter": null,
    "htmlBelowSummary": null,
    "launchDate": null,
    "cssGlobal": null,
    "onboarded": null,
    "createdAt": "2020-09-12T19:03:48.379Z",
    "updatedAt": "2020-09-12T19:04:03.731Z",
  }
]

Create a status page

Endpoint:

POST /v1/pages

Example request:

{
  "email": "ali@instatus.com",
  "name": "Nasa",
  "subdomain": "nasa",
  "components": ["Website", "App", "API"],
  "logoUrl": "https://instatus.com/sample.png",
  "faviconUrl": "https://instatus.com/favicon-32x32.png",
  "websiteUrl": "https://instatus.com",
  "language": "en",
  "useLargeHeader": true,
  "brandColor": "#111",
  "okColor": "#33B17E",
  "disruptedColor": "#FF8C03",
  "degradedColor": "#ECC94B",
  "downColor": "#DC123D",
  "noticeColor": "#70808F",
  "unknownColor": "#DFE0E1",
  "googleAnalytics": "UA-00000000-1",
  "subscribeBySms": true,
  "smsService": "twilio",
  "twilioSid": "YOUR_TWILIO_SID",
  "twilioToken": "YOUR_TWILIO_TOKEN",
  "twilioSender": "YOUR_TWILIO_SENDER",
  "esendexUsername": "YOUR_ESENDEX_USERNAME",
  "esendexPassword": "YOUR_ESENDEX_PASSWORD",
  "esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF",
  "nexmoKey": null,
  "nexmoSecret": null,
  "nexmoSender": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p"
}

Example response:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "createdAt": "2020-10-13T18:29:25.708Z",
  "subdomain": "nasa",
  "logoUrl": null,
  "faviconUrl": null,
  "websiteUrl": null,
  "name": "Nasa",
  "status": "UP",
  "color": null,
  "language": null,
  "googleAnalytics": null,
  "publicEmail": null,
  "customDomain": null,
  "useLargeHeader": true,
  "disableDarkMode": null,
  "twitter": null,
  "subscribeBySms": null,
  "brandColor": null,
  "okColor": null,
  "disruptedColor": null,
  "downColor": null,
  "degradedColor": null,
  "noticeColor": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "onboarded": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false,
  "allowList": [],
  "components": [
    {
      "id": "ckg8auwlzlcxd09506r3g6y8z",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8auwv7lcxm09506jjate2o",
      "name": "App",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    },
    {
      "id": "ckg8aux4oo3ik0a35parnbunk",
      "name": "API",
      "status": "OPERATIONAL",
      "showUptime": true,
      "order": null,
      "group": null,
      "incidents": []
    }
  ]
}

Update a status page

Endpoint:

PUT /v1/:page_id

Example request:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "name": "Nasa",
  "status": "UP",
  "subdomain": "nasa",
  "logoUrl": "https://instatus.com/sample.png",
  "faviconUrl": "https://instatus.com/favicon-32x32.png",
  "websiteUrl": "https://instatus.com",
  "language": "en",
  "publicEmail": "hello@nasa.gov",
  "useLargeHeader": true,
  "brandColor": "#111",
  "okColor": "#33B17E",
  "disruptedColor": "#FF8C03",
  "degradedColor": "#ECC94B",
  "downColor": "#DC123D",
  "noticeColor": "#70808F",
  "unknownColor": "#DFE0E1",
  "googleAnalytics": "UA-00000000-1",
  "subscribeBySms": true,
  "smsService": "twilio",
  "twilioSid": "YOUR_TWILIO_SID",
  "twilioToken": "YOUR_TWILIO_TOKEN",
  "twilioSender": "YOUR_TWILIO_SENDER",
  "esendexUsername": "YOUR_ESENDEX_USERNAME",
  "esendexPassword": "YOUR_ESENDEX_PASSWORD",
  "esendexAccountRef": "YOUR_ESENDEX_ACCOUNT_REF",
  "nexmoKey": null,
  "nexmoSecret": null,
  "nexmoSender": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false
}

Example response:

{
  "id": "ckg8auvrglcx309501fcjb2vl",
  "createdAt": "2020-10-13T18:29:25.708Z",
  "subdomain": "nasa",
  "name": "Nasa",
  "status": "UP",
  "logoUrl": null,
  "faviconUrl": null,
  "websiteUrl": null,
  "color": null,
  "language": null,
  "googleAnalytics": null,
  "publicEmail": "hello@nasa.gov",
  "customDomain": null,
  "useLargeHeader": true,
  "disableDarkMode": null,
  "twitter": null,
  "subscribeBySms": null,
  "brandColor": null,
  "okColor": null,
  "disruptedColor": null,
  "downColor": null,
  "degradedColor": null,
  "noticeColor": null,
  "htmlInMeta": null,
  "htmlAboveHeader": null,
  "htmlBelowHeader": null,
  "htmlAboveFooter": null,
  "htmlBelowFooter": null,
  "htmlBelowSummary": null,
  "cssGlobal": null,
  "onboarded": null,
  "launchDate": null,
  "dateFormat": "MMMMMM d, yyyy",
  "dateFormatShort": "MMM yyyy",
  "timeFormat": "p",
  "private": false,
  "useAllowList": false,
  "allowList": [],
  "components": [
  {
    "id": "ckg8auwlzlcxd09506r3g6y8z",
    "name": "Website",
    "status": "OPERATIONAL",
    "showUptime": true,
    "order": null,
    "group": null,
    "incidents": []
  },
  {
    "id": "ckg8auwv7lcxm09506jjate2o",
    "name": "App",
    "status": "OPERATIONAL",
    "showUptime": true,
    "order": null,
    "group": null,
    "incidents": []
  },
  {
    "id": "ckg8aux4oo3ik0a35parnbunk",
    "name": "API",
    "status": "OPERATIONAL",
    "showUptime": true,
    "order": null,
    "group": null,
    "incidents": []
  }
]
}

Delete a status page

Endpoint:

DELETE /v1/:page_id

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
}

Components

Get all your status page components

Endpoint:

GET /v1/:page_id/components

Example response:

[
  {
    "id": "ckf01fvnxywz60a35wdbn5gz5",
    "name": "App",
    "status": "OPERATIONAL",
    "uniqueEmail": "nasa-app-1nozrueut@automation.instatus.com",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null,
    "incidents": []
  },
  {
    "id": "ckf01fvnxywz50a35nh1qzssm",
    "name": "Website",
    "status": "OPERATIONAL",
    "description": "",
    "showUptime": true,
    "order": 0,
    "group": null,
    "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com",
    "incidents": [
      {
        "id": "ckf01m59ueaqb0a32wrljz1yd",
        "name": "Rocket is going down",
        "started": "2020-09-12T19:05:17.398Z",
        "status": "RESOLVED",
        "components": [
          {
            "id": "ckf01fvnxywz50a35nh1qzssm",
            "name": "Website",
            "status": "OPERATIONAL",
            "showUptime": true
          }
        ],
        "updates": [
        {
          "id": "ckf01m5ioeaqi0a32jtv8ovp8",
          "message": "We are currently investigating this incident.",
          "messageHtml": "<p>We are currently investigating this incident.</p>",
          "status": "INVESTIGATING",
          "started": "2020-09-12T19:05:17.398Z"
        },
        {
          "id": "ckf01mnk9eaui0a32mmhgq68g",
          "message": "We just resolved the issue!",
          "messageHtml": "<p>We just resolved the issue!</p>",
          "status": "RESOLVED",
          "started": "2020-09-12T19:09:04.498Z"
        }
      ]
    },
    {
      "id": "ckf02l5m8z36j0a35qr9q1tq1",
      "name": "Test incident",
      "started": "2020-09-12T03:38:47.998Z",
      "status": "INVESTIGATING",
      "components": [
        {
          "id": "ckf01fvnxywz50a35nh1qzssm",
          "name": "Website",
          "status": "OPERATIONAL",
          "showUptime": true
        }
      ],
      "updates": [
        {
          "id": "ckf02l5tregrr0a3292xt1207",
          "message": "We're currently investigating an issue with the Website",
          "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
          "status": "INVESTIGATING",
          "started": "2020-09-12T03:38:47.998Z"
        }
      ]
    }
    ]
  }
]

Get a component

Endpoint:

GET /v1/:page_id/components/:component_id

Example response

{
  "id": "ckf01fvnxywz50a35nh1qzssm",
  "name": "Website",
  "description": "",
  "status": "OPERATIONAL",
  "uniqueEmail": "nasa-website-1nozrueut@automation.instatus.com",
  "showUptime": true,
  "order": 0,
  "group": null,
  "incidents": [
    {
      "id": "ckf01m59ueaqb0a32wrljz1yd",
      "name": "Rocket is going down",
      "started": "2020-09-12T19:05:17.398Z",
      "resolved": "2020-09-12T19:09:04.498Z",
      "status": "RESOLVED",
      "updates": [
      {
        "id": "ckf01m5ioeaqi0a32jtv8ovp8",
        "message": "We are currently investigating this incident.",
        "messageHtml": "<p>We are currently investigating this incident.</p>",
        "status": "INVESTIGATING",
        "started": "2020-09-12T19:05:17.398Z"
      },
      {
        "id": "ckf01mnk9eaui0a32mmhgq68g",
        "message": "We just resolved the issue!",
        "messageHtml": "<p>We just resolved the issue!</p>",
        "status": "RESOLVED",
        "started": "2020-09-12T19:09:04.498Z"
      }
      ],
      "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true
      }]
    },
    {
      "id": "ckf02l5m8z36j0a35qr9q1tq1",
      "name": "Test incident",
      "started": "2020-09-12T03:38:47.998Z",
      "resolved": null,
      "status": "INVESTIGATING",
      "updates": [
      {
        "id": "ckf02l5tregrr0a3292xt1207",
        "message": "We're currently investigating an issue with the Website",
        "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
        "status": "INVESTIGATING",
        "started": "2020-09-12T03:38:47.998Z"
      }
    ],
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true
      }
    ]
    }
  ]
}

Create a component

Endpoint:

POST /v1/:page_id/components

Example request:

{
  "name": "Test component",
  "description": "Testing",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false
}

Example response:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component 3",
  "description": "Test test test",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "showUptime": true,
  "order": 8,
  "group": null,
  "incidents": []
}

Update a component

Endpoint:

PUT /v1/:page_id/components/:component_id

Example request:

{
  "name": "Test component 4",
  "description": "Test test test",
  "status": "OPERATIONAL",
  "order": 6,
  "showUptime": true,
  "grouped": false
}

Example response:

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
  "name": "Test component 4",
  "uniqueEmail": "nasa-test-component-oomaksikj@automation.instatus.com",
  "status": "OPERATIONAL",
  "description": "Test test test",
  "status": "OPERATIONAL",
  "showUptime": true,
  "order": 6,
  "group": null,
  "incidents": []
}

Delete a component

Endpoint:

DELETE /v1/:page_id/components/:component_id

{
  "id": "ckf1d4f6a4aaf0a356vqg0rdm",
}

Incidents

Get all page incidents

Endpoint:

GET /v1/:page_id/incidents

Example response:

[
{
  "id": "ckf01m59ueaqb0a32wrljz1yd",
  "name": "Rocket is going down",
  "started": "2020-09-12T19:05:17.398Z",
  "status": "RESOLVED",
  "resolved": "2020-09-12T19:09:04.498Z",
  "updates": [
    {
      "id": "ckf01m5ioeaqi0a32jtv8ovp8",
      "message": "We are currently investigating this incident.",
      "messageHtml": "<p>We are currently investigating this incident.</p>",
      "status": "INVESTIGATING",
      "notify": true,
      "started": "2020-09-12T19:05:17.398Z",
      "ended": null,
      "duration": 228,
      "createdAt": "2020-09-12T19:08:50.160Z"
    },
    {
      "id": "ckf01mnk9eaui0a32mmhgq68g",
      "message": "We just resolved the issue!",
      "messageHtml": "<p>We just resolved the issue!</p>",
      "status": "RESOLVED",
      "notify": true,
      "started": "2020-09-12T19:09:04.498Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-12T19:09:13.545Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}
]

Get an incident

Endpoint:

GET /v1/:page_id/incidents/:incident_id

Example response:

{
  "id": "ckf01m59ueaqb0a32wrljz1yd",
  "name": "Rocket is going down",
  "status": "RESOLVED",
  "started": "2020-09-12T19:05:17.398Z",
  "resolved": "2020-09-12T19:09:04.498Z",
  "updates": [
    {
      "id": "ckf01m5ioeaqi0a32jtv8ovp8",
      "message": "We are currently investigating this incident.",
      "messageHtml": "<p>We are currently investigating this incident.</p>",
      "status": "INVESTIGATING",
      "notify": true,
      "started": "2020-09-12T19:05:17.398Z",
      "ended": null,
      "duration": 228,
      "createdAt": "2020-09-12T19:08:50.160Z"
    },
    {
      "id": "ckf01mnk9eaui0a32mmhgq68g",
      "message": "We just resolved the issue!",
      "messageHtml": "<p>We just resolved the issue!</p>",
      "status": "RESOLVED",
      "notify": true,
      "started": "2020-09-12T19:09:04.498Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-12T19:09:13.545Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Add an incident

Endpoint:

POST /v1/:page_id/incidents

Example request:

{
    "name": "Test incident",
    "message": "We're currently investigating an issue with the Website",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "status": "INVESTIGATING",
    "notify": true,
    "statuses": [{
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "status": "OPERATIONAL"
    }]
}

Example response:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Update incident

Endpoint:

PUT /v1/:page_id/incidents/:incident_id

Example request:

{
    "name": "Test incident 2",
    "message": "We're currently investigating an issue with the Website",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "status": "INVESTIGATING",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "OPERATIONAL"
    }]
}

Example response:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1",
  "name": "Test incident 2",
  "status": "INVESTIGATING",
  "started": "2020-09-12T03:38:47.998Z",
  "resolved": null,
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Delete incident

Endpoint:

DELETE /v1/:page_id/incidents/:incident_id

Example response:

{
  "id": "ckf02l5m8z36j0a35qr9q1tq1"
}

Incident updates

Get an incident update

Endpoint:

GET /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example response

{
  "id": "ckf1ew8mol30c0a32w400k6s3",
  "message": "We're currently investigating an issue with the Website",
  "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
  "status": "INVESTIGATING",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "incident": {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "started": "2020-09-12T19:05:17.398Z",
    "status": "INVESTIGATING",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "site": {
          "subdomain": "nasa",
          "logoUrl": null,
          "name": "Nasa",
          "slackIntegrations": [],
          "subscribers": []
        },
        "subscribers": []
      }
    ]
  }
}

Add an incident update

Endpoint:

POST /v1/:page_id/incidents/:incident_id/incident-updates

Example request

{
    "message": "We're currently investigating an issue with the Website",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "status": "INVESTIGATING",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "OPERATIONAL"
    }]
}

Example response

{
  "id": "ckf1ew8mol30c0a32w400k6s3",
  "message": "We're currently investigating an issue with the Website",
  "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
  "status": "INVESTIGATING",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "incident": {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "started": "2020-09-12T19:05:17.398Z",
    "status": "INVESTIGATING",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "site": {
          "subdomain": "nasa",
          "logoUrl": null,
          "name": "Nasa",
          "slackIntegrations": [],
          "subscribers": []
        },
        "subscribers": []
      }
    ]
  }
}

Edit an incident update

Endpoint:

PUT /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example request

{
    "message": "We're currently investigating an issue with the Website",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "status": "INVESTIGATING",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "OPERATIONAL"
    }]
}

Example response

{
  "id": "ckf1ew8mol30c0a32w400k6s3",
  "message": "We're currently investigating an issue with the Website",
  "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
  "status": "INVESTIGATING",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "incident": {
    "id": "ckf01m59ueaqb0a32wrljz1yd",
    "name": "Rocket is going down",
    "started": "2020-09-12T19:05:17.398Z",
    "status": "INVESTIGATING",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "site": {
          "subdomain": "nasa",
          "logoUrl": null,
          "name": "Nasa",
          "slackIntegrations": [],
          "subscribers": []
        },
        "subscribers": []
      }
    ]
  }
}

Delete an incident update

Endpoint:

DELETE /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example response

{
  "id": "ckf1ew8mol30c0a32w400k6s3"
}

Maintenances

Get all page maintenances

Endpoint:

GET /v1/:page_id/maintenances

Example response:

[
  {
    "id": "ckf1fzzbt4nib0a352wwra6ff",
    "name": "Test maintenance",
    "status": "NOTSTARTEDYET",
    "start": "2020-09-13T18:38:58.326Z",
    "duration": 60,
    "updates": [
      {
        "id": "ckf1fzzpal97v0a322evc874c",
        "message": "We are planning for a scheduled maintenance during that time.",
        "messageHtml": "<p>We are planning for a scheduled maintenance during that time.</p>",
        "status": "NOTSTARTEDYET",
        "notify": true,
        "started": "2020-09-13T18:38:58.326Z",
        "ended": null,
        "duration": null,
        "createdAt": "2020-09-13T18:39:16.606Z"
      }
    ],
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null
        }
      }
    ]
  }
]

Get a maintenance

Endpoint:

GET /v1/:page_id/maintenances/:maintenance_id

Example response:

{
  "id": "ckf1fzzbt4nib0a352wwra6ff",
  "name": "Test maintenance",
  "status": "NOTSTARTEDYET",
  "start": "2020-09-13T18:38:58.326Z",
  "duration": 60,
  "updates": [
    {
      "id": "ckf1fzzpal97v0a322evc874c",
      "message": "We are planning for a scheduled maintenance during that time.",
      "messageHtml": "<p>We are planning for a scheduled maintenance during that time.</p>",
      "status": "NOTSTARTEDYET",
      "notify": true,
      "started": "2020-09-13T18:38:58.326Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-13T18:39:16.606Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Add an maintenance

Endpoint:

POST /v1/:page_id/maintenances

Example request:

{
    "name": "Test maintenance",
    "message": "We are scheduling a test maintenance",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "start": "2020-09-12 05:38:47.998",
    "end": "2020-09-12 06:38:47.998",
    "status": "NOTSTARTEDYET",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "UNDERMAINTENANCE"
    }]
}

Example response:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5",
  "name": "Test maintenance",
  "duration": null,
  "start": "2020-09-12T03:38:47.998Z",
  "end": "2020-09-12T04:38:47.998Z",
  "status": "NOTSTARTEDYET",
  "updates": [],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Update maintenance

Endpoint:

PUT /v1/:page_id/maintenances/:maintenance_id

Example request:

{
    "name": "Test incident 2",
    "message": "We are scheduling a test maintenance",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "start": "2020-09-12 05:38:47.998",
    "end": "2020-09-12 06:38:47.998",
    "status": "NOTSTARTEDYET",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "UNDERMAINTENANCE"
    }]
}

Example response:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5",
  "name": "Test maintenance 2",
  "status": "NOTSTARTEDYET",
  "start": "2020-09-12T03:38:47.998Z",
  "duration": null,
  "updates": [
    {
      "id": "ckf1g4ffi4o5y0a35rm76vuq9",
      "message": "We're currently investigating an issue with the Website",
      "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
      "status": "NOTSTARTEDYET",
      "notify": true,
      "started": "2020-09-12T03:38:47.998Z",
      "ended": null,
      "duration": null,
      "createdAt": "2020-09-13T18:42:43.614Z"
    }
  ],
  "components": [
    {
      "id": "ckf01fvnxywz50a35nh1qzssm",
      "name": "Website",
      "status": "OPERATIONAL",
      "showUptime": true,
      "site": {
        "id": "ckf01fonve9i40a32oas5b0uw",
        "name": "Nasa",
        "subdomain": "nasa",
        "color": null,
        "logoUrl": null,
        "publicEmail": null
      }
    }
  ]
}

Delete maintenance

Endpoint:

DELETE /v1/:page_id/maintenances/:maintenance_id

Example response:

{
  "id": "ckf1g4evp4o5s0a35vozxnjv5"
}

Maintenance updates

Get a maintenance update

Endpoint:

GET /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example response

{
  "id": "ckf1g4ffi4o5y0a35rm76vuq9",
  "message": "We're currently investigating an issue with the Website",
  "messageHtml": "<p>We're currently investigating an issue with the Website</p>",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "status": "NOTSTARTEDYET",
  "maintenance": {
    "id": "ckf1g4evp4o5s0a35vozxnjv5",
    "name": "Test maintenance 2",
    "start": "2020-09-12T03:38:47.998Z",
    "status": "NOTSTARTEDYET",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null
        }
      }
    ]
  }
}

Add an maintenance update

Endpoint:

POST /v1/:page_id/maintenances/:maintenance_id/maintenance-updates

Example request

{
    "message": "We are scheduling a test maintenance",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "end": "2020-09-12 06:38:47.998",
    "status": "NOTSTARTEDYET",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "UNDERMAINTENANCE"
    }]
}

Example response

{
  "id": "ckf1hlezn4vzv0a358mh8jg0z",
  "message": "We are scheduling a test maintenance",
  "messageHtml": "<p>We are scheduling a test maintenance</p>",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "status": "NOTSTARTEDYET",
  "maintenance": {
    "id": "ckf1hdrlilhvr0a32pyllguzs",
    "name": "Maintenance test",
    "start": "2020-09-12T03:38:47.998Z",
    "status": "NOTSTARTEDYET",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "subscribers": [],
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null,
          "subscribers": []
        }
      }
    ]
  }
}

Edit an maintenance update

Endpoint:

PUT /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example request

{
    "message": "We are scheduling a test maintenance 2",
    "components": ["ckf01fvnxywz50a35nh1qzssm"],
    "started": "2020-09-12 05:38:47.998",
    "end": "2020-09-12 06:38:47.998",
    "status": "NOTSTARTEDYET",
    "notify": true,
    "statuses": [{
        "id": "ckebhqpxnrk1c0a3588oztaty",
        "status": "UNDERMAINTENANCE"
    }]
}

Example response

{
  "id": "ckf1hlezn4vzv0a358mh8jg0z",
  "message": "We are scheduling a test maintenance 2",
  "messageHtml": "<p>We are scheduling a test maintenance 2</p>",
  "notify": true,
  "started": "2020-09-12T03:38:47.998Z",
  "status": "NOTSTARTEDYET",
  "maintenance": {
    "id": "ckf1hdrlilhvr0a32pyllguzs",
    "name": "Maintenance test",
    "start": "2020-09-12T03:38:47.998Z",
    "status": "NOTSTARTEDYET",
    "components": [
      {
        "id": "ckf01fvnxywz50a35nh1qzssm",
        "name": "Website",
        "status": "OPERATIONAL",
        "showUptime": true,
        "subscribers": [],
        "site": {
          "id": "ckf01fonve9i40a32oas5b0uw",
          "name": "Nasa",
          "subdomain": "nasa",
          "color": null,
          "logoUrl": null,
          "publicEmail": null,
          "subscribers": []
        }
      }
    ]
  }
}

Delete an maintenance update

Endpoint:

DELETE /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example response

{
  "id": "ckf1hlezn4vzv0a358mh8jg0z"
}

Team members

Get team members

Endpoint:

GET /v1/:page_id/team

Example response

[
  {
    "id": "ckg8atgc1o3eo0a3572ix475l",
    "user": {
      "id": "ckg8atfj8o3ec0a35p3ol3r1b",
      "name": "Ali Salah",
      "email": "ali@instatus.com",
      "avatar": "https://res.cloudinary.com/sup/image/upload/v1600287654/avatars/uuhfbauwwv7zjzzejgik.jpg"
    }
  }
]

Add a team member

POST /v1/:page_id/team

Example request

{
  "email": "john@instatus.com"
}

Delete a team member

DELETE /v1/:page_id/team/:member_id

Subscribers

Get subscribers

Endpoint:

GET /v1/:page_id/subscribers

Example response

[
  {
    "id": "ckggwtsf18q760950wplqqka7",
    "email": "ali@instatus.com",
    "phone": null,
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "all": true,
    "components": []
  },
  {
    "id": "ckgurryh6lcyu0946f3bci43n",
    "email": null,
    "phone": "5417543010"
    "webhook": null,
    "webhookEmail": null,
    "confirmed": false,
    "all": true,
    "components": []
  }
]

Add a subscriber

Endpoint:

POST /v1/:page_id/subscribers

Example request

{
  "email": "sarah@instatus.com",
  "all": true
  "autoConfirm": false // set to true to skip confirmation emails (paid feature)
}

Example response

{
  "id": "ckguumthplm400946ggcxn0x6",
  "email": "sarah@instatus.com",
  "phone": null,
  "webhook": null,
  "webhookEmail": null,
  "site": {
    "id": "ckg8atg2ro3eh0a35s5v86wrn",
    "name": "Test",
    "logoUrl": null,
    "subdomain": "test",
    "publicEmail": null,
    "language": "en"
  }
}

Remove a subscriber

Endpoint:

DELETE /v1/:page_id/subscribers/:subscriber_id

Metrics

Get all metrics

Endpoint:

GET /v1/:page_id/metrics

Example response:

[
  {
    "id": "ckj1qyonq9sdk09819xdg4ehm",
    "name": "Testing",
    "active": true,
    "order": 1,
    "suffix": "ms",
    "data": [
      {
        "timestamp": 1608474985000,
        "value": 355
      },
      {
        "timestamp": 1608475225000,
        "value": 428.25
      },
      {
        "timestamp": 1608475465000,
        "value": 356
      },
      {
        "timestamp": 1608475705000,
        "value": 451.75
      },
      ...
    ]
  },
  ...
]

Get a metric

Endpoint:

GET /v1/:page_id/metrics/:metric_id

Example response:

{
  "id": "ckj1qyonq9sdk09819xdg4ehm",
  "name": "Testing",
  "active": true,
  "order": 1,
  "suffix": "ms",
  "data": [
    {
      "timestamp": 1608474985000,
      "value": 355
    },
    {
      "timestamp": 1608475225000,
      "value": 428.25
    },
    {
      "timestamp": 1608475465000,
      "value": 356
    },
    {
      "timestamp": 1608475705000,
      "value": 451.75
    },
    ...
  ]
}

Add a metric

Endpoint:

POST /v1/:page_id/metrics

{
  "subdomain": "nasa",
  "name": "Response time",
  "suffix": "ms"
}

Example response:

{
  "id": "ckj1qyonq9sdk09819xdg4ehm",
  "name": "Response time",
  "active": true,
  "order": 1,
  "suffix": "ms",
  "lastDataAt": 1608561235000,
  "data": [
    {
      "timestamp": 1608474985000,
      "value": 355
    },
    {
      "timestamp": 1608475225000,
      "value": 428.25
    },
    {
      "timestamp": 1608475465000,
      "value": 356
    },
    ...
  ]
}

Update a metric

Endpoint:

PUT /v1/:page_id/metrics/:metric_id

Example request:

{
  "name": "Response time",
  "suffix": "ms"
}

Example response:

{
  "id": "ckj1qyonq9sdk09819xdg4ehm",
  "name": "Response time",
  "active": true,
  "order": 1,
  "suffix": "ms",
  "lastDataAt": 1608561235000,
  "data": [
    {
      "timestamp": 1608474985000,
      "value": 355
    },
    {
      "timestamp": 1608475225000,
      "value": 428.25
    },
    {
      "timestamp": 1608475465000,
      "value": 356
    },
    ...
  ]
}

Delete a metric

Endpoint:

DELETE /v1/:page_id/metrics/:metric_id

Add a datapoint to a metric

Endpoint:

POST /v1/:page_id/metrics/:metric_id

Request:

{
    "timestamp": 1608672985000,
    "value": 356
}

Response:

{
  "id": "ckj395ptx9ha40995ckzv0pz2",
  "value": 356,
  "timestamp": 1608672985000
}

Add multiple datapoints to a metric

Endpoint:

POST /v1/:page_id/metrics/:metric_id/data

Request:

{
  "data": [
  {
    "timestamp": 1608474985000,
    "value": 355
  },
  {
    "timestamp": 1608475225000,
    "value": 428.25
  },
  {
    "timestamp": 1608475465000,
    "value": 356
  },
  {
    "timestamp": 1608475705000,
    "value": 451.75
  },
  {
    "timestamp": 1608475945000,
    "value": 395
  },
  {
    "timestamp": 1608476185000,
    "value": 375.75
  },
  {
    "timestamp": 1608476425000,
    "value": 380.25 
  },
  ...
  ]
}

Response

[
  {
    "timestamp": 1608474985000,
    "value": 355
  },
  {
    "timestamp": 1608475225000,
    "value": 428.25
  },
  {
    "timestamp": 1608475465000,
    "value": 356
  },
  {
    "timestamp": 1608475705000,
    "value": 451.75
  },
  {
    "timestamp": 1608475945000,
    "value": 395
  },
  {
    "timestamp": 1608476185000,
    "value": 375.75
  },
  {
    "timestamp": 1608476425000,
    "value": 380.25 
  }
]

Delete datapoints to a metric

Endpoint:

DELETE /v1/:page_id/metrics/:metric_id/data

Response

{
  "name": "Response time",
  "site": {
    "id": "ckj1qyonq9sdk09819xdg4ehm",
    "subdomain": "our"
  }
}

User profile

Get your user profile

Endpoint:

GET /v1/user

Example response:

[
  {
    "id": "hkf01fozve9e40a32aas5b0uc",
    "email": "ali@instatus.com",
    "name": "Ali",
    "slug": 'ali',
    "avatar": "https://res.cloudinary.com/sup/image/upload/v1622398781/avatars/spzy0jvdmhges13oeooo.jpg"
  }
]

Publicly available data

The easiest way to get the current status of your page is through

your-status-page-url/summary.json

An example is https://instat.us/summary.json

Example response:

{
  "page": {
    "name": "Instatus",
    "url": 'https://instat.us',
    "status": "UP"
  }
}

Possible page statuses are:

UP
HASISSUES
UNDERMAINTENANCE