This document describes the REST API and resources provided by JIRA. The REST APIs are for developers who want to integrate JIRA into their application and for administrators who want to script interactions with the JIRA server.
JIRA'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. Currently, the only supported reponse format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE (see API descriptions below for which methods are available for each resource).
Because the REST API is based on open standards, you can use any web development language to access the API.
URIs for JIRA's REST API resource have the following structure:
With context: http://host:port/context/rest/api-name/api-version/resource-name
Or without context: http://host:port/rest/api-name/api-version/resource-name
Currently, the are two api-names available 'api' and 'auth'. REST endpoints in the 'api' path allow you to access most of the information contained within an issue. The current api-version is 2.0.alpha1. REST endpoints in the 'auth' path allow you to access information related to authentication. The current api-version is 1.
Example with context: http://myhost.com:8080/jira/rest/api/2.0.alpha1/project/JRA
Example without context: http://myhost.com:8080/rest/api/2.0.alpha1/project/JRA
In order to minimise network traffic from the client perspective, our API uses a technique called expansion.
You can use the 'expand' query parameter to specify a comma-separated list of entities that you want expanded, identifying each entity by a given identifier. For example, the value "comments,worklogs" requests the expansion of entities for which the expand identifier is "comments" and worklogs".
To discover the identifiers for each entity, look at the 'expand' attribute in the parent object. In the JSON example below, the object declares widgets as being expandable.
Note: The 'expand' attribute should not be confused with the 'expand' query parameter which specifies which entities you want expanded.
You can use the dot notation to specify expansion of entities within another entity. For example "children.children" would expand the children and the children's children (because its expand identifier is children) and the child entities within the plugin.
All methods return accept and return JSON exclusively. Example:
{"expand":"widgets", "self":"http://www.example.com/jira/rest/api/resource/KEY-1", "widgets":{"widgets":[],"size":5}}This documents the current REST API provided by JIRA.
The Link Issue Resource provides functionality to manage issue links.
Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.
acceptable request representations:
{"linkType":"Duplicate","fromIssueKey":"HSP-1","toIssueKey":"MKY-1","comment":{"body":"Linked related issue!","visibility":{"type":"GROUP","value":"jira-users"}}}available response representations:
If issue linking is disabled or it failed to find one of the issues (issue might exist, but it is not visible for this user) or it failed to find the specified issue link type.
if the issue link was created successfully.
if the user does not have the link issue permission for the issue, which will be linked to another issue.
if it can't create the supplied comment. The response will contain an error message indicating why it failed to create the comment. No issue link will be created if it failed to create the comment.
if an error occurred when creating the issue link or the comment.
Issue attachments
| parameter | value | description |
|---|---|---|
issueKey | the issue that you want to add the attachments to |
Add one or more attachments to an issue.
This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides a MultiPartEntity that makes it simple to submit a multipart POST.
In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: nocheck with the request, otherwise it will be blocked.
available response representations:
Returned if successful.
Returned if the requested issue is not found, the user does not have permission to view it, or if the attachments exceeds the maximum configured attachment size.
Returned if attachments is disabled or if you don't have permission to add attachments to this issue.
| parameter | value | description |
|---|---|---|
id | a numeric Status id |
Returns a full representation of the Status having the given id.
available response representations:
Returned if the requested issue status is not found, or the user does not have permission to view it.
{"self":"http://localhost:8090/jira/rest/api/2.0/status/10000","description":"The issue is currently being worked on.","iconUrl":"http://localhost:8090/jira/images/icons/progress.gif","name":"In Progress"}Returns a full representation of a JIRA issue status in JSON format.
| parameter | value | description |
|---|---|---|
id | a String containing the priority id |
Returns an issue priority.
available response representations:
Returned if the issue priority does not exist or is not visible to the calling user.
{"self":"http://www.example.com/jira/rest/api/2.0/priority/3","statusColor":"#009900","description":"Major loss of function.","iconUrl":"http://www.example.com/jira/images/icons/priority_major.gif","name":"Major"}Returned if the issue priority exists and is visible by the calling user. Contains a full representation of the issue priority in JSON.
| parameter | value | description |
|---|---|---|
id | the attachment id |
Returns the meta-data for an attachment, including the URI of the actual attached file.
available response representations:
Returned if the attachment with the given id does not exist, or is not accessible by the calling user.
{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"created":"2011-04-29T12:16:16.948+1000","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"}Returns a JSON representation of the attachment meta-data. The representation does not contain the attachment itself, but contains a URI that can be used to download the actual attached file.
| parameter | value | description |
|---|---|---|
id | a String containing the work log id |
Returns a work log.
available response representations:
Returned if the work log with the given id does not exist or if the currently authenticated user does not have permission to view it.
{"self":"http://www.example.com/jira/rest/api/2.0/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"comment":"I did some work here.","visibility":{"type":"GROUP","value":"jira-developers"},"started":"2011-04-29T12:16:16.724+1000","minutesSpent":180}Returned if the work log with the given id exists and the currently authenticated user has permission to view it. The returned response contains a full representation of the work log in JSON format.
| parameter | value | description |
|---|---|---|
id | a String containing an issue type id |
Returns a full representation of the issue type that has the given id.
available response representations:
Returns general information about the current JIRA server.
available response representations:
{"baseUrl":"http://localhost:8080/jira","version":"4.2-SNAPSHOT","buildNumber":582,"buildDate":"2011-04-29T12:16:16.689+1000","serverTime":"2011-04-29T12:16:16.689+1000","scmInfo":"482389","buildPartnerName":"Example Partner Co.","serverTitle":"My Shiny New JIRA Server"}Returns a full representation of the server info in JSON format
| parameter | value | description |
|---|---|---|
id | the ID of the comment to request |
Returns a single issue comment.
| parameter | value | description |
|---|---|---|
render | Default: true | true if text fields should be rendered according to the renderer associated with them; false to return the raw, unrendered data |
available response representations:
Returned if the requested comment is not found, or the user does not have permission to view it.
{"self":"http://example.com:8080/jira/rest/api/2.0/comment/10000","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"created":"2011-04-29T12:16:16.884+1000","updated":"2011-04-29T12:16:16.884+1000","visibility":{"type":"ROLE","value":"Administrators"}}Returns a full representation of a JIRA comment in JSON format.
Resource for searches.
Searches for issues using JQL. If the JQL query is too large to be encoded as a query param you should instead POST to this resource.
| parameter | value | description |
|---|---|---|
jql | a JQL query string | |
startAt | the index of the first issue to return (0-based) | |
maxResults | the maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated. |
available response representations:
{"startAt":0,"maxResults":50,"total":1,"issues":[{"self":"http://www.example.com/jira/rest/api/2.0/jira/rest/api/2.0/issue/HSP-1","key":"HSP-1"}]}Returns a JSON representation of the search results.
Returned if there is a problem with the JQL query.
Performs a search using JQL.
acceptable request representations:
{"jql":"project = HSP","startAt":0,"maxResults":15}available response representations:
{"startAt":0,"maxResults":50,"total":1,"issues":[{"self":"http://www.example.com/jira/rest/api/2.0/jira/rest/api/2.0/issue/HSP-1","key":"HSP-1"}]}Returns a JSON representation of the search results.
Returned if there is a problem with the JQL query.
Implement a REST resource for acquiring a session cookie.
Login a user to JIRA.
acceptable request representations:
{"username":"fred","password":"freds_password"}available response representations:
{"session":{"name":"JSESSIONID","value":"12345678901234567890"},"loginInfo":{"failedLoginCount":10,"loginCount":127,"lastFailedLoginTime":"2011-04-29T12:16:15.813+1000","previousLoginTime":"2011-04-29T12:16:15.813+1000"}}The response contains an Atlassian-wide "session" portion containing the session ID that can used for further authenticated-requests. It also contains a JIRA-specific "loginInfo" section containing information about the current user's login details.
Returned if the login fails due to an invalid credentials.
Returned if the login is denied due to a CAPTCHA requirement, throtting, or any other reason. It's possible that the supplied credentials are valid, in this case.
Log the current user out of JIRA.
available response representations:
Get information about the current user. If the current user is anonymous they will get a permission denied error trying to access this resource. The response contains information about the current user. It will contain their username, login information, and a link to the User Resource for the user.
available response representations:
{"self":"http://www.example.com/jira/rest/api/2.0/user/fred","name":"fred","loginInfo":{"failedLoginCount":10,"loginCount":127,"lastFailedLoginTime":"2011-04-29T12:16:15.813+1000","previousLoginTime":"2011-04-29T12:16:15.813+1000"}}Rest resource to retrieve a list of issue link types.
Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.
available response representations:
Returned if issue linking is disabled.
{"issueLinkTypes":[{"id":1000,"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2.0//issueLinkType/1000"},{"id":1010,"name":"Blocks","inward":"Blocked by","outward":"Blocks","self":"http://www.example.com/jira/rest/api/2.0//issueLinkType/1010"}]}Returns a list of all available issue link types.
| parameter | value | description |
|---|---|---|
issueLinkTypeId |
Returns for a given issue link type id all information about this issue link type.
available response representations:
Returned if issue linking is disabled or no issue link type with the given id exists.
{"id":1000,"name":"Duplicate","inward":"Duplicated by","outward":"Duplicates","self":"http://www.example.com/jira/rest/api/2.0//issueLinkType/1000"}Returns the issue link type with the given id.
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.
available response representations:
[{"self":"http://www.example.com/jira/rest/api/2.0/project/EX","key":"EX","name":"Example"},{"self":"http://www.example.com/jira/rest/api/2.0/project/ABC","key":"ABC","name":"Alphabetical"}]Returns a list of projects for which the user has the BROWSE project permission.
Returned if an error occurs while retrieving the list of projects.
| parameter | value | description |
|---|---|---|
key | the project key |
Contains a full representation of a project in JSON format.
available response representations:
Returned if the project is not found, or the calling user does not have permission to view it.
{"self":"http://www.example.com/jira/rest/api/2.0/project/EX","key":"EX","description":"This project was created as an example for REST.","lead":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"components":[{"self":"http://www.example.com/jira/rest/api/2.0/component/COM-1","name":"Component 1","description":"This is a JIRA component"}],"url":"http://www.example.com/jira/browse/EX","versions":[],"name":"Example"}Returned if the project exists and the user has permission to view it. Contains a full representation of a project in JSON format.
Returns a user. This resource cannot be accessed anonymously.
| parameter | value | description |
|---|---|---|
username | the username |
available response representations:
Returned if the requested user is not found.
{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","emailAddress":"fred@example.com","avatarUrl":"http://example.com:8080/jira/secure/useravatar?size=large&ownerId=fred","displayName":"Fred F. User","groups":{"size":3,"items":[{"name":"jira-user"},{"name":"jira-admin"},{"name":"important"}]},"expand":"groups"}Returns a full representation of a JIRA user in JSON format.
Returned if the current user is not authenticated.
| parameter | value | description |
|---|---|---|
id | a String containing the resolution id |
Returns a resolution.
available response representations:
Returned if the resolution does not exist or the user does not have permission to view it.
{"self":"http://www.example.com/jira/rest/api/2.0/resolution/1","description":"A fix for this issue is checked into the tree and tested.","iconUrl":"http://www.example.com/jira/images/icons/status_resolved.gif","name":"Fixed"}Returned if the resolution exists and the user has permission to view it. Contains a full representation of the resolution in JSON format.
| parameter | value | description |
|---|---|---|
issueKey | the issue key to request (i.e. JRA-1330) |
Returns a full representation of the issue for the given issue key. An issue JSON consists of the issue key, a collection of fields, a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it (e.g. if wiki syntax is enabled for the description or comments).
The fields is the heart of the issue. Each field has the same basic shape:
"field-id" : { "name" : "field-name", "type" : "field-type", "value" : "field-value" }
For system fields, you'll notice that the field-id and the field-name are the same (e.g. "assignee" and "assignee"), while for custom fields they are different ("customfield_10000" and "Participants").
If a field has no value then the "value" key will not be present. For instance, if there is no assignee it would simply appear as:
"assignee" : { "name" : "assignee", "type" : "com.opensymphony.user.User" }
This indicates there is a field named assignee but it has no value.
available response representations:
Returned if the requested issue is not found, or the user does not have permission to view it.
{"expand":"html","self":"http://example.com:8080/jira/rest/api/2.0/issue/EX-1","key":"EX-1","fields":{"sub-tasks":{"name":"sub-tasks","type":"issuelinks","value":[{"issueKey":"EX-2","issue":"http://example.com:8080/jira/rest/api/2.0/issue/EX-2","type":{"name":"Sub-task","direction":"OUTBOUND"}}]},"timetracking":{"name":"timetracking","type":"timetracking","value":{"timeoriginalestimate":10,"timeestimate":3,"timespent":6}},"project":{"name":"project","type":"com.atlassian.jira.project.Project","value":{"self":"http://www.example.com/jira/rest/api/2.0/project/EX","key":"EX","name":"Example"}},"updated":{"name":"updated","type":"java.util.Date","value":1},"description":{"name":"description","type":"java.lang.String","value":"example bug report"},"links":{"name":"links","type":"issuelinks","value":[{"issueKey":"PRJ-2","issue":"http://example.com:8080/jira/rest/api/2.0/issue/PRJ-2","type":{"name":"Dependent","direction":"OUTBOUND","description":"depends on"}},{"issueKey":"PRJ-3","issue":"http://example.com:8080/jira/rest/api/2.0/issue/PRJ-3","type":{"name":"Dependent","direction":"INBOUND","description":"is depended by"}}]},"attachment":{"name":"attachment","type":"attachment","value":[{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"created":"2011-04-29T12:16:16.948+1000","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"}]},"watcher":{"name":"watcher","type":"watcher","value":{"self":"http://www.example.com/jira/rest/api/2.0/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"}]}},"comment":{"name":"comment","type":"java.lang.String","value":[{"self":"http://example.com:8080/jira/rest/api/2.0/comment/10000","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.","updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"created":"2011-04-29T12:16:16.884+1000","updated":"2011-04-29T12:16:16.884+1000","visibility":{"type":"ROLE","value":"Administrators"}}]},"worklog":{"name":"worklog","type":"worklog","value":[{"self":"http://www.example.com/jira/rest/api/2.0/worklog/10000","author":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"},"comment":"I did some work here.","visibility":{"type":"GROUP","value":"jira-developers"},"started":"2011-04-29T12:16:16.724+1000","minutesSpent":180}]}}}Returns a full representation of a JIRA issue in JSON format.
| parameter | value | description |
|---|---|---|
issueKey | the issue you want to transition |
Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
available response representations:
Returned if the requested issue is not found or the user does not have permission to view it.
{"731":{"name":"Close Issue","fields":[{"id":"resolution","required":true,"type":"com.atlassian.jira.issue.resolution.Resolution"}]}}Returns a full representation of the transitions possible for the specified issue and the fields required to perform the transition.
Perform a transition on an issue. The POST must contain a single JSON Object. It must have a "transition" string and a "fields" object. A "comment" is optional. The comment can be either a simple string or an object with a "body" and "role" or "group".
acceptable request representations:
{
"transition" : 2,
"fields" : { "resolution" : "Duplicate" },
"comment" : "We've already fixed this one."
}
{
"transition" : 3,
"fields" : { "assignee" : "fred", "priority" : "Critical" },
"comment" : { "body" : "This isn't fixed yet.", "group" : "jira-developers" }
}available response representations:
| parameter | value | description |
|---|---|---|
issueKey | the issue to view voting information for |
Remove your vote from an issue. (i.e. "unvote")
available response representations:
Cast your vote in favour of an issue.
available response representations:
A REST sub-resource representing the voters on the issue. This sub-resource is also used for voting and unvoting (via POST and DELETE).
available response representations:
Returned if the user cannot view the issue in question or voting is disabled.
{"self":"http://www.example.com/jira/rest/api/issue/MKY-1/votes","votes":24,"hasVoted":true,"voters":[{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"}]}Information about voting on the current issue.
| parameter | value | description |
|---|---|---|
issueKey | a String containing an issue key |
Returns the list of watchers for the issue with the given key.
available response representations:
Returned if the requested issue is not found, or the user does not have permission to view it.
{"self":"http://www.example.com/jira/rest/api/2.0/issue/EX-1/watchers","isWatching":false,"watchCount":1,"watchers":[{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User"}]}Returns the list of watchers for an issue.
Adds a user to an issue's watcher list.
acceptable request representations:
"fred"available response representations:
Returned if the watcher was added successfully.
Returned if either the issue or the user does not exist.
Returned if the calling user does not have permission to add the watcher to the issue's list of watchers.
Returned if there is a problem with the received user representation.
| parameter | value | description |
|---|---|---|
userName | a String containing the name of the user to remove from the watcher list | |
issueKey | a String containing an issue key |
Removes a user from an issue's watcher list.
available response representations:
| parameter | value | description |
|---|---|---|
id | a String containing the version id |
Returns a project version.
available response representations:
Returned if the version does not exist or the currently authenticated user does not have permission to view it.
{"self":"http://www.example.com/jira/rest/api/2.0/version/10000","description":"An excellent version","name":"New Version 1","archived":false,"released":true,"releaseDate":"2010-07-06T13:04:42.288+1000"}Returned if the version exists and the currently authenticated user has permission to view it. Contains a full representation of the version.
| parameter | value | description |
|---|---|---|
id | a String containing the component key |
Returns a project component.
available response representations:
Returned if there is no component with the given key, or if the calling user does not have permission to view the component.
{"self":"http://www.example.com/jira/rest/api/2.0/component/COM-1","name":"Component 1","description":"This is a JIRA component"}Returns a full JSON representation of a project component.