| Announced on | New API Rollout on | Old API Deprecated on |
| March 2, 2023 | March 2, 2023 | September 1, 2023 |
Zendesk is pleased to announce a new and improved Status API.
What's changing?
Two things are changing. The legacy Status API is being deprecated and a new Status API is replacing it.
Specifically, the following legacy Status API endpoints are being deprecated:
- List components:
https://status.zendesk.com/api/components?domain={subdomain}.zendesk.com - Show component status:
https://status.zendesk.com/api/components/{component_id_or_tag}?domain={subdomain}.zendesk.com - List subcomponents:
https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents?domain={subdomain}.zendesk.com - Show subcomponent status:
https://status.zendesk.com/api/components/{component_id_or_tag}/subcomponents{subcomponent_id_or_tag}?domain={subdomain}.zendesk.com
Those deprecated endpoints are being replaced with the following new Status API endpoints:
- List active incidents:
https://status.zendesk.com/api/incidents/active - Show active incidents:
https://status.zendesk.com/api/incidents/{incident_id} - List maintenance incidents:
https://status.zendesk.com/api/incidents/maintenance
Why is Zendesk making this change?
There are many advantages to moving towards these new endpoints. First, we're adding the ability for users to check for maintenance incidents via the API. This isn't currently possible.
Most importantly, however, the new endpoints improve the user experience of identifying incidents affecting your account by reducing the number of API queries required to check for incident impacts. For example, using the legacy Status API endpoints, it would require three queries to check the incident status of the Ticketing subcomponent of Support. One to get the Support component_id, one to get the Ticketing subcomponent_id, and one using those id values to show the status of the subcomponent. With the new endpoints, the information can be retrieved with a single query to show active incidents.
What do I need to do?
If you're using the legacy Status API endpoints listed above, you must migrate to the new endpoints prior to the deprecation date. After this date, the legacy Status API endpoints won't be accessible and your requests won't be processed. For more information, see our detailed usage guide.
If you have any questions, contact Zendesk Customer Support.
5 Comments
hi,
I'm getting a no content in response to GET https://status.zendesk.com/api/incidents/active - is this abnormal?
Thanks
Hi Simon! In the event that there isn't currently an active incident, you should receive a 200, but with an object that contains two empty arrays; `data[]` and `included[]`. So if you mean this in the sense of a 204 status, then that isn't what I would expect to see. If it's a more literal "no useful content" there, then that would be expected. I'm getting the feeling that it's an actual 204, so if that's the case, let me know and we can dig into this further.
Greg Katechis that's ok then, the expected behaviour wasn't clear to me in the docs
Additionally, is the response from the API the live status or should we expect some delay in the response?
Thanks
No delay, that is going to be the live status. Aside from browser caching, latency inherent in the internet, etc., it will be the current view of things at Zendesk, as we report it. It's possible that you might experience an issue before we have it flagged, but that's less of a delay and probably not what you meant!
Please sign in to leave a comment.