How do I use REST API in Jira?

Jira versions earlier than 8.4 Creating an issue using the Jira REST API is as simple as making a POST with a JSON document. To create an issue, you will need to know certain key metadata, like the ID of the project that the issue will be created in, or the ID of the issue type.

What is REST API in Jira?

The Jira REST API enables you to interact with Jira programmatically. Use this API to build apps, script interactions with Jira, or develop any other type of integration. This page documents the REST resources available in Jira Cloud, including the HTTP response codes and example requests and responses.

How do I connect to API in Jira?

Integrating on the Atlassian platform

  1. Product integration: Use the REST APIs and webhooks. Authenticate using OAuth1 or Basic Authentication.
  2. Atlassian Connect: Use REST APIs and webhooks as well as surface information inside Jira using UI extension points.


The Jira Software and Jira Service Management applications have REST APIs for their application-specific features, like sprints (Jira Software) or customer requests (Jira Service Management). If you haven’t used the Jira REST APIs before, make sure you read the Atlassian REST API policy.

How does REST API work?

Step #1 – Enter the URL of the API in the textbox of the tool. Step #2 – Select the HTTP method used for this API (GET, POST, PATCH, etc). Step #3 – Enter any headers if they are required in the Headers textbox. Step #4 – Pass the request body of the API in a key-value pair.

What is REST API services?

A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. REST stands for representational state transfer and was created by computer scientist Roy Fielding.

Is Jira API free?

Some of them are free, other ones need to be purchased. Jira is available in two versions, a Cloud version and a Server (on-premise) version. 5 and version 2 of the Jira API.

How do I update a REST API in Jira?

The simple way to update an issue is to do a GET, update the values inside “fields”, and then PUT back.

  1. If you PUT back exactly what you GOT, then you are also sending “names”, “self”, “key”, etc.
  2. You do not need to send all the fields inside “fields”.
  3. Some fields cannot be updated this way (for example, comments).

Where is REST API used?

While REST – or Representational State Transfer – can be used over nearly any protocol, when used for web APIs it typically takes advantage of HTTP. This means that developers have no need to install additional software or libraries when creating a REST API.

Is the Atlassian REST API supported by Jira?

If you haven’t used the Jira REST APIs before, make sure you read the Atlassian REST API policy. The Jira Server platform REST API resources are also documented in this WADL file: jira-rest-plugin.wadl. Authentication . The following authentication methods are supported for the Jira REST APIs:

How are webhooks used in the Jira REST API?

Webhooks are user-defined callbacks over HTTP that are specific to the Jira REST API. Jira webhooks allow the Jira REST API to inform a remote application when changes have occurred, for example, an issue transition. This saves the application from having to periodically poll Jira (via the REST API).

What is the URI structure of a Jira REST API?

URI structure. Jira REST APIs provide access to resources (that is, data entities) via URI paths. To use a REST API, your application makes an HTTP request and parse the response. The Jira REST API uses JSON as its communication format and the standard HTTP methods like GET, PUT, POST, and DELETE.

How to set up basic authentication in Jira?

Basic authentication 1 Overview. Jira’s REST API is protected by the same restrictions that are provided via Jira’s standard web interface. 2 Before you begin. Terminal on Mac or Linux, Command Prompt on Windows. 3 Send a request. 4 Construct the authorization header. 5 Important considerations.