Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,362,297
Community Members
 
Community Events
168
Community Groups

Upcoming changes to enforce pagination for Statuspage's authenticated REST API

Statuspage is making important performance-based changes to the authenticated REST API by enforcing pagination for a specific set of endpoints. If you have an existing integration with our REST API, you may need to make changes to your REST API calls to accommodate these changes, so please read on to understand the details.

Which endpoints are affected?

What's changing?

As of Aug 31, 2022, all GET requests made to the above endpoints accept the following pagination parameters, which are both initially optional:

  • page - Page offset to fetch

  • per_page - Number of results to return per page (note: for backward compatibility, /pages/{page_id}/subscribers will continue to use the limit query parameter)

These parameters will instruct the REST API to return a paginated set of results for a given endpoint, specifically returning up to per_page results that are offset by page. Previously, all GET requests to the above endpoints would have returned the full set of results without being paginated or truncated. Example request and response bodies for each endpoint can be viewed by referencing our API documentation.

As of Feb. 28, 2023, all GET requests made to the above endpoints will have default values unless explicitly specified:

  • page - 1st page

  • per_page - 100 results

Requests that omit these parameters will return a truncated set equivalent of ?page=1&per_page=100 instead of the full set of results.

What you need to do:

If you’re using any of the endpoints listed above in your integration, please implement pagination for your GET requests before Feb. 28, 2023.

If you have questions about these changes, please feel free to post a comment here.

4 comments

Hello world Meows'.  

Can I please confirm that the /pages/{page-id}/incidents endpoint remains unchanged and without paging still?
I'm only asking because I saw /pages/{page_id}/incidents/{incident_id}/subscribers in the list of affected endpoints :)

Hi @Acaboom Suppoprt, we left out /pages/{page-id}/incidents in the announcement because it is in fact already paginated, with a max limit of 100, so there's no change in API behaviour for that particular endpoint. Hope that helps, thanks!

Hi @Vincent Cheng , 

thanks for the improvements! :)

Like Vincent Cheng likes this

Comment

Log in or Sign up to comment
TAGS

Atlassian Community Events