Status API

The Status API is a public-facing API for determining the status of components and subcomponents in the Zendesk infrastructure.

Authentication is not required for this API.

API path

The path of the Status API differs from the Zendesk v2 APIs. Instead of https://{subdomain}.zendesk.com, which gives you access to your Zendesk instance, the path of the Status API is as follows:

https://status.zendesk.com

The API gives you access to status.zendesk.com rather than your Zendesk instance.

In this guide, endpoints are listed using a partial resource identifier, such as:

GET /api/components/{id_or_tag}?domain={subdomain}.zendesk.com

Prepend the API path to get the full endpoint:

https://status.zendesk.com/api/components/{id_or_tag}?domain={subdomain}.zendesk.com

Rate limit

This API is rate limited to 10 requests per minute.

JSON format

The status of a component or subcomponent is represented by a JSON object with the following properties:

Name Type Comment
id integer Id of the component or subcomponent
name string Name of the component or subcomponent
tag string Generated from the name of the component or subcomponent
description string Description of the component or subcomponent
component_id* integer *For subcomponents only. Id of the parent component
pod_id integer Id of the pod (point of service) in the Zendesk infrastructure
status* string *For GET requests only. One of "operational", "impeded", or "inoperative"
impact* string *For GET requests only. One of "minor", "major", "critical", or "security"
active_incidents array of incidents See incidents

Example

{
  "id":     123,
  "name":   "string",
  "status": "string",
  "impact": "string",
  "incidents": [
     {...},
     ...
   ]
}
incidents

To view incidents, show_incidents=true must be included in the List components and List subcomponents API calls.

Incidents are represented by JSON objects with the following properties:

Name Type Comment
id integer Id of the incident
name string Name of the incident
started_at date Time when the incident started
impact string One of "minor", "major", "critical", or "security"
status string One of "operational", "impeded", or "inoperative"
updates array of updates See incident updates

Example

{
  "id":         123,
  "name":       "string",
  "started_at": "2018-01-19T22:58:45.126Z",
  "status":     "impeded",
  "impact":     "minor",
  "updates": [
    {...},
    ...
  ],
}
incident updates

Incident updates have the following properties:

Name Type Comment
id integer Id of the incident update
created_at date Time when the incident update was created
updated_at date Time when the incident update was modified
description string Description of the incident update
incident_id integer Id of the incident

Example

{
  "id":          123,
  "created_at":  "2018-01-19T22:58:45.126Z",
  "updated_at":  "2018-01-19T23:18:11.156Z",
  "description": "string",
  "incident_id": 456
}

Show status of a component

GET /api/components/{id_or_tag}?domain={subdomain}.zendesk.com

Use the List components endpoint to get the id or tag of a component.

Allowed For
  • Anonymous users
Using curl
curl https://status.zendesk.com/api/components/{id_or_tag}?domain={subdomain}.zendesk.com
Example Response
Status: 200 OK

{
  "id": 123,
  "name": "string",
  "status": "string",
  "pod_id": 456,
  "tag": "string"
  "active_incidents": [
    {
      "started_at": "2018-01-19T21:01:31.063Z",
      "id": 789,
      "name": "string"
      "impact": "operational",
      "status": "string",
      "updates": [ {...}, ... ],
    },
    ...
  ]
}

Show status of a subcomponent

GET /api/components/{component_id_or_tag}/subcomponents/{id_or_tag}?domain={subdomain}.zendesk.com

Use the List subcomponents endpoint to get the id or tag of a subcomponent.

Allowed For
  • Anonymous users
Using curl
curl https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents/{id_or_tag}?domain={subdomain}.zendesk.com
Example Response
Status: 200 OK

{
  "id": 123,
  "component_id": 456,
  "name": "string",
  "status": "string",
  "impact": "string",
  "active_incidents": [
    {
      "started_at": "2018-01-19T21:13:22.319Z",
      "id": 789,
      "name": "string",
      "impact": "operational",
      "status": "string",
      "updates": [ {...}, ... ],
    },
    ...
  ]
}

List components

GET /api/components?domain={subdomain}.zendesk.com

For active_incidents to be included in response, include show_incidents=true as follows: GET /api/components?domain={subdomain}.zendesk.com&show_incidents=true

Lists components and their subcomponents. Components are represented by JSON objects with the following properties:

Name Type Comment
id integer Id of the component or subcomponent
name string Name of the component or subcomponent
tag string Generated from the name of the component or subcomponent
description string Description of the component or subcomponent
pod_id integer Id of the pod in the Zendesk infrastructure
subcomponents array List of subcomponents. See List subcomponents
active_incidents array of incidents See incidents
Allowed For
  • Anonymous users
Using curl
curl https://status.zendesk.com/api/components?domain={subdomain}.zendesk.com
Example Response
Status: 200 OK

[
  {
    "id":          123,
    "name":        "string",
    "description": "string",
    "pod_id":      456,
    "tag":         "string",
    "subcomponents": [
      {
        "id":           789,
        "component_id": 123,
        "name":         "string",
        "description":  "string",
        "pod_id":       456,
        "tag":          "string",
        "active_incidents": [
          {...},
          ...
        ]
      },
      ...
    ],
    "active_incidents": [
      {...},
      ...
    ]
  },
  ...
]

List subcomponents

GET /api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com

For active_incidents to be included in response, include show_incidents=true as follows: GET /api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com&show_incidents=true

Lists the subcomponents of a specified component. Use the List components endpoint to get the id or tag of a component.

Subcomponents are represented by JSON objects with the following properties:

Name Type Comment
id integer Id of the component or subcomponent
name string Name of the component or subcomponent
tag string Generated from the name of the component or subcomponent
description string Description of the component or subcomponent
component_id integer Id of the parent component
pod_id integer Id of the pod in the Zendesk infrastructure
active_incidents array of incidents See incidents
Allowed For
  • Anonymous users
Using curl
curl https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com
Example Response
Status: 200 OK

[
  {
    "id":           123,
    "component_id": 456,
    "name":         "string",
    "description":  "string",
    "pod_id":       789,
    "tag":          "string",
    "active_incidents": [
      {...},
      ...
    ]
  },
  ...
]