Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Which statuspage api should we use? v1 or v2?

Nikita Nemykin February 14, 2023

Status page docs offers endpoints which can be used only with API key. We also found a library which uses v2 endpoints. But it's mentioned here that v2 endpoints are deprecated. Also I haven't managed to find any docs about v2 endpoints.

 

For us it's more convenient to use v2 api since it doesn't require api key and doesn't have as strict limit restrictions as v1 api has. In addition to that v2 also seems more preferable because it's easier to make requests without need to proxy them like it seems necessary to do for v1 api.

 

Are permissions calls to v2 api limited to GET only requests? Are there any docs on v2 api? Is v2 api deprecated?

1 answer

1 accepted

1 vote
Answer accepted
Muhammad Zeeshan
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 16, 2023

Hey @Nikita Nemykin

We have two APIs:

  1. Manage API: The authenticated API found at https://developer.statuspage.io/ for managing the page - this is the v1 API you are referring to.

  2. Page API: An unauthenticated Status API for querying information from the page and embedding it elsewhere. The Status API can be found at your status page domain appending with '/api' - for example, https://status.newrelic.com/api - these contain the v2 endpoints.

You can find more information on that here: https://support.atlassian.com/statuspage/docs/what-are-the-different-apis-under-statuspage/ 

Nikita Nemykin February 19, 2023

How risky is it to use Page API because your colleague said that it's deprecated? https://community.atlassian.com/t5/Statuspage-questions/StatusPage-io-v2-api-subscribers-endpoint-not-returning-all/qaq-p/944674 

Muhammad Zeeshan
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 20, 2023

My colleague there means that the endpoints like ‘api.statuspage.io/v2/<endpoints>’ were deprecated.

The Page API uses something like ’status.twilio.com/api/v2/<endpoints>', which is different than what was deprecated and is working as expected.

Like Steffen Opel _Utoolity_ likes this
Raghav, Praveen August 22, 2023

Hi @Muhammad Zeeshan ,

Related question:

Is there a way to filter the incidents based on text using unauthenticated Status API?

https://status.twilio.com/api/v2/#incidents-all

 

We have filter functionality (q=) in V1. But this requires authentication.

https://developer.statuspage.io/#operation/getPagesPageIdIncidents

Muhammad Zeeshan
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
August 22, 2023

Hey @Raghav, Praveen ,

The unauthenticated Status API does not have the querying capability built in. Any queries and search refinements required need to be done after the API call on the resultant data.

Best regards,

Like Raghav, Praveen likes this

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
TAGS
AUG Leaders

Atlassian Community Events