Documentation

JIRA REST Scopes

For more information about the JIRA REST APIs, please consult the documentation on developer.atlassian.com.

The required scope for your add-on depends on how you interact with the resources that are exposed by the REST API. The table below shows the required scope for GET, POST, PUT and DELETE operations on a resource path. REST resources are versioned by a path segment that varies with the version. The supported versions are listed below the path.

Some APIs below are marked as  Private. As opposed to public APIs, private APIs don't follow the principles described in the REST API Policy. While we strive to keep private APIs backward-compatible, we cannot guarantee compatibility. Private APIs can also be replaced by new public APIs and may become deprecated over time.

Sub-resources are also available. For example, because  /rest/api/2/issue  is available,  /rest/api/2/issue/{key}/comment  is also available.

Example

PathGETPOSTPUTDELETE
/rest/atlassian-connect/{version}/license

1latest

READN/AN/AN/A

The example above means that a GET operation on
  • /rest/atlassian-connect/1/license
  • /rest/atlassian-connect/latest/license

will require your add-on to declare the READ scope. The example also shows that this specific resource only supports GET, but no other HTTP verbs.

Resources and their Associated Scopes

PathGETPOSTPUTDELETE
/rest/api/{version}/attachment

2latest

READN/AN/ADELETE
/rest/api/{version}/auditing

2latest

READWRITEWRITEN/A
/rest/api/{version}/comment/.+/properties

2latest

READWRITEWRITEDELETE
/rest/api/{version}/component

2latest

READPROJECT_ADMINPROJECT_ADMINPROJECT_ADMIN
/rest/api/{version}/configuration

2latest

READN/AN/AN/A
/rest/api/{version}/configuration/timetracking

2latest

READADMINADMINADMIN
/rest/api/{version}/customFieldOption

2latest

READN/AN/AN/A
/rest/api/{version}/dashboard/.+/items/.+/properties

2latest

READWRITEWRITEDELETE
/rest/api/{version}/field$

2latest

READADMINN/AN/A
/rest/api/{version}/field/.*

2latest

NONENONENONENONE
/rest/api/{version}/filter

2latest

READWRITEWRITEDELETE
/rest/api/{version}/group

2latest

ADMINN/AN/AN/A
/rest/api/{version}/groups/picker

2latest

READN/AN/AN/A
/rest/api/{version}/issue

2latest

READWRITEWRITEDELETE
/rest/api/{version}/issueLink

2latest

READWRITEN/ADELETE
/rest/api/{version}/issueLinkType

2latest

READADMINADMINADMIN
/rest/api/{version}/issuesecurityschemes(/.*)?

2latest

PROJECT_ADMINN/AN/AN/A
/rest/api/{version}/issuetype

2latest

READADMINADMINADMIN
/rest/api/{version}/jql/autocompletedata

2latest

READN/AN/AN/A
/rest/api/{version}/mypermissions

2latest

READN/AN/AN/A
/rest/api/{version}/myself

2latest

READN/AN/AN/A
/rest/api/{version}/permissions/project

2latest

N/AREADN/AN/A
/rest/api/{version}/priority

2latest

READN/AN/AN/A
/rest/api/{version}/project

2latest

READPROJECT_ADMINPROJECT_ADMINPROJECT_ADMIN
/rest/api/{version}/project/.+/properties/.+

2latest

N/AN/AWRITEN/A
/rest/api/{version}/resolution

2latest

READN/AN/AN/A
/rest/api/{version}/role

2latest

ADMINN/AN/AN/A
/rest/api/{version}/screens(/.*)

2latest

ADMINADMINN/AN/A
/rest/api/{version}/search

2latest

READREADN/AN/A
/rest/api/{version}/serverInfo

2latest

READN/AN/AN/A
/rest/api/{version}/status

2latest

READN/AN/AN/A
/rest/api/{version}/statuscategory

2latest

READN/AN/AN/A
/rest/api/{version}/task

2latest

NONENONENONENONE
/rest/api/{version}/user

2latest

READN/AN/AN/A
/rest/api/{version}/user/picker

2latest

READN/AN/AN/A
/rest/api/{version}/user/properties

2latest

N/AN/AWRITEDELETE
/rest/api/{version}/version

2latest

READPROJECT_ADMINPROJECT_ADMINPROJECT_ADMIN
/rest/api/{version}/workflow

2latest

ADMINN/AN/AN/A
/rest/api/{version}/worklog

2latest

READN/AN/AN/A
/rest/api/{version}/worklog/list

2latest

N/AREADN/AN/A
/rest/applinks/{version}/entities

1.02.0latest

PrivateREADN/AN/AN/A
/rest/applinks/{version}/entitylink

1.02.0latest

PrivateADMINADMINADMINADMIN
/rest/applinks/{version}/entitylink/primary

1.02.0latest

PrivateADMINADMINADMINADMIN
/rest/applinks/{version}/manifest

1.02.0latest

PrivateADMINADMINADMINADMIN
/rest/applinks/{version}/type/entity

1.02.0latest

PrivateADMINADMINADMINADMIN
/rest/atlassian-connect/{version}/addons(/.*)

1latest

NONENONENONENONE
/rest/atlassian-connect/{version}/license

1latest

READN/AN/AN/A
/secure/attachment

READN/AN/AN/A
/secure/projectavatar

PrivateREADN/AN/AN/A
/secure/thumbnail

PrivateREADN/AN/AN/A
/secure/useravatar

PrivateREADN/AN/AN/A
/secure/viewavatar

PrivateREADN/AN/AN/A