The Jira Align API 2.0 is currently available on Cloud deployments only and is behind a feature flag. Please contact our Support Team to start using the API. On-premise support will be coming soon!
The Jira Align REST API exposes key objects in Jira Align's people, work, and time hierarchies via a standardized programmatic interface. Using the API, you can perform most actions available through the user interface, as well as simplify user management, mass update work objects, and develop integrations between Jira Align and other applications.
This page provides an overview of the API and documents the REST resources available in Jira Align. For complete documentation on the resources, along with HTTP responses and sample requests, please view the documentation available in your environment at:
Versions and URI
This documentation is for version 2 of the Jira Align REST API, which is the latest version.
The URIs for resources have the following structure:
Version 1 of Jira Align REST API is still supported, but no additional resources will be added; all development is on version 2 of the API.
Bearer authentication using API tokens (tokens can be generated on the User Profile page of Jira Align) is supported.
Authorization is based on the authenticated user when Jira Align REST APIs are called. User privileges, such as data and page access, via the REST APIs are identical to privileges in the interface. For example, if a user's system role provides read-only access to epics in a single portfolio, the user will not be able to create or update epics with the API, and will only be able to read epics from the single portfolio.
To ensure our platform remains stable, all Jira Align APIs are rate-limited. Currently, if calls from same IP address exceed 600 requests per 60 seconds, calls are blocked for 60 seconds. When this threshold is met and calls are blocked, you'll receive a '429 too many requests' error response. We ask developers to use industry-standard techniques for limiting calls, caching results, and re-trying requests responsibly.
Jira Aligns's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The Jira Align REST API uses JSON as its communication format, and the standard HTTP methods like
PATCH (see API descriptions below for which methods are available for each resource).
The objects listed below use the default Jira Align terminology:
|Object||Create (Post)||Read (Get)||Update (Put or Patch)|
|Release (Program Increment)||Yes||Yes||Yes|
|Value Streams (Process Flows)||No||Yes||No|
- Custom fields on objects are not yet supported for create and update methods