We’re delighted to announce that JIRA Service Desk now has a public REST API. This complements the JIRA Software REST API that we released with JIRA Software last year. These new APIs make it easier to quickly build integrations and Atlassian Connect add-ons for JIRA Software and JIRA Service Desk.
The JIRA Service Desk REST API is currently an experimental release, and will eventually become a stable release. The JIRA Software REST API is a stable release already. See our REST API policy for more details. Check out both REST APIs below:
You’ll be happy to know that the JIRA Software REST API and JIRA Service Desk REST API have a range of resources for interacting with JIRA Software or JIRA Service Desk respectively. Although they don’t have everything, we think we’ve covered the main scenarios in this initial release. Here’s a few examples of what you can do with the new REST APIs:
- Get your JIRA Software add-on to retrieve the boards related to a project (
GET /rest/agile/1.0/board), then create a sprint in one of the boards (POST /rest/agile/1.0/sprint). - Build a custom JIRA Service Desk report, by getting all of the status (
GET /rest/servicedeskapi/request/{issueIdOrKey}/status) and SLA (GET /rest/servicedeskapi/request/{issueIdOrKey}/sla) information for customer requests. - Allow another application to create a customer request (
POST /rest/servicedeskapi/request) in a service desk. - Retrieve assets which have been pushed to JIRA by calling:
GET /rest/assetapi/asset/search?query=Macbook
You can find all of the reference information you need in the REST API documentation linked above. Both REST APIs use the new documentation theme which makes them easier to scan, with expandable sections for resources. We’ve also written a guide to exploring the JIRA Service Desk domain model via the REST API, which should be helpful to all Service Desk developers, new and old.
Happy integrating! If you need help with the new REST APIs, try posting a question on Atlassian Answers or log a ticket (JIRA Software or JIRA Service Desk).
Note, if you are currently using the private JIRA Agile REST resources, please read the following:
If you have an Atlassian Connect add-on — Be aware that the resources that are marked as private in the JIRA Software 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.
If you have a P2 add-on — Be aware that the private REST resources that were whitelisted, have now been deprecated. You can continue to use these resources, but we recommend that you migrate to the new public REST API. Note, feature parity does not exist between these private resources and public REST API, and we cannot promise that there will be feature parity in future.