The product links REST API provides resources related to updating Jira issue links and Confluence page links after migrating from Server or Data Center to Cloud.

Authentication is implemented via an API key. Use the API key as a Bearer access token

Learn how to create an API key.

A rate limit defines the maximum number of API calls an application or user can perform during a specific time frame. When this threshold is surpassed, or if CPU or total time constraints are exceeded, the application or user might encounter delays. Consequently, API requests initiated by the user or application will not succeed.

It is essential to note that all API requests are subjected to rate limits.

When a client breach the rate limit thresholds, they get HTTP 429 Too Many Requests responses. The client has to wait for the rate limit counter to reset on the server before being able to make successful requests.

Rate limit response headers

The following HTTP response headers are returned indicating the rate and threshold allowed for a client for each endpoint.

• X-RateLimit-Limit: The number of allowed requests in the current period
• X-RateLimit-Remaining: The number of remaining requests in the current period
• X-RateLimit-Reset: Next period reset time (ISO 8601 - Date and time in UTC)

The URIs for resources have the following structure.

1
2
https://api.atlassian.com/links/v1/{siteId}/<resource-name>