Resources

/rest/api/2//reindex
REST resource for starting/stopping/querying indexing.

Methods

POST

/rest/api/2//reindex?type
Kicks off a reindex. Need Admin permissions to perform this reindex.

request query parameters

Parameter Value description

Type string Case insensitive String indicating type of reindex.
If committed, then defaults to
BACKGROUND_PREFERRED
GET

Returns information on the system reindexes. If a reindex is currently taking

place then information about this reindex is returned. If there is no active index
task, then returns information about the latest reindex task run, otherwise simply
returns a string indicating that no reindex has taken place.

available response representations:

• application/json [expand]

/rest/api/2/application-properties
Methods

GET

/rest/api/2/application-properties?key&permissionLevel&keyFilter
Returns an application property.

request query parameters

parameter value Description

Key string a String containing the property key
Permission string when fetching a list specifies the permission level of all items
Level in the list see
{@linkcom.atlassian.jira.bc.admin.ApplicationPropertiesServi
ce.EditPermissionLevel}
keyFilter string when fetching a list allows the list to be filtered by the property's
start of key e.g. "jira.lf.*" whould fetch only those permissions that
are editable and whose keys start with "jira.lf.". This is a regex.
available response representations:

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

/rest/api/2/application-properties/{id}

resource-wide template parameters

Parameter value Description

Id string
Methods

PUT

Modify an application property via PUT. The "value" field present in the PUT
will override thee existing value.
acceptable request representations:

• */* [expand]
/rest/api/2/attachment/{id}

resource-wide template parameters

Parameter Value Description

Id string the id of the attachment to ddelete.
Methods

GET

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

DELETE

Remove an attachment from an issue.

/rest/api/2/attachment/meta
Methods

GET

Returns the meta informations for an attachments, specifically if they are

enabled and the maximum upload size allowed.
available response representations:

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

/rest/api/2/avatar/{type}/system

resource-wide template parameters

Parameter Value description

Type string the avatar type
Methods

GET

Returns all system avatars of the given type.

/rest/api/2/avatar/{type}/temporary

resource-wide template parameters

Parameter value Description

Type string the avatar type
Methods

POST

/rest/api/2/avatar/{type}/temporary?filename&size
Creates temporary avatar

request query parameters

Parameter Value description

Filename string name of file being uploaded
Size long size of file

/rest/api/2/avatar/{type}/temporaryCrop

resource-wide template parameters

parameter value description

type string the avatar type
Methods

POST

Updates the cropping instructions of the temporary avatar.

acceptable request representations:

• application/json [expand]

/rest/api/2/component

Methods

POST

Create a component via POST.

acceptable request representations:

• application/json [expand]

/rest/api/2/component/{id}

resource-wide template parameters

Parameter value description

Id string
Methods

DELETE

/rest/api/2/component/{id}?moveIssuesTo
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 removed from the related isues.

GET

Returns 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]

/rest/api/2/component/{id}/relatedIssueCounts

resource-wide template parameters

Parameter Value description

Id string a String containing the component id
Methods

GET

Returns counts of issues related to this component.

available response representations:

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

• 404 [expand]
/rest/api/2/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.
/rest/api/2/dashboard

The /dashboard resource.

Methods

GET

/rest/api/2/dashboard?filter&startAt&maxResults
Returns a list of all dashboards, optionally filtering them.

request query parameters

parameter value Description

filter string an optional filter that is applied to the list of dashboards. Valid
values include "favourite" for returning only favourite
dashboards, and "my" for returning dashboards that are owned
by the calling user.
startAt int the index of the first dashboard to return (0-based). must be 0
or a multiple of maxResults
maxResults int a hint as to the the maximum number of dashboards to return in
each call. Note that the JIRA server reserves the right to
impose a maxResults limit that is lower than the value that a
client provides, dues to lack or resources or any other
condition. When this happens, your results will be truncated.
Callers should always check the returned maxResults to
determine the value that is effectively being used.

/rest/api/2/dashboard/{id}
resource-wide template parameters

Parameter Value description

Id string the dashboard id
Methods

GET

Returns a single dashboard.

/rest/api/2/field
Methods

GET

Returns a list of all fields, both System and Custom

available response representations:

• 200 - application/json (List of field) [expand]

POST

Creates a custom field using a definition (object encapsulating custom field

data)

/rest/api/2/filter

Resource for searches.

Methods

POST

/rest/api/2/filter?expand
Creates a new filter, and returns newly created filter. Currently sets permissions
just using the users default sharing permissions

request query parameters

Parameter value Description

Expand string the parameters to expand
acceptable request representations:

• application/json [expand]]

/rest/api/2/filter/{id}

resource-wide template parameters

Parameter value Description

Id long The ID of the filter to delete.
Methods

GET

/rest/api/2/filter/{id}?expand
Returns a filter given an id

request query parameters

Parameter value Description

Expand string the parameters to expand
available response representations:

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

• 400 [expand]

PUT

/rest/api/2/filter/{id}?expand
Updates an existing filter, and returns its new value.

request query parameters

parameter value Description
expand string the parameters to expand
acceptable request representations:

•
application/json [expand]
DELETE

Delete a filter.
/rest/api/2/filter/{id}/columns

resource-wide template parameters

parameter value description

Id long id of the filter
Methods

GET

Returns the default columns for the given filter. Currently logged in user will be
used as the user making such request.

PUT

Sets the default columns or the given filter.

acceptable request representations:

•
application/x-www-form-urlencoded [expand]
DELETE

Resets the columns for the given filter such that the filter no longer has its own
column config.
/rest/api/2/filter/defaultShareScope

Methods

GET

Returns the default share scope of the logged-in user.

PUT

Sets the default share scope of the logged-in user. Available values are
GLOBAL and PRIVATE.
/rest/api/2/filter/favourite

Methods

GET

/rest/api/2/filter/favourite?expand
Returns the favourite filters of the logged-in user.

request query parameters

Parameter Value description

Expand string the parameters to expand
available response representations:

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

/rest/api/2/group

Methods

POST (experimental)

Creates a group by given group parameter Returns REST representation for the
requested group.
acceptable request representations:

•application/json [expand]
DELETE (experimental)

/rest/api/2/group?groupname&swapGroup
Deletes a group by given group parameter. Returns no content
request query parameters

parameter Value Description

groupname string a group to delete
swapGroup string a group to transfer visibility restrictions of the group that
is being deleted

GET

/rest/api/2/group?groupname&expand
Returns REST representation for the requested group. Allows to get list of
active users belonging to the specified group and its subgroups if "users"
expand option is provided. You can page through users list by using indexes in
expand param. For example to get users from index 10 to index 15 use
"users[10:15]" expand value. This will return 6 users (if there are at least 16
users in this group). Indexes are 0-based and inclusive.

request query parameters

parameter value Description

groupname string A name of requested group.
expand string List of fields to expand. Currently only available
expand is "users".

/rest/api/2/group/user
Methods

POST (experimental)

/rest/api/2/group/user?groupname
Adds given user to a group. Returns the current state of the group.
request query parameters

parameter Value description

groupname string A name of requested group.
acceptable request representations:

•application/json [expand]
DELETE (experimental)

/rest/api/2/group/user?groupname&username
Removes given user from a group. Returns no content

request query parameters

Parameter value Description

Groupname string A name of requested group.
Username string User to remove from a group

REST endpoint for searching groups in a group picker

/rest/api/2/groups/picker

Methods

GET

/rest/api/2/groups/picker?query&exclude&maxResults
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
exclude string
maxResults int
available response representations:
• 200 - application/json (groupsuggestions) [expand]

/rest/api/2/groupuserpicker

Methods

GET

/rest/api/2/groupuserpicker?query&maxResults&showAvatar
Returns a list of users and groups matching query with highlighting. This
resource cannot be accessed anonymously.
request query parameters

parameter value Description

query string A string used to search username, Name or e-mail address
maxResults int the maximum number of users to return (defaults to 50).
The maximum allowed value is 1000. If you specify a
value that is higher than this number, your search results
will be truncated.
showAvatar boolean
available response representations:

• application/json [expand]
/rest/api/2/issue

Methods

POST

Creates an issue or a sub-task from a JSON representation.

The fields that can be set on create, in either the fields parameter or the update
parameter can be determined using the /rest/api/2/issue/createmeta resource. If
a field is not configured to appear on the create screen, then it will not be in the
createmeta, and a field validation error will occur if it is submitted.

Creating a sub-task is similar to creating a regular issue, with two important

differences:
• the issueType field must correspond to a sub-task issue type (you can
use /issue/createmeta to discover sub-task issue types), and
• you must provide a parent field in the issue create request containing the
id or key of the parent issue.
acceptable request representations:

• application/json [expand]
available response representations:

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

• 400 [expand]

/rest/api/2/issue/bulk

Methods

POST

Creates issues or sub-tasks from a JSON representation.

Creates many issues in one bulk operation.

Creating a sub-task is similar to creating a regular issue. More details can be

found in createIssue section: {@link
IssueResource#createIssue(IssueUpdateBean)}}
acceptable request representations:
• application/json [expand]
• /rest/api/2/issue/{issueIdOrKey}
resource-wide template parameters

Parameter Value Description

issueIdOrKey string the issue id or key to update (i.e. JRA-
1330)
Methods
GET

/rest/api/2/issue/{issueIdOrKey}?fields&expand
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 param (which can be specified multiple times) gives a comma-
separated list of fields to include in the response. This can be used to retrieve a
subset of fields. A particular field can be excluded by prefixing it with a minus.
By default, all (*all) fields are returned in this get-issue resource. Note: the
default is different when doing a jql search -- the default there is just navigable
fields (*navigable).
• *all - include all fields
• *navigable - include just navigable fields
• summary,comment - include just the summary and comments
• -comment - include everything except comments (the default is *all for
get-issue)
• *all,-comment - include everything except comments
JIRA will attempt to identify the issue by the issueIdOrKey path parameter.
This can be an issue id, or an issue key. If the issue cannot be found via an exact
match, JIRA will also look for the issue in a case-insensitive way, or by looking
to see if the issue was moved. In either of these cases, the request will proceed
as normal (a 302 or other redirect will not be returned). The issue key contained
in the response will indicate the current value of issue's key.
request query parameters

parameter Value Description

fields string the list of fields to return for the issue. By default, all fields
are returned.
expand string
available response representations:

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

• 404 [expand]

DELETE

/rest/api/2/issue/{issueIdOrKey}?deleteSubtasks
Delete an issue. If the issue has subtasks you must set the parameter
deleteSubtasks=true to delete the issue. You cannot delete an issue without its
subtasks also being deleted.
request query parameters
parameter value Description
deleteSubtasks string a String of true or false indicating that any subtasks should
also be deleted. If the issue has no subtasks this parameter
is ignored. If the issue has subtasks and this parameter is
missing or false, then the issue will not be deleted and an
error will be returned.

PUT

Edits an issue from a JSON representation.

The issue can either be updated by setting explicit the field value(s) or by using
an operation to change the field value.

The fields that can be updated, in either the fields parameter or the update
parameter, can be determined using
the /rest/api/2/issue/{issueIdOrKey}/editmeta resource.
If a field is not configured to appear on the edit screen, then it will not be in the
editmeta, and a field validation error will occur if it is submitted.
Specifying a "field_id": field_value in the "fields" is a shorthand for a "set"
operation in the "update" section.
Field should appear either in "fields" or "update", not in both.
acceptable request representations:

• application/json [expand]
available response representations:

• 200 - application/json [expand]

• 400 [expand]

/rest/api/2/issue/{issueIdOrKey}/assignee

resource-wide template parameters

parameter value Description

issueIdOrKey string a String containing an issue
key
Methods

PUT

Assigns an issue to a user. You can use this resource to assign issues when the
user submitting the request has the assign permission but not the edit issue
permission. If the name is "-1" automatic assignee is used. A null name will
remove the assignee.
 acceptable request representations:

• application/json [expand]

/rest/api/2/issue/{issueIdOrKey}/comment

resource-wide template parameters

parameter value Description

issueIdOrKey string a string containing the issue id or key the comment
will be added to
Methods

GET

/rest/api/2/issue/{issueIdOrKey}/comment?expand
Returns all comments for an issue.
request query parameters

parameter value Description

expand string optional flags: renderedBody (provides body rendered
in HTML)

POST

/rest/api/2/issue/{issueIdOrKey}/comment?expand
Adds a new comment to an issue.

request query parameters

parameter value Description

expand string optional flags: renderedBody (provides body rendered in
HTML)
acceptable request representations:

• application/json [expand]
/rest/api/2/issue/{issueIdOrKey}/comment/{id}

resource-wide template parameters

parameter value Description

id string id of the comment to be deleted
issueIdOrKey string a string containing the issue id or key the comment
 belongs to
Methods

GET

/rest/api/2/issue/{issueIdOrKey}/comment/{id}?expand
Returns all comments for an issue.

request query parameters

parameter value Description

expand string optional flags: renderedBody (provides body rendered in
HTML)

PUT

/rest/api/2/issue/{issueIdOrKey}/comment/{id}?expand
Updates an existing comment using its JSON representation.
request query parameters

parameter value Description

expand string optional flags: renderedBody (provides body rendered in
HTML)
acceptable request representations:
•application/json [expand]
DELETE

Deletes an existing comment .

/rest/api/2/issue/{issueIdOrKey}/editmeta

resource-wide template parameters

parameter Value Description

issueIdOrKey string the issue whose edit meta data you want to
view
Methods

GET

Returns the meta data for editing an issue.

The fields in the editmeta correspond to the fields in the edit screen for the
issue. Fields not in the screen will not be in the editemeta.
/rest/api/2/issue/{issueIdOrKey}/notify

resource-wide template parameters

parameter Value Description

issueIdOrKey string a string containing the issue id or key the comment
will be added to
Methods

POST

Sends a notification (email) to the list or recipients defined in the request.

acceptable request representations:

• application/json [expand]

/rest/api/2/issue/{issueIdOrKey}/remotelink
resource-wide template parameters

Parameter value Description

issueIdOrKey string the issue to create the remote issue link
for
Methods

GET

/rest/api/2/issue/{issueIdOrKey}/remotelink?globalId
A REST sub-resource representing the remote issue links on the issue.
request query parameters

paramet valu Description

er e
globalId strin The id of the remote issue link to be returned. If null (not provided)
g all remote links for the issue are returned.
For a fullexplanation of Issue Link fields please refer
to https://developer.atlassian.com/display/JIRADEV/Fields+in+Re
mote+Issue+Links
POST
Creates or updates a remote issue link from a JSON representation. If a globalId
is provided and a remote issue link exists with that globalId, the remote issue
link is updated. Otherwise, the remote issue link is created.

acceptable request representations:

•application/json [expand]
DELETE

/rest/api/2/issue/{issueIdOrKey}/remotelink?globalId
Delete the remote issue link with the given global id on the issue.

request query parameters

Parameter value Description

globalId string the global id of the remote issue link

/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}

resource-wide template parameters

Parameter value Description

issueIdOrKey string the issue to create the remote issue link
for
linkId string the id of the remote issue link
Methods

GET

Get the remote issue link with the given id on the issue.

PUT

Updates a remote issue link from a JSON representation. Any fields not
provided are set to null.

DELETE

Delete the remote issue link with the given id on the issue.

/rest/api/2/issue/{issueIdOrKey}/transitions

resource-wide template parameters

parameter Value Description

issueIdOrKey string the issue you want to transition
Methods

GET

/rest/api/2/issue/{issueIdOrKey}/transitions?transitionId
Get a list of the transitions possible for this issue by the current user, along with
fields that are required and their types.

Fields will only be returned if expand=transitions.fields.

The fields in the metadata correspond to the fields in the transition screen for
that transition. Fields not in the screen will not be in the metadata.

request query parameters

Parameter value description

transitionId string

POST

Perform a transition on an issue. When performing the transition you can udate
or set other issue fields.
The fields that can be set on transtion, in either the fields parameter or the
update parameter can be determined using
the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields re
source. If a field is not configured to appear on the transition screen, then it will
not be in the transition metadata, and a field validation error will occur if it is
submitted.
/rest/api/2/issue/{issueIdOrKey}/votes

resource-wide template parameters

parameter value Description

issueIdOrKey string the issue to view voting information for
Methods

DELETE

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

POST

Cast your vote in favour of an issue.

GET
A REST sub-resource representing the voters on the issue.

/rest/api/2/issue/{issueIdOrKey}/watchers

resource-wide template parameters

parameter value Description

issueIdOrKey string a String containing an issue key.
Methods

GET

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

POST

Adds a user to an issue's watcher list.

DELETE

/rest/api/2/issue/{issueIdOrKey}/watchers?username
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. Must not be null.

/rest/api/2/issue/{issueIdOrKey}/worklog
resource-wide template parameters

Parameter Value description

issueIdOrKey string a string containing the issue id or key the worklog
will be added to
Methods

GET

Returns all work logs for an issue.

POST

/rest/api/2/issue/{issueIdOrKey}/worklog?adjustEstimate&newEstimate&r
educeBy
Adds a new worklog entry to an issue.
request query parameters

parameter value description

adjustEstimate string (optional) allows you to provide specific instructions to
update the remaining time estimate of the issue. Valid
values are

• "new" - sets the estimate to a specific value

• "leave"- leaves the estimate as is
• "manual" - specify a specific amount to increase
remaining estimate by
• "auto"- Default option. Will automatically adjust the
value based on the new timeSpent specified on the
worklog
newEstimate string (required when "new" is selected for adjustEstimate) the
new value for the remaining estimate field. e.g. "2d"
reduceBy string (required when "manual" is selected for adjustEstimate) the
amount to reduce the remaining estimate by e.g. "2d"
acceptable request representations:
/rest/api/2/issue/{issueIdOrKey}/worklog/{id}
resource-wide template parameters

parameter value Description

id string id of the worklog to be deleted
issueIdOrKey string a string containing the issue id or key the worklog
belongs to
Methods

GET

Returns a specific worklog.

PUT

/rest/api/2/issue/{issueIdOrKey}/worklog/{id}?adjustEstimate&newEstimat
e
Updates an existing worklog entry using its JSON representation.

request query parameters

parameter value Description

adjustEstimate string (optional) allows you to provide specific instructions to
 update the remaining time estimate of the issue. Valid values
are

• "new" - sets the estimate to a specific value

• "leave"- leaves the estimate as is
• "auto"- Default option. Will automatically adjust the
value based on the new timeSpent specified on the
worklog
newEstimate string (required when "new" is selected for adjustEstimate) the
new value for the remaining estimate field.
DELETE
/rest/api/2/issue/{issueIdOrKey}/worklog/{id}?adjustEstimate&newEstimat
e&increaseBy
Deletes an existing worklog entry .

request query parameters

parameter value Description

adjustEstimate string (optional) allows you to provide specific instructions to
update the remaining time estimate of the issue. Valid values
are
• "new" - sets the estimate to a specific value
• "leave"- leaves the estimate as is
• "manual" - specify a specific amount to increase
remaining estimate by
• "auto"- Default option. Will automatically adjust the
value based on the new timeSpent specified on the
worklog
newEstimate string (required when "new" is selected for adjustEstimate) the new
value for the remaining estimate field. e.g. "2d"
increaseBy string (required when "manual" is selected for adjustEstimate) the
amount to increase the remaining estimate by e.g. "2d"

/rest/api/2/issue/createmeta

Methods

GET

/rest/api/2/issue/createmeta?projectIds&projectKeys&issuetypeIds&issuet
ypeNames
Returns the meta data for creating issues. This includes the available projects,
issue types and fields, including field types and whether or not those fields are
required. Projects will not be returned if the user does not have permission to
create issues in that project.
The fields in the createmeta correspond to the fields in the create screen for the
project/issuetype. Fields not in the screen will not be in the createmeta.

Fields will only be returned if expand=projects.issuetypes.fields.

The results can be filtered by project and/or issue type, given by the query
params.

request query parameters

parameter value Description

projectIds string combined with the projectKeys param, lists the projects
with which to filter the results. If absent, all projects are
returned. This parameter can be specified multiple times,
and/or be a comma-separated list. Specifiying a project that
does not exist (or that you cannot create issues in) is not an
error, but it will not be in the results.
projectKeys string combined with the projectIds param, lists the projects with
which to filter the results. If null, all projects are returned.
This parameter can be specified multiple times, and/or be a
comma-separated list. Specifiying a project that does not
exist (or that you cannot create issues in) is not an error, but
it will not be in the results.
issuetypeIds string combinded with issuetypeNames, lists the issue types with
which to filter the results. If null, all issue types are
returned. This parameter can be specified multiple times,
and/or be a comma-separated list. Specifiying an issue type
that does not exist is not an error.
issuetypeNames string combinded with issuetypeIds, lists the issue types with
which to filter the results. If null, all issue types are
returned. This parameter can be specified multiple times,
but is NOT interpreted as a comma-separated list.
Specifiying an issue type that does not exist is not an error.

/rest/api/2/issue/{issueIdOrKey}/attachments

Issue attachments

resource-wide template parameters

parameter value description

issueIdOrKey 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.

The name of the multipart/form-data parameter that contains attachments must

be "file"

A simple example to upload a file called "myfile.txt" to issue REST-123:

curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: nocheck" -F

"file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments

/rest/api/2/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.
/rest/api/2/issueLink/{linkId}

resource-wide template parameters

parameter value description
linkId string the issue link id.
Methods

GET

Returns an issue link with the specified id.

DELETE

Deletes an issue link with the specified id. To be able to delete an issue link you
must be able to view both issues and must have the link issue permission for at
least one of the issues.

/rest/api/2/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.

POST

Create a new issue link type.

acceptable request representations:

• application/json [expand]
available response representations:

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

• 404 [expand]

/rest/api/2/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.
DELETE

Delete the specified issue link type.

PUT

Update the specified issue link type.

acceptable request representations:

• application/json [expand]

/rest/api/2/issuetype
Methods

GET

Returns a list of all issue types visible to the user

available response representations:

• 200 - application/json [expand]

/rest/api/2/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.

/rest/api/2/jql/autocompletedata

Resource for auto complete data for searches.

Methods

GET

Returns the auto complete data required for JQL searches.

/rest/api/2/licenseValidator
A REST endpoint to provide simple validation services for a JIRA license.
Typically used by the setup phase of the JIRA application. This will return an
object with a list of errors as key, value pairs.
Methods

POST

acceptable request representations:

• application/json [expand]
available response representations:

• application/json [expand]
/rest/api/2/mypermissions

Provide permission information for the current user.

Methods

GET

/rest/api/2/mypermissions?projectKey&projectId&issueKey&issueId
Returns all permissions in the system and whether the currently logged in user
has them. You can optionally provide a specific context to get permissions for
(projectKey OR projectId OR issueKey OR issueId)
• When no context supplied the project related permissions will return true
if the user has that permission in ANY project
• If a project context is provided, project related permissions will return
true if the user has the permissions in the specified project. For
permissions that are determined using issue data (e.g Current Assignee),
true will be returned if the user meets the permission criteria in ANY
issue in that project
• If an issue context is provided, it will return whether or not the user has
each permission in that specific issue
NB: The above means that for issue-level permissions (EDIT_ISSUE for
example), hasPermission may be true when no context is provided, or when a
project context is provided, but may be false for any given (or all) issues. This
would occur (for example) if Reporters were given the EDIT_ISSUE
permission. This is because any user could be a reporter, except in the context
of a concrete issue, where the reporter is known.

Global permissions will still be returned for all scopes.

request query parameters

parameter Value description

projectKey string - key of project to scope returned permissions
for.
projectId string - id of project to scope returned permissions for.
issueKey string - key of the issue to scope returned permissions
for.
issueId string - id of the issue to scope returned permissions
for.

/rest/api/2/mypreferences

Provide preferences of the currently logged in user.

Methods

GET

/rest/api/2/mypreferences?key
Returns preference of the currently logged in user. Preference key must be
provided as input parameter (key). The value is returned exactly as it is. If key
parameter is not provided or wrong - status code 404. If value is found - status
code 200.

request query parameters

parameter value Description

key string - key of the preference to be returned.
available response representations:

• application/json [expand]

PUT

/rest/api/2/mypreferences?key
Sets preference of the currently logged in user. Preference key must be provided
as input parameters (key). Value must be provided as post body. If key or value
parameter is not provided - status code 404. If preference is set - status code
204.

request query parameters

parameter value Description

key string - key of the preference to be set.
acceptable request representations:
• application/json [expand]
available response representations:
• application/json [expand]

DELETE
/rest/api/2/mypreferences?key
Removes preference of the currently logged in user. Preference key must be
provided as input parameters (key). If key parameter is not provided or wrong -
status code 404. If preference is unset - status code 204.
request query parameters

parameter value Description

key string - key of the preference to be removed.
available response representations:

• application/json [expand]

/rest/api/2/myself

Currently logged user resource

Methods

GET

Returns currently logged user. This resource cannot be accessed anonymously.

available response representations:

PUT

Modify currently logged user. The "value" fields present will override the
existing value. Fields skipped in request will not be changed. Only email and
display name can be change that way.

acceptable request representations:

• application/json [expand]

/rest/api/2/myself/password
Methods

PUT

Modify caller password.

acceptable request representations:

• application/json [expand]
/rest/api/2/password/policy

Methods
GET

/rest/api/2/password/policy?hasOldPassword
Returns user-friendly statements governing the system's password policy.

request query parameters

parameter value Description

hasOldPassword boolean whether or not the user will be required to enter
their current password. Use {@code false} (the
Default: false default) if this is a new user or if an
administrator is forcibly changing another user's
password.

/rest/api/2/password/policy/createUser
Methods

POST

acceptable request representations:

• application/json [expand]
available response representations:

• application/json [expand]

/rest/api/2/password/policy/updateUser
Methods

POST

acceptable request representations:

• application/json [expand]
available response representations:

• application/json [expand]

/rest/api/2/priority
Methods

GET

Returns a list of all issue priorities.

available response representations:
• 200 - application/json (list of priorities) [expand]
/rest/api/2/priority/{id}

resource-wide template parameters

Parameter value Description

Id string a String containing the priority id
Methods

GET

Returns an issue priority.

/rest/api/2/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.

/rest/api/2/project/{projectIdOrKey}
resource-wide template parameters

Parameter value Description

projectIdOrKey string the project id or project
key
Methods

GET

/rest/api/2/project/{projectIdOrKey}?expand
Contains a full representation of a project in JSON format.

All project keys associated with the project will only be returned
if expand=projectKeys.
request query parameters

Parameter value description

Expand string

/rest/api/2/project/{projectIdOrKey}/avatar
resource-wide template parameters
Parameter Value description
projectIdOrKey string
Methods

POST

Converts temporary avatar into a real avatar

acceptable request representations:

• application/json [expand]
PUT

acceptable request representations:

•application/json [expand]
available response representations:

• application/json [expand]

/rest/api/2/project/{projectIdOrKey}/avatar/{id}
resource-wide template parameters

parameter value description

Id long database id for avatar
projectIdOrKey string Project id or project
key
Methods

DELETE

Deletes avatar

/rest/api/2/project/{projectIdOrKey}/avatar/temporary

resource-wide template parameters

parameter value Description

projectIdOrKey string Project id or project key
Methods

POST

/rest/api/2/project/{projectIdOrKey}/avatar/temporary?filename&size
Creates temporary avatar
request query parameters

parameter value Description

filename string name of file being uploaded
size long size of file
POST

Creates temporary avatar using multipart. The response is sent back as JSON
stored in a textarea. This is because the client uses remote iframing to submit
avatars using multipart. So we must send them a valid HTML page back from
which the client parses the JSON.

/rest/api/2/project/{projectIdOrKey}/avatars

resource-wide template parameters

parameter Value Description

projectIdOrKey string project id or project
key
Methods

GET

Returns all avatars which are visible for the currently logged in user. The
avatars are grouped into system and custom.
/rest/api/2/project/{projectIdOrKey}/components

resource-wide template parameters

parameter value Description

projectIdOrKey string the project id or project key
Methods

GET

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

/rest/api/2/project/{projectIdOrKey}/statuses
resource-wide template parameters

parameter value description

projectIdOrKey string Project id or project key
Methods
GET

Get all issue types with valid status values for a project

/rest/api/2/project/{projectIdOrKey}/versions

resource-wide template parameters

parameter value description

projectIdOrKey string the project id or project key
Methods

GET

/rest/api/2/project/{projectIdOrKey}/versions?expand
Contains a full representation of a the specified project's versions.

request query parameters

parameter value description

expand string

/rest/api/2/project/{projectIdOrKey}/role

resource-wide template parameters

parameter value description

projectIdOrKey string the project id or project key
Methods

GET

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

/rest/api/2/project/{projectIdOrKey}/role/{id}

resource-wide template parameters

parameter value description

projectIdOrKey string the project id or project key
id long the project role id
projectIdOrKey string the project id or project key
Methods

GET
Details on a given project role.

PUT

Updates a project role to contain the sent actors.

POST

Add an actor to a project role.

DELETE

Remove actors from a project role.

/rest/api/2/projectvalidate/key

Methods

GET

/rest/api/2/projectvalidate/key?key
Validates a project key.
request query parameters

parameter value description

key string the project key
available response representations:

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

/rest/api/2/resolution
Methods

GET

Returns a list of all resolutions.

available response representations:

• 200 - application/json (list of resolutions) [expand]

/rest/api/2/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:

• 200 - application/json (resolution) [expand]
• 404 [expand]
/rest/api/2/screens/{screenId}/tabs/{tabId}/fields

resource-wide template parameters

parameter value description

screenId long id of screen
tabId long id of tab
Methods

POST

Adds field to the given tab

acceptable request representations:

• application/json [expand]
GET

Gets all fields for a given tab

/rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}

resource-wide template parameters

parameter value description

id string

screenId long id of screen

tabId long id of tab

Methods

DELETE

Removes field from given tab

/rest/api/2/screens/{screenId}/tabs

resource-wide template parameters

parameter value description

screenId long id of screen
Methods

GET

Returns a list of all tabs for the given screen

POST

Creates tab for given screen

acceptable request representations:

• application/json [expand]
/rest/api/2/screens/{screenId}/tabs/{tabId}

resource-wide template parameters

parameter value description

screenId long id of screen
tabId long id of tab
Methods

PUT

Renames tab on given screen

acceptable request representations:

•application/json [expand]
DELETE

Deletes tab to give screen

/rest/api/2/screens/{screenId}/tabs/{tabId}/move/{pos}

resource-wide template parameters

parameter value description

screenId long id of screen
tabId long id of tab
pos int position of tab
Methods

POST

Moves tab position

/rest/api/2/screens/{screenId}/availableFields
resource-wide template parameters

parameter value description

screenId long id of screen
Methods

GET

Gets available fields for screen. i.e ones that haven't already been added.
/rest/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move

resource-wide template parameters

parameter value description

id string

screenId long id of screen

tabId long id of tab

Methods

POST

Moves field on the given tab

/rest/api/2/screens/addToDefault/{fieldId}
resource-wide template parameters

parameter value description

fieldId string id of field / custom field
Methods

POST

Adds field or custom field to the default tab

/rest/api/2/search

Resource for searches.

Methods

GET

/rest/api/2/search?jql&startAt&maxResults&validateQuery&fields&expan
d
Searches for issues using JQL.
Sorting the jql parameter is a full JQL expression, and includes an ORDER
BY clause.
The fields param (which can be specified multiple times) gives a comma-
separated list of fields to include in the response. This can be used to retrieve a
subset of fields. A particular field can be excluded by prefixing it with a minus.
By default, only navigable (*navigable) fields are returned in this search
resource. Note: the default is different in the get-issue resource -- the default
there all fields (*all).
• *all - include all fields
• *navigable - include just navigable fields
• summary,comment - include just the summary and comments
• -description - include navigable fields except the description (the default
is *navigable for search)
• *all,-comment - include everything except comments
GET vs POST: If the JQL query is too large to be encoded as a query param
you should instead POST to this resource.

Expanding Issues in the Search Result: It is possible to expand the issues

returned by directly specifying the expansion on the expand parameter passed in
to this resources.
For instance, to expand the "changelog" for all the issues on the search result, it
is neccesary to specify "changelog" as one of the values to expand.

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.
validateQuery boolean whether to validate the JQL query

Default: true
Fields string the list of fields to return for each issue. By default, all
navigable fields are returned.
expand string A comma-separated list of the parameters to expand.
POST

Performs a search using JQL.

acceptable request representations:

• application/json (searchRequest) [expand]

/rest/api/2/securitylevel/{id}
resource-wide template parameters

parameter value description

Id string a String containing an issue security level id
Methods

GET

Returns a full representation of the security level that has the given id.

/rest/api/2/serverInfo

Methods

GET

/rest/api/2/serverInfo?doHealthCheck
Returns general information about the current JIRA server.

request query parameters

parameter value description

doHealthCheck boolean
available response representations:
 • 200 - application/json (serverInfo) [expand]
REST resource for changing the JIRA system settings

/rest/api/2/settings/baseUrl
Methods

PUT

Sets the base URL that is configured for this JIRA instance.

acceptable request representations:

• application/json [expand]

/rest/api/2/settings/columns

Methods

GET

Returns the default system columns for issue navigator. Admin permission will
be required.

PUT

Sets the default system columns for issue navigator. Admin permission will be
required.

acceptable request representations:

• application/x-www-form-urlencoded [expand]
/rest/api/2/status
Methods

GET

Returns a list of all statuses

/rest/api/2/status/{idOrName}

resource-wide template parameters

parameter value description

idOrName string a numeric Status id or a status name
Methods

GET
Returns a full representation of the Status having the given id or name.

/rest/api/2/statuscategory

Methods

GET

Returns a list of all status categories

/rest/api/2/statuscategory/{idOrKey}
resource-wide template parameters

parameter value description

idOrKey string a numeric StatusCategory id or a status category key
Methods

GET

Returns a full representation of the StatusCategory having the given id or key

/rest/api/2/user

Methods

GET

/rest/api/2/user?username&key
Returns a user. This resource cannot be accessed anonymously.

request query parameters

parameter value description

username string the username
Key string user key
PUT (experimental)

/rest/api/2/user?username&key
Modify user. The "value" fields present will override the existing value. Fields
skipped in request will not be changed.

request query parameters

parameter value description

username string the username
Key string user key
acceptable request representations:

•application/json [expand]
POST (experimental)

Create user. By default created user will not be notified with email. If password
field is not set then password will be randomly generated.
acceptable request representations:

•application/json [expand]
DELETE (experimental)

/rest/api/2/user?username&key
Removes user.

request query parameters

parameter value description

username string the username
Key string user key

/rest/api/2/user/assignable/multiProjectSearch

Methods

GET

/rest/api/2/user/assignable/multiProjectSearch?username&projectKeys&st
artAt&maxResults
Returns a list of users that match the search string and can be assigned issues for
all the given projects. This resource cannot be accessed anonymously.

request query parameters

parameter value description

username string the username

projectKeys string the keys of the projects we are finding assignable users for,
comma-separated
startAt int the index of the first user to return (0-based)

maxResults int the maximum number of users to return (defaults to 50). The
maximum allowed value is 1000. If you specify a value that is
higher than this number, your search results will be truncated.

/rest/api/2/user/assignable/search

Methods

GET

/rest/api/2/user/assignable/search?username&project&issueKey&startAt&
maxResults&actionDescriptorId
Returns a list of users that match the search string. This resource cannot be
accessed anonymously. Please note that this resource should be called with an
issue key when a list of assignable users is retrieved for editing. For create only
a project key should be supplied. The list of assignable users may be incorrect if
it's called with the project key for editing.
request query parameters

parameter value description

username string the username
Project string the key of the project we are finding assignable users for
issueKey string the issue key for the issue being edited we need to find
assignable users for.
startAt int the index of the first user to return (0-based)
maxResults int the maximum number of users to return (defaults to 50).
The maximum allowed value is 1000. If you specify a
value that is higher than this number, your search results
will be truncated.
actionDescriptorId int

/rest/api/2/user/avatar

Methods

POST

/rest/api/2/user/avatar?username
Converts temporary avatar into a real avatar
request query parameters

parameter value description

username string username
acceptable request representations:
• application/json [expand]
PUT

/rest/api/2/user/avatar?username
request query parameters

parameter value description

username string
acceptable request representations:

•application/json [expand]
available response representations:

• application/json [expand]

/rest/api/2/user/avatar/{id}
resource-wide template parameters

parameter value description

Id long database id for avatar
Methods

DELETE

/rest/api/2/user/avatar/{id}?username
Deletes avatar.

request query parameters

Parameter value description

Username string username

/rest/api/2/user/avatar/temporary
Methods

POST
/rest/api/2/user/avatar/temporary?username&filename&size
Creates temporary avatar. Creating a temporary avatar is part of a 3-step process
in uploading a new avatar for a user: upload, crop, confirm.

The following examples shows these three steps using curl. The cookies
(session) need to be preserved between requests, hence the use of -b and -c. The
id created in step 2 needs to be passed to step 3 (you can simply pass the whole
response of step 2 as the request of step 3).

curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-

check" \
-H "Content-Type: image/png" --data-binary @mynewavatar.png \

'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin&fil
ename=mynewavatar.png'

curl -b cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-

check" \
-H "Content-Type: application/json" --data '{"cropperWidth":
"65","cropperOffsetX": "10","cropperOffsetY": "16"}' \
-o tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin

curl -b cookiejar.txt -X PUT -u admin:admin -H "X-Atlassian-Token: no-

check" \
-H "Content-Type: application/json" --data-binary @tmpid.json \
http://localhost:8090/jira/rest/api/2/user/avatar?username=admin

request query parameters

parameter value description

username string username

filename string name of file being uploaded

Size long size of file

POST

/rest/api/2/user/avatar/temporary?username
Creates temporary avatar using multipart. The response is sent back as JSON
stored in a textarea. This is because the client uses remote iframing to submit
avatars using multipart. So we must send them a valid HTML page back from
which the client parses the JSON from.

Creating a temporary avatar is part of a 3-step process in uploading a new avatar

for a user: upload, crop, confirm. This endpoint allows you to use a multipart
upload instead of sending the image directly as the request body.

You *must* use "avatar" as the name of the upload parameter:

curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-

check" \
-F "avatar=@mynewavatar.png;type=image/png" \
'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'

request query parameters

parameter value description

username string Username

/rest/api/2/user/avatars

Methods

GET

/rest/api/2/user/avatars?username
Returns all avatars which are visible for the currently logged in user.

request query parameters

parameter value description

username string username
/rest/api/2/user/columns

Methods

GET

/rest/api/2/user/columns?username
Returns the default columns for the given user. Admin permission will be
required to get columns for a user other than the currently logged in user.

request query parameters

parameter value description

username string username

PUT

Sets the default columns for the given user. Admin permission will be required
to get columns for a user other than the currently logged in user.
acceptable request representations:

•application/x-www-form-urlencoded [expand]
DELETE

/rest/api/2/user/columns?username
Reset the default columns for the given user to the system default. Admin
permission will be required to get columns for a user other than the currently
logged in user.

request query parameters

parameter value description

username string username
available response representations:

/rest/api/2/user/password
Methods

PUT (experimental)

/rest/api/2/user/password?username&key
Modify user password.

request query parameters

parameter value description
username string the username
Key string user key
acceptable request representations:

• application/json [expand]
/rest/api/2/user/permission/search

Methods

GET

/rest/api/2/user/permission/search?username&permissions&issueKey&proj
ectKey&startAt&maxResults
Returns a list of active users that match the search string and have all specified
permissions for the project or issue.
This resource can be accessed by users with ADMINISTER_PROJECT
permission for the project or global ADMIN or SYSADMIN rights.
request query parameters

parameter value description

username string the username filter, list includes all users if unspecified

permissions string comma separated list of permissions for project or issue returned
users must have, see Permissions JavaDoc for the list of all
possible permissions.
issueKey string the issue key for the issue for which returned users have specified
permissions.
projectKey string the optional project key to search for users with if no issueKey is
supplied.
startAt int the index of the first user to return (0-based)

maxResults int the maximum number of users to return (defaults to 50). The
maximum allowed value is 1000. If you specify a value that is
higher than this number, your search results will be truncated.

/rest/api/2/user/picker
Methods

GET

/rest/api/2/user/picker?query&maxResults&showAvatar&exclude
 Returns a list of users matching query with highlighting. This resource cannot
be accessed anonymously.
request query parameters

parameter value description

Query string A string used to search username, Name or e-mail address
maxResults int the maximum number of users to return (defaults to 50). The
maximum allowed value is 1000. If you specify a value that is
higher than this number, your search results will be truncated.
showAvatar boolean
Exclude string

/rest/api/2/user/search

Methods

GET

/rest/api/2/user/search?username&startAt&maxResults&includeActive&in
cludeInactive
Returns a list of users that match the search string. This resource cannot be
accessed anonymously.

request query parameters

parameter value description

username string A query string used to search username, name or e-mail
address
startAt int the index of the first user to return (0-based)
maxResults int the maximum number of users to return (defaults to 50).
The maximum allowed value is 1000. If you specify a
value that is higher than this number, your search results
will be truncated.
includeActive boolean If true, then active users are included in the results (default
true)
includeInactive boolean If true, then inactive users are included in the results
(default false)

/rest/api/2/user/viewissue/search
Methods
GET

/rest/api/2/user/viewissue/search?username&issueKey&projectKey&startA
t&maxResults
Returns a list of active users that match the search string. This resource cannot
be accessed anonymously. Given an issue key this resource will provide a list of
users that match the search string and have the browse issue permission for the
issue provided.

request query parameters

parameter value description

username string the username filter, no users returned if left blank
issueKey string the issue key for the issue being edited we need to find viewable
users for.
projectKey string the optional project key to search for users with if no issueKey is
supplied.
startAt int the index of the first user to return (0-based)
maxResults int the maximum number of users to return (defaults to 50). The
maximum allowed value is 1000. If you specify a value that is
higher than this number, your search results will be truncated.

/rest/api/2/version

Methods

POST

Create a version via POST.

acceptable request representations:

• application/json [expand]

/rest/api/2/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]

/rest/api/2/version/{id}

resource-wide template parameters

parameter value description

Id string
Methods

DELETE

/rest/api/2/version/{id}?moveFixIssuesTo&moveAffectedIssuesTo
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.
GET

/rest/api/2/version/{id}?expand
Returns a project version.

request query parameters

parameter value description

expand string
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]
/rest/api/2/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.

/rest/api/2/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

/rest/api/2/workflow

REST resource for retrieving workflows.

Methods

GET

/rest/api/2/workflow?workflowName
Returns all workflows.
request query parameters
parameter value description
workflowName string

/rest/api/2/workflowscheme

Methods

POST

Create a new workflow scheme. The body contains a representation of the new
scheme. Values not passed are assumed to be set to their defaults.
/rest/api/2/workflowscheme/{id}

resource-wide template parameters

parameter value description

Id long the id of the scheme.
Methods

PUT

Update the passed workflow scheme. The body of the request is a representation
of the workflow scheme. Values not passed are assumed to indicate no change
for that field. The passed representation can have its updateDraftIfNeeded flag
set to true to indicate that the draft should be created and/or updated when the
actual scheme cannot be edited (e.g. when the scheme is being used by a
project). Values not appearing the body will not be touched.

acceptable request representations:

• application/json [expand]
GET

/rest/api/2/workflowscheme/{id}?returnDraftIfExists
Returns the requested workflow scheme to the caller.

request query parameters

parameter Value description

returnDraftIfExists boolean when true indicates that a scheme's draft, if it
exists, should be queried instead of the scheme
Default: false itself.
DELETE

Delete the passed workflow scheme.

/rest/api/2/workflowscheme/{id}/createdraft

resource-wide template parameters

parameter value description

id long the id of the parent scheme.
Methods

POST

Create a draft for the passed scheme. The draft will be a copy of the state of the
parent.

/rest/api/2/workflowscheme/{id}/default
resource-wide template parameters

Parameter value description

Id long the id of the scheme.
Methods

GET

/rest/api/2/workflowscheme/{id}/default?returnDraftIfExists
Return the default workflow from the passed workflow scheme.
request query parameters

parameter Value description

returnDraftIfExists boolean when true indicates that a scheme's draft, if it
exists, should be queried instead of the scheme
Default: false itself.
DELETE

/rest/api/2/workflowscheme/{id}/default?updateDraftIfNeeded
Remove the default workflow from the passed workflow scheme.

request query parameters

parameter value description

 updateDraftIfNeeded boolean when true will create and return a draft when the
workflow scheme cannot be edited (e.g. when it is
being used by a project).
PUT

Set the default workflow for the passed workflow scheme. The passed
representation can have its updateDraftIfNeeded flag set to true to indicate that
the draft should be created/updated when the actual scheme cannot be edited.
/rest/api/2/workflowscheme/{id}/draft

resource-wide template parameters

parameter value description

id long the id of the parent scheme.
Methods

GET

Returns the requested draft workflow scheme to the caller.

DELETE

Delete the passed draft workflow scheme.

PUT

Update a draft workflow scheme. The draft will created if necessary. The body
is a representation of the workflow scheme. Values not passed are assumed to
indicate no change for that field.

/rest/api/2/workflowscheme/{id}/draft/default

resource-wide template parameters

parameter value description

Id long the id of the parent scheme.
Methods

GET

Return the default workflow from the passed draft workflow scheme to the
caller.

DELETE

Remove the default workflow from the passed draft workflow scheme.
PUT

Set the default workflow for the passed draft workflow scheme.

acceptable request representations:

• application/json [expand]

/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}

resource-wide template parameters

Parameter value description

Id long the id of the parent scheme.
issueType string the issue type being set.
Methods

GET

Returns the issue type mapping for the passed draft workflow scheme.

DELETE

Remove the specified issue type mapping from the draft scheme.

PUT

Set the issue type mapping for the passed draft scheme. The passed
representation can have its updateDraftIfNeeded flag set to true to indicate that
the draft should be created/updated when the actual scheme cannot be edited.
acceptable request representations:

• application/json [expand]
/rest/api/2/workflowscheme/{id}/draft/workflow

resource-wide template parameters

Parameter value description

Id long the id of the parent scheme.
Methods

GET

/rest/api/2/workflowscheme/{id}/draft/workflow?workflowName
Returns the draft workflow mappings or requested mapping to the caller.
request query parameters

parameter value description

workflowName string the workflow mapping to return. Null can be passed to return
all mappings. Must be a valid workflow name.
DELETE

/rest/api/2/workflowscheme/{id}/draft/workflow?workflowName
Delete the passed workflow from the draft workflow scheme.
request query parameters

parameter value description

workflowName string the name of the workflow to delete.
PUT

/rest/api/2/workflowscheme/{id}/draft/workflow?workflowName
Update the draft scheme to include the passed mapping. The body is a
representation of the workflow mapping. Values not passed are assumed to
indicate no change for that field.

request query parameters

parameter value description

workflowName string the name of the workflow mapping to update.
acceptable request representations:

• application/json [expand]

/rest/api/2/workflowscheme/{id}/issuetype/{issueType}

resource-wide template parameters

parameter value description

id long the id of the scheme.
issueType string the issue type being set.
Methods

GET

/rest/api/2/workflowscheme/{id}/issuetype/{issueType}?returnDraftIfExists
Returns the issue type mapping for the passed workflow scheme.

request query parameters

parameter value description
returnDraftIfExists boolean when true indicates that a scheme's draft, if it
exists, should be queried instead of the scheme
Default: false itself.
DELETE

/rest/api/2/workflowscheme/{id}/issuetype/{issueType}?updateDraftIfNeede
d
Remove the specified issue type mapping from the scheme.

request query parameters

parameter value description

updateDraftIfNeeded boolean when true will create and return a draft when the
workflow scheme cannot be edited (e.g. when it is
being used by a project).

PUT

Set the issue type mapping for the passed scheme. The passed representation
can have its updateDraftIfNeeded flag set to true to indicate that the draft should
be created/updated when the actual scheme cannot be edited.

acceptable request representations:

• application/json [expand]
/rest/api/2/workflowscheme/{id}/workflow
resource-wide template parameters

parameter value description

id long the id of the scheme.

Methods

GET

/rest/api/2/workflowscheme/{id}/workflow?workflowName&returnDraftIf
Exists
Returns the workflow mappings or requested mapping to the caller for the
passed scheme.
request query parameters
parameter value description
workflowName string the workflow mapping to return. Null can be
passed to return all mappings. Must be a valid
workflow name.
returnDraftIfExists boolean when true indicates that a scheme's draft, if it
exists, should be queried instead of the scheme
Default: false itself.
DELETE

/rest/api/2/workflowscheme/{id}/workflow?workflowName&updateDraftIf
Needed
Delete the passed workflow from the workflow scheme.

request query parameters

parameter value description

workflowName string the name of the workflow to delete.
updateDraftIfNeeded boolean flag to indicate if a draft should be created if
necessary to delete the workflow from the scheme.
PUT

/rest/api/2/workflowscheme/{id}/workflow?workflowName
Update the scheme to include the passed mapping. The body is a representation
of the workflow mapping. Values not passed are assumed to indicate no change
for that field. The passed representation can have its updateDraftIfNeeded flag
set to true to indicate that the draft should be created/updated when the actual
scheme cannot be edited.
request query parameters

parameter value description

workflowName string the name of the workflow mapping to update.
acceptable request representations:

• application/json [expand]
/rest/auth/1/session

Implement a REST resource for acquiring a session cookie.

Methods

GET
Returns information about the currently authenticated user's session. If the caller
is not authenticated they will get a 401 Unauthorized status code.

POST

Creates a new session for a user in JIRA. Once a session has been successfully
created it can be used to access any of JIRA's remote APIs and also the web UI
by passing the appropriate HTTP Cookie header.

Note that it is generally preferrable to use HTTP BASIC authentication with the
REST API. However, this resource may be used to mimic the behaviour of
JIRA's log-in page (e.g. to display log-in errors to a user).
acceptable request representations:

• application/json (credentials) [expand]

available response representations:

DELETE

Logs the current user out of JIRA, destroying the existing session, if any.

/rest/auth/1/websudo
Methods

DELETE

This method invalidates the any current WebSudo session.