JIRA REST API documentation

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.

Structure of the REST URIs

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

How to use expansion in the REST APIs

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.

Resources

/api/2.0.alpha1/issueLink

The Link Issue Resource provides functionality to manage issue links.

Methods

POST

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:

  • application/json [expand]

    Example
    {"linkType":"Duplicate","fromIssueKey":"HSP-1","toIssueKey":"MKY-1","comment":{"body":"Linked related issue!","visibility":{"type":"GROUP","value":"jira-users"}}}

available response representations:

  • 404 [expand]

    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.

  • 200 - application/json [expand]

    if the issue link was created successfully.

  • 401 [expand]

    if the user does not have the link issue permission for the issue, which will be linked to another issue.

  • 400 [expand]

    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.

  • 500 [expand]

    if an error occurred when creating the issue link or the comment.

/api/2.0.alpha1/version

Methods

POST

Create a version via POST.

acceptable request representations:

  • application/json [expand]

    Example
    {"description":"An excellent version","name":"New Version 1","userReleaseDate":"5/Jul/2010","project":"PXA","releaseDate":"2010-07-05","released":true,"archived":false}

available response representations:

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 201 - application/json [expand]

    Example
    {"description":"An excellent version","name":"New Version 1","userReleaseDate":"5/Jul/2010","project":"PXA","releaseDate":"2010-07-05","released":true,"archived":false}

    Returned if the version is created successfully.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to edit the version.

/api/2.0.alpha1/version/{id}?moveFixIssuesTo&moveAffectedIssuesTo

resource-wide template parameters
parameter value description

id

string

Methods

DELETE

Delete a project version.

request query parameters
parameter value description

moveFixIssuesTo

string

The version to set fixVersion to on issues where the deleted version is the fix version, If null then the fixVersion is removed.

moveAffectedIssuesTo

string

The version to set affectedVersion to on issues where the deleted version is the affected version, If null then the affectedVersion is removed.

available response representations:

  • 204 [expand]

    Returned if the version is successfully deleted.

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to delete the version.

GET

Returns a project version.

request query parameters
parameter value description

expand

string

available response representations:

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 200 - application/json (project) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","id":10000,"description":"An excellent version","name":"New Version 1","overdue":true,"userReleaseDate":"5/Jul/2010","releaseDate":"2010-07-05","released":true,"archived":false}

    Returned if the version exists and the currently authenticated user has permission to view it. Contains a full representation of the version.

PUT

Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

acceptable request representations:

  • application/json [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","id":10000,"description":"An excellent version","name":"New Version 1","overdue":true,"userReleaseDate":"5/Jul/2010","releaseDate":"2010-07-05","released":true,"archived":false}

available response representations:

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 200 [expand]

    Returned if the version exists and the currently authenticated user has permission to edit it.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to edit the version.

/api/2.0.alpha1/version/{id}/relatedIssueCounts

resource-wide template parameters
parameter value description

id

string

a String containing the version id

Methods

GET

Returns a bean containing the number of fixed in and affected issues for the given version.

available response representations:

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 200 - application/json (issue Count Bean) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","issuesFixedCount":23,"issuesAffectedCount":101}

    Returned if the version exists and the currently authenticated user has permission to view it. Contains counts of issues fixed in and affecting this version.

/api/2.0.alpha1/version/{id}/unresolvedIssueCount

resource-wide template parameters
parameter value description

id

string

a String containing the version id

Methods

GET

Returns the number of unresolved issues for the given version

available response representations:

  • 404 [expand]

    Returned if the version does not exist or the currently authenticated user does not have permission to view it.

  • 200 - application/json (issuesUnresolvedCount) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","issuesUnresolvedCount":23}

    Returned if the version exists and the currently authenticated user has permission to view it. Contains counts of issues unresolved in this version.

/api/2.0.alpha1/version/{id}/move

resource-wide template parameters
parameter value description

id

string

a String containing the version id

Methods

POST

Modify a version's sequence within a project. The move version bean has 2 alternative field value pairs:

position
An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'
after
A version to place this version after. The value should be the self link of another version

acceptable request representations:

  • application/json [expand]

    Example
    {"after":"http://www.example.com/jira/rest/api/2.0/version/10000"}

available response representations:

  • 404 [expand]

    Returned if the version, or target of the version to move after does not exist or the currently authenticated user does not have permission to view it.

  • 200 - application/json (project version) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","id":10000,"description":"An excellent version","name":"New Version 1","overdue":true,"userReleaseDate":"5/Jul/2010","releaseDate":"2010-07-05","released":true,"archived":false}

    Returned if the version exists and the currently authenticated user has permission to view it. Contains a full representation of the version moved.

/api/2.0.alpha1/issue/{issueKey}/attachments

Issue attachments

resource-wide template parameters
parameter value description

issueKey

string

the issue that you want to add the attachments to

Methods

POST

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:

  • 204 [expand]

    Returned if successful.

  • 404 [expand]

    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.

  • 403 [expand]

    Returned if attachments is disabled or if you don't have permission to add attachments to this issue.

/api/2.0.alpha1/issueType/{id}

resource-wide template parameters
parameter value description

id

string

a String containing an issue type id

Methods

GET

Returns a full representation of the issue type that has the given id.

available response representations:

  • 404 [expand]

    Returned if the issue type does not exist, or is not visible to the calling user.

  • 200 - application/json (issueType) [expand]

    Returned if the issue type exists and is visible by the calling user.

/api/2.0.alpha1/issueLinkType

Rest resource to retrieve a list of issue link types.

Methods

GET

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:

  • 404 [expand]

    Returned if issue linking is disabled.

  • 200 - application/json (issueLinkTypes) [expand]

    Example
    {"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.

/api/2.0.alpha1/issueLinkType/{issueLinkTypeId}

resource-wide template parameters
parameter value description

issueLinkTypeId

string

Methods

GET

Returns for a given issue link type id all information about this issue link type.

available response representations:

  • 404 [expand]

    Returned if issue linking is disabled or no issue link type with the given id exists.

  • 200 - application/json (issueLinkType) [expand]

    Example
    {"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.

/api/2.0.alpha1/serverInfo

Methods

GET

Returns general information about the current JIRA server.

available response representations:

  • 200 - application/json (serverInfo) [expand]

    Example
    {"baseUrl":"http://localhost:8080/jira","version":"4.2-SNAPSHOT","buildNumber":582,"buildDate":"2011-11-02T06:13:25.426-0500","serverTime":"2011-11-02T06:13:25.426-0500","scmInfo":"482389","buildPartnerName":"Example Partner Co.","serverTitle":"My Shiny New JIRA Server"}

    Returns a full representation of the server info in JSON format

/api/2.0.alpha1/comment/{id}?render

resource-wide template parameters
parameter value description

id

string

the ID of the comment to request

Methods

GET

Returns a single issue comment.

request query parameters
parameter value description

render

boolean

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:

  • 404 [expand]

    Returned if the requested comment is not found, or the user does not have permission to view it.

  • 200 - application/json (comment) [expand]

    Example
    {"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","active":false},"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","active":false},"created":"2011-11-02T06:13:25.833-0500","updated":"2011-11-02T06:13:25.833-0500","visibility":{"type":"ROLE","value":"Administrators"}}

    Returns a full representation of a JIRA comment in JSON format.

/auth/1/websudo

Methods

DELETE

available response representations:

/api/2.0.alpha1/priority/{id}

resource-wide template parameters
parameter value description

id

string

a String containing the priority id

Methods

GET

Returns an issue priority.

available response representations:

  • 404 [expand]

    Returned if the issue priority does not exist or is not visible to the calling user.

  • 200 - application/json (issuePriority) [expand]

    Example
    {"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.

/api/2.0.alpha1/project

Methods

GET

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:

  • 200 - application/json (projects) [expand]

    Example
    [{"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.

  • 500 [expand]

    Returned if an error occurs while retrieving the list of projects.

/api/2.0.alpha1/project/{key}

resource-wide template parameters
parameter value description

key

string

the project key

Methods

GET

Contains a full representation of a project in JSON format.

available response representations:

  • 404 [expand]

    Returned if the project is not found, or the calling user does not have permission to view it.

  • 200 - application/json (project) [expand]

    Example
    {"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","active":false},"components":[{"self":"http://www.example.com/jira/rest/api/2.0/component/10000","id":10000,"name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}],"url":"http://www.example.com/jira/browse/EX","assigneeType":"PROJECT_LEAD","versions":[],"name":"Example","roles":{"Developers":"http://www.example.com/jira/rest/api/2.0/project/EX/role/10000"}}

    Returned if the project exists and the user has permission to view it. Contains a full representation of a project in JSON format.

/api/2.0.alpha1/project/{key}/versions?expand

resource-wide template parameters
parameter value description

key

string

the project key

Methods

GET

Contains a full representation of a the specified project's versions.

request query parameters
parameter value description

expand

string

available response representations:

  • 404 [expand]

    Returned if the project is not found, or the calling user does not have permission to view it.

  • 200 - application/json (versions) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/version/10000","id":10000,"description":"An excellent version","name":"New Version 1","overdue":true,"userReleaseDate":"5/Jul/2010","releaseDate":"2010-07-05","released":true,"archived":false}

    Returned if the project exists and the user has permission to view its versions. Contains a full representation of the project's versions in JSON format.

/api/2.0.alpha1/project/{key}/components

resource-wide template parameters
parameter value description

key

string

the project key

Methods

GET

Contains a full representation of a the specified project's components.

available response representations:

  • 404 [expand]

    Returned if the project is not found, or the calling user does not have permission to view it.

  • 200 - application/json (components) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/component/10000","id":10000,"name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}

    Returned if the project exists and the user has permission to view its components. Contains a full representation of the project's components in JSON format.

/api/2.0.alpha1/component

Methods

POST

Create a component via POST. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.

acceptable request representations:

  • application/json [expand]

    Example
    {"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false,"project":"PXA"}

available response representations:

  • 404 [expand]

    Returned if the component does not exist or the currently authenticated user does not have permission to view it.

  • 201 - application/json [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/component/10000","id":10000,"name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}

    Returned if the component is created successfully.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to edit the component.

/api/2.0.alpha1/component/{id}?moveIssuesTo

resource-wide template parameters
parameter value description

id

string

Methods

DELETE

Delete a project component.

request query parameters
parameter value description

moveIssuesTo

string

The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply deleted.

available response representations:

  • 204 [expand]

    Returned if the component is successfully deleted.

  • 404 [expand]

    Returned if the component does not exist or the currently authenticated user does not have permission to view it.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to delete the component.

GET

Returns a project component.

available response representations:

  • 404 [expand]

    Returned if there is no component with the given key, or if the calling user does not have permission to view the component.

  • 200 - application/json (component) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/component/10000","id":10000,"name":"Component 1","description":"This is a JIRA component","lead":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"assigneeType":"PROJECT_LEAD","assignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"realAssigneeType":"PROJECT_LEAD","realAssignee":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"isAssigneeTypeValid":false}

    Returns a full JSON representation of a project component.

PUT

Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored. If leadUserName is an empty string ("") the component lead will be removed.

acceptable request representations:

  • application/json [expand]

    Example
    {"name":"Component 1","description":"This is a JIRA component","leadUserName":"fred","assigneeType":"PROJECT_LEAD","isAssigneeTypeValid":false}

available response representations:

  • 404 [expand]

    Returned if the component does not exist or the currently authenticated user does not have permission to view it.

  • 200 [expand]

    Returned if the component exists and the currently authenticated user has permission to edit it.

  • 403 [expand]

    Returned if the currently authenticated user does not have permission to edit the component.

/api/2.0.alpha1/component/{id}/relatedIssueCounts

resource-wide template parameters
parameter value description

id

string

a String containing the component id

Methods

GET

Returns a project component.

available response representations:

  • 404 [expand]

    Returned if the component does not exist or the currently authenticated user does not have permission to view it.

  • 200 - application/json (issue Count Bean) [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/component/10000","issueCount":23}

    Returned if the component exists and the currently authenticated user has permission to view it. Contains counts of issues fixed in and affecting this component.

/auth/1/session

Implement a REST resource for acquiring a session cookie.

Methods

POST

Login a user to JIRA.

acceptable request representations:

  • application/json [expand]

    Example
    {"username":"fred","password":"freds_password"}

available response representations:

  • 200 [expand]

    Example
    {"session":{"name":"JSESSIONID","value":"12345678901234567890"},"loginInfo":{"failedLoginCount":10,"loginCount":127,"lastFailedLoginTime":"2011-11-02T06:13:24.669-0500","previousLoginTime":"2011-11-02T06:13:24.669-0500"}}

    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.

  • 401 [expand]

    Returned if the login fails due to an invalid credentials.

  • 403 [expand]

    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.

GET

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:

  • 200 [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/user/fred","name":"fred","loginInfo":{"failedLoginCount":10,"loginCount":127,"lastFailedLoginTime":"2011-11-02T06:13:24.669-0500","previousLoginTime":"2011-11-02T06:13:24.669-0500"}}

DELETE

Log the current user out of JIRA.

available response representations:

  • 204 [expand]

    Returned if the user was successfully logged out.

  • 401 [expand]

    Returned if the user is not authenticated.

/api/2.0.alpha1/attachment/{id}

resource-wide template parameters
parameter value description

id

string

the attachment id

Methods

GET

Returns the meta-data for an attachment, including the URI of the actual attached file.

available response representations:

  • 404 [expand]

    Returned if the attachment with the given id does not exist, or is not accessible by the calling user.

  • 200 - application/json (attachment) [expand]

    Example
    {"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","active":false},"created":"2011-11-02T06:13:25.831-0500","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.

/api/2.0.alpha1/status/{id}

resource-wide template parameters
parameter value description

id

string

a numeric Status id

Methods

GET

Returns a full representation of the Status having the given id.

available response representations:

  • 404 [expand]

    Returned if the requested issue status is not found, or the user does not have permission to view it.

  • 200 - application/json (status) [expand]

    Example
    {"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.

/api/2.0.alpha1/user?username

Methods

GET

Returns a user. This resource cannot be accessed anonymously.

request query parameters
parameter value description

username

string

the username

available response representations:

  • 404 [expand]

    Returned if the requested user is not found.

  • 200 - application/json (user) [expand]

    Example
    {"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","active":true,"timeZone":"Australia/Sydney","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.

  • 401 [expand]

    Returned if the current user is not authenticated.

/api/2.0.alpha1/application-properties?key

Methods

GET

request query parameters
parameter value description

key

string

available response representations:

/api/2.0.alpha1/application-properties/{id}

resource-wide template parameters
parameter value description

id

string

Methods

PUT

acceptable request representations:

available response representations:

/api/2.0.alpha1/search?jql&startAt&maxResults

Resource for searches.

Methods

GET

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.

request query parameters
parameter value description

jql

string

a JQL query string

startAt

int

the index of the first issue to return (0-based)

maxResults

int

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:

  • 200 - application/json (searchResults) [expand]

    Example
    {"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.

  • 400 [expand]

    Returned if there is a problem with the JQL query.

POST

Performs a search using JQL.

acceptable request representations:

  • application/json (searchRequest) [expand]

    Example
    {"jql":"project = HSP","startAt":0,"maxResults":15}

available response representations:

  • 200 - application/json (searchResults) [expand]

    Example
    {"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.

  • 400 [expand]

    Returned if there is a problem with the JQL query.

/api/2.0.alpha1/worklog/{id}

resource-wide template parameters
parameter value description

id

string

a String containing the work log id

Methods

GET

Returns a work log.

available response representations:

  • 404 [expand]

    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.

  • 200 - application/json (worklog) [expand]

    Example
    {"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","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"GROUP","value":"jira-developers"},"started":"2011-11-02T06:13:25.504-0500","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.

/api/2.0.alpha1/project/{projectKey}/role

resource-wide template parameters
parameter value description

projectKey

string

the project key

Methods

GET

Contains a list of roles in this project with links to full details.

available response representations:

  • 404 [expand]

    Returned if the project is not found, or the calling user does not have permission to view it.

  • 200 - application/json [expand]

    Example
    {"Users":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10001","Administrators":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10002","Developers":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10000"}

    Returned if the project exists and the user has permission to view it. A maps of roles to URIs containing full details for that role.

/api/2.0.alpha1/project/{projectKey}/role/{id}

resource-wide template parameters
parameter value description

projectKey

string

the project key

id

long

the project role id

projectKey

string

the project key

Methods

GET

Details on a given project role.

available response representations:

  • 404 [expand]

    Returned if the project or role is not found, or the calling user does not have permission to view it.

  • 200 - application/json [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}

    Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.

PUT

Updates a project role to contain the sent actors.

acceptable request representations:

  • application/json [expand]

    Example
    { "user" : ["admin"] }
          { "group" : ["jira-developers"] }

available response representations:

  • 404 [expand]

    Returned if the actor could not be added to the project role

  • 200 - application/json [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}

    Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.

POST

Add an actor to a project role.

acceptable request representations:

  • application/json [expand]

    Example
    { "user" : ["admin"] }
          { "group" : ["jira-developers"] }

available response representations:

  • 404 [expand]

    Returned if the actor could not be added to the project role

  • 200 - application/json [expand]

    Example
    {"self":"http://www.example.com/jira/rest/api/2.0/project/MKY/role/10360","name":"Developers","id":10360,"description":"A project role that represents developers in a project","actors":[{"id":10240,"displayName":"jira-developers","type":"atlassian-group-role-actor","name":"jira-developers"}]}

    Returned if the project and role exists and the user has permission to view it. Contains the role name, description, and project actors.

DELETE

Remove actors from a project role.

available response representations:

  • 204 [expand]

    Returned if the actor was successfully removed from the project role.

  • 404 [expand]

    Returned if the project or role is not found, the calling user does not have permission to view it, or does not have permission to modify the actors in the project role.

REST endpoint for searching groups in a group picker

/api/2.0.alpha1/groups/picker?query

Methods

GET

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups. The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit" The groups will be unique and sorted.

request query parameters
parameter value description

query

string

a String to match groups agains

available response representations:

  • 200 - application/json (groupsuggestions) [expand]

    Returned even if no groups match the given substring

/api/2.0.alpha1/customFieldOption/{id}

resource-wide template parameters
parameter value description

id

string

a String containing an custom Field Option id

Methods

GET

Returns a full representation of the custom Field Option that has the given id.

available response representations:

  • 404 [expand]

    Returned if the custom Field Option does not exist, or is not visible to the calling user.

  • 200 - application/json (customFieldOption) [expand]

    Returned if the custom Field Option exists and is visible by the calling user.

/api/2.0.alpha1/resolution/{id}

resource-wide template parameters
parameter value description

id

string

a String containing the resolution id

Methods

GET

Returns a resolution.

available response representations:

  • 404 [expand]

    Returned if the resolution does not exist or the user does not have permission to view it.

  • 200 - application/json (resolution) [expand]

    Example
    {"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.

/api/2.0.alpha1/issue/{issueKey}

resource-wide template parameters
parameter value description

issueKey

string

the issue key to request (i.e. JRA-1330)

Methods

GET

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:

  • 404 [expand]

    Returned if the requested issue is not found, or the user does not have permission to view it.

  • 200 - application/json (issue) [expand]

    Example
    {"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","active":false},"created":"2011-11-02T06:13:25.831-0500","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","active":false}]}},"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","active":false},"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","active":false},"created":"2011-11-02T06:13:25.833-0500","updated":"2011-11-02T06:13:25.833-0500","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","active":false},"updateAuthor":{"self":"http://www.example.com/jira/rest/api/2.0/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"comment":"I did some work here.","visibility":{"type":"GROUP","value":"jira-developers"},"started":"2011-11-02T06:13:25.504-0500","minutesSpent":180}]}}}

    Returns a full representation of a JIRA issue in JSON format.

/api/2.0.alpha1/issue/{issueKey}/transitions

resource-wide template parameters
parameter value description

issueKey

string

the issue you want to transition

Methods

GET

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:

  • 404 [expand]

    Returned if the requested issue is not found or the user does not have permission to view it.

  • 200 - application/json [expand]

    Example
    {"731":{"name":"Close Issue","fields":[{"id":"resolution","required":true,"type":"com.atlassian.jira.issue.resolution.Resolution"}],"transitionDestination":"6"}}

    Returns a full representation of the transitions possible for the specified issue and the fields required to perform the transition.

POST

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:

  • application/json [expand]

    Example
    {
       "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:

  • 204 [expand]

    Nothing is returned on success.

  • 404 [expand]

    The issue does not exist or the user does not have permission to view it

  • 400 [expand]

    The request body failed to validate.

/api/2.0.alpha1/issue/{issueKey}/votes

resource-wide template parameters
parameter value description

issueKey

string

the issue to view voting information for

Methods

DELETE

Remove your vote from an issue. (i.e. "unvote")

available response representations:

  • 204 [expand]

    Nothing is returned on success.

  • 404 [expand]

    Returned if the user cannot remove a vote for any reason. (The user did not vote on the issue, the user is the reporter, voting is disabled, the issue does not exist, etc.)

POST

Cast your vote in favour of an issue.

available response representations:

  • 204 [expand]

    Nothing is returned on success.

  • 404 [expand]

    Returned if the user cannot vote for any reason. (The user is the reporter, the user does not have permission to vote, voting is disabled in the instance, the issue does not exist, etc.)

GET

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:

  • 404 [expand]

    Returned if the user cannot view the issue in question or voting is disabled.

  • 200 - application/json [expand]

    Example
    {"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","active":false}]}

    Information about voting on the current issue.

/api/2.0.alpha1/issue/{issueKey}/watchers

resource-wide template parameters
parameter value description

issueKey

string

a String containing an issue key

Methods

GET

Returns the list of watchers for the issue with the given key.

available response representations:

  • 404 [expand]

    Returned if the requested issue is not found, or the user does not have permission to view it.

  • 200 - application/json (watchers) [expand]

    Example
    {"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","active":false}]}

    Returns the list of watchers for an issue.

POST

Adds a user to an issue's watcher list.

acceptable request representations:

  • application/json [expand]

    Example
    "fred"

available response representations:

  • 204 [expand]

    Returned if the watcher was added successfully.

  • 404 [expand]

    Returned if either the issue or the user does not exist.

  • 401 [expand]

    Returned if the calling user does not have permission to add the watcher to the issue's list of watchers.

  • 400 [expand]

    Returned if there is a problem with the received user representation.

DELETE

Removes a user from an issue's watcher list.

request query parameters
parameter value description

username

string

a String containing the name of the user to remove from the watcher list

available response representations:

  • 204 [expand]

    Returned if the watcher was removed successfully.

  • 404 [expand]

    Returned if either the issue or the user does not exist.

  • 401 [expand]

    Returned if the calling user does not have permission to remove the watcher from the issue's list of watchers.