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.

components

JSON Format

Statuses are represented as JSON objects with the following properties:

Name Type Read-only Mandatory Description
active_incidents array true false See incidents
description string true false Description of the component or subcomponent
id integer true false Id of the component or subcomponent
impact string true false For GET requests only. Allowed values are "minor", "major", "critical", "security", or "no impact".
name string true false Name of the component or subcomponent
pod_id integer true false Id of the pod (point of service) in the Zendesk infrastructure
status string true false For GET requests only. Allowed values are "operational", "impeded", or "inoperative".
subcomponents array true false List of subcomponents. See List subcomponents
tag string true false Generated from the name of the component or subcomponent

Example

{  "active_incidents": null,  "description": "chat",  "id": 23,  "impact": "critical",  "name": "Chat",  "pod_id": 1,  "status": "inoperative",  "subcomponents": [    {      "active_incidents": null,      "component_id": 23,      "description": "Dashboard",      "id": 24,      "name": "Dashboard",      "pod_id": 1,      "tag": "dashboard"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Chat Widget",      "id": 25,      "name": "Chat Widget",      "pod_id": 1,      "tag": "chat_widget"    }  ],  "tag": "chat"}

Subcomponent statuses

Subcomponent statuses are represented by JSON objects with the following properties:

Name Type Description
id integer Id of the subcomponent
component_id integer Id of the parent component
name string Name of the subcomponent
description string Description of the subcomponent
pod_id integer Id of the pod (point of service) in the Zendesk infrastructure
tag string Generated from the name of the subcomponent
status string For GET requests only. Allowed values are "operational", "impeded", or "inoperative"
impact string For GET requests only. Allowed values are "minor", "major", "critical", or "security"
active_incidents string See 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 Description
id integer Id of the incident
name string Name of the incident
started_at date Time when the incident started
impact string Allowed values are "minor", "major", "critical", or "security"
status string Allowed values are "operational", "impeded", or "inoperative"
updates array See incident updates

Example

{  "id":         123,  "name":       "Big, Bad Incident",  "started_at": "2018-01-19T22:58:45.126Z",  "status":     "impeded",  "impact":     "minor",  "updates": [    {      "id": 123,      "created_at": "2018-01-19T22:58:45.126Z",      "updated_at": "2018-01-19T23:18:11.156Z",      "description": "Incident Update 1",      "incident_id": 456    },    {      "id": 456,      "created_at": "2018-01-19T22:58:55.126Z",      "updated_at": "2018-01-19T23:19:11.156Z",      "description": "Incident Update 2",      "incident_id": 789    }  ]}

Incident updates

Incident updates are represented by JSON objects with the following properties:

Name Type Description
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": "Incident Update",  "incident_id": 456}

List Components

  • GET /api/components?domain={domain}

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

Parameters

Name Type In Required Description
domain string Query true Subdomain
show_incidents boolean Query false To view incidents

Using curl

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

Example Response

Status 200 OK
{  "components": [    {      "active_incidents": [        {          "id": 789,          "impact": "major",          "name": "Incident 1",          "started_at": "2018-01-19T21:01:31.063Z",          "status": "operational",          "updates": [            {              "created_at": "2018-01-19T22:58:45.126Z",              "description": "Incident Update",              "id": 123,              "incident_id": 456,              "updated_at": "2018-01-19T23:18:11.156Z"            }          ]        }      ],      "description": "chat",      "id": 23,      "name": "Chat",      "pod_id": 1,      "subcomponents": [        {          "active_incidents": null,          "component_id": 23,          "description": "Dashboard",          "id": 24,          "name": "Dashboard",          "pod_id": 1,          "tag": "dashboard"        },        {          "active_incidents": null,          "component_id": 23,          "description": "Chat Widget",          "id": 25,          "name": "Chat Widget",          "pod_id": 1,          "tag": "chat_widget"        }      ],      "tag": "chat"    },    {      "active_incidents": null,      "description": "Explore",      "id": 58,      "name": "Explore",      "pod_id": 1,      "subcomponents": [        {          "active_incidents": null,          "component_id": 58,          "description": "Data Extraction \u0026 Transformation",          "id": 59,          "name": "Data Extraction \u0026 Transformation",          "pod_id": 1,          "tag": "data_extraction_transformation"        }      ],      "tag": "explore"    }  ]}

Show Component Status

  • GET /api/components/{component_id_or_tag}?domain={domain}

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

Allowed For

  • Anonymous users

Parameters

Name Type In Required Description
domain string Query true Subdomain
component_id_or_tag string Path true ID or name of component

Using curl

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

Example Response

Status 200 OK
{  "active_incidents": [    {      "id": 789,      "impact": "major",      "name": "Incident 1",      "started_at": "2018-01-19T21:01:31.063Z",      "status": "operational",      "updates": [        {          "created_at": "2018-01-19T22:58:45.126Z",          "description": "Incident Update",          "id": 123,          "incident_id": 456,          "updated_at": "2018-01-19T23:18:11.156Z"        }      ]    }  ],  "id": 50,  "impact": "major",  "name": "Analytics",  "pod_id": 456,  "status": "operational",  "tag": "Widget"}

List Subcomponents

  • GET /api/components/{component_id_or_tag}/subcomponents?domain={domain}

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

Parameters

Name Type In Required Description
domain string Query true Subdomain
show_incidents boolean Query false To view incidents
component_id_or_tag string Path true ID or name of component

Using curl

curl https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com

Example Response

Status 200 OK
{  "subcomponents": [    {      "active_incidents": [        {          "id": 789,          "impact": "major",          "name": "Incident 1",          "started_at": "2018-01-19T21:01:31.063Z",          "status": "operational",          "updates": [            {              "created_at": "2018-01-19T22:58:45.126Z",              "description": "Incident Update",              "id": 123,              "incident_id": 456,              "updated_at": "2018-01-19T23:18:11.156Z"            }          ]        }      ],      "component_id": 23,      "description": "Dashboard",      "id": 24,      "name": "Dashboard",      "pod_id": 1,      "tag": "dashboard"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Chat Widget",      "id": 25,      "name": "Chat Widget",      "pod_id": 1,      "tag": "chat_widget"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Static Assets",      "id": 26,      "name": "Static Assets",      "pod_id": 1,      "tag": "static_assets"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Mobile Apps",      "id": 27,      "name": "Mobile Apps",      "pod_id": 1,      "tag": "mobile_apps"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Chat SDK",      "id": 28,      "name": "Chat SDK",      "pod_id": 1,      "tag": "chat_sdk"    },    {      "active_incidents": null,      "component_id": 23,      "description": "API",      "id": 30,      "name": "API",      "pod_id": 1,      "tag": "api"    },    {      "active_incidents": null,      "component_id": 23,      "description": "Chat Conversation API",      "id": 57,      "name": "Chat Conversation API",      "pod_id": 1,      "tag": "chat_conversation_api"    }  ]}

Show Subcomponent Status

  • GET /api/components/{component_id_or_tag}/subcomponents/{subcomponent_id_or_tag}?domain={domain}

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

Allowed For

  • Anonymous users

Parameters

Name Type In Required Description
domain string Query true Subdomain
component_id_or_tag string Path true ID or name of component
subcomponent_id_or_tag string Path true ID or name of subcomponent

Using curl

curl https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com

Example Response

Status 200 OK
{  "active_incidents": [    {      "id": 789,      "impact": "major",      "name": "Incident 1",      "started_at": "2018-01-19T21:01:31.063Z",      "status": "operational",      "updates": [        {          "created_at": "2018-01-19T22:58:45.126Z",          "description": "Incident Update",          "id": 123,          "incident_id": 456,          "updated_at": "2018-01-19T23:18:11.156Z"        }      ]    }  ],  "component_id": 23,  "description": "Dashboard",  "id": 24,  "name": "Dashboard",  "pod_id": 1,  "tag": "dashboard"}