The JIRA platform provides both Java APIs and REST APIs that you can use to interact with JIRA programmatically. These APIs are common to all JIRA applications.
In addition, JIRA Software has its own APIs for application-specific functionality. For example, the JIRA Software REST API has methods for creating sprints, creating boards, retrieving epics, etc. Currently, JIRA Service Desk (see JSD-107) and JIRA Core do not have their own APIs.
JIRA REST APIs
The JIRA REST APIs are used to interact with JIRA remotely, for example, when building Connect add-ons for JIRA Cloud or configuring webhooks. If you haven't used the JIRA REST APIs before, read this overview: JIRA REST APIs.
JIRA Platform REST APIs
JIRA Software REST APIs
To view the old private JIRA Software REST API (formerly the private JIRA Agile REST API), do either of the following:
- Use the REST API browser on jira.atlassian.com (you must uncheck the 'Show only public APIs' checkbox).
- Install the REST API browser on your own JIRA instance, see documentation (you must uncheck the 'Show only public APIs' checkbox when browsing).
However, please note the following regarding the private JIRA Software REST API:
- For Connect add-ons: Resources that are marked as private in JIRA Agile REST Scopes have been deprecated. These private resources will no longer be whitelisted on the 1st February 2016. You must migrate to the new public REST API before this date. Note, there is feature parity between the whitelisted private resources and the new public REST resources.
- For P2 add-ons: The private JIRA Software REST API will remain experimental and may break at any time. You can continue to use the private API, but we recommend that you migrate to the new public REST API. Note, feature parity does not exist between the private and public REST APIs, and we cannot promise that there will be feature parity in future.
Webhooks are user-defined callbacks over HTTP, which are specific to the JIRA REST API. JIRA webhooks allow the JIRA REST API to inform a remote application when changes have occurred, e.g. an issue transition. This saves the application from having to periodically poll JIRA (via the REST API). Learn more...
JIRA Java APIs
The JIRA Java APIs are typically used when building Plugins2 plugins (for JIRA Server). If you haven't used the JIRA Java APIs before, make sure you read the Java API Policy for JIRA.