Upcoming breaking changes to the Cortex Public API

Based on customer feedback, Cortex has added pagination support for all existing endpoints and rate limits to the API. All customers must migrate to paginated endpoints by January 31, 2025.

The API changes include: 

• Paginated endpoints
• Including teams in catalog API 
• Teams API deprecation 
• Rate limits

See the sections below for more information on each of these changes.

Paginated endpoints

Cortex is adding pagination query parameters to most GET endpoints that return more than a single entity. These queries will return a single page of data per response. Each of these endpoints will have page and pageSize query parameters. The page parameter will default to the first page (page=0).  The pageSize default will vary by endpoint.

You may need to change tools you have created that assumed that all entities would be returned by a single call to these endpoints. These tools will need to check returned responses for details like the following and loop over all pages:

{
  "total": 4796,
  "page": 0,
  "totalPages": 20,
  .
  .
  .
  }

Rate limits

Cortex is adding rate limiting as an additional layer of protection to ensure a great API experience for all customers, starting with the .../openapi endpoint. The rate limit will be set to 15 requests per second. Requests beyond that will receive a 429 response code and a Retry-After header including the number of seconds to wait before trying again.

Including teams in catalog API 

Team entities are not currently returned in catalog API endpoints unless an account flag for this has been enabled in your tenant. Cortex will be removing the account flag and returning team entities for all catalog endpoints.

When teams were first created in Cortex, they were not created as entities. They were not included in the catalog API, so they were not added by default when teams were converted to being treated as entities in a project launched in 2023.

Teams API deprecation

In conjunction with “Include teams in catalog API,” Cortex will be deprecating the teams API. Since teams are now entities, Cortex will support a single catalog API rather than maintaining separate APIs for catalogs and teams.