JIRA REST Scopes

For more information about the JIRA REST APIs, please consult the documentation on developer.atlassian.com and check out the Product API Browser.

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

Path		GET	POST	PUT	DELETE
`/rest/atlassian-connect/{version}/license` 1latest		READ	N/A	N/A	N/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

Path		GET	POST	PUT	DELETE
`/rest/api/{version}/attachment` 22.0.alpha1latest		READ	N/A	N/A	DELETE
`/rest/api/{version}/auditing` 2latest		READ	WRITE	WRITE	N/A
`/rest/api/{version}/comment/.+/properties` 22.0.alpha1latest		READ	WRITE	WRITE	DELETE
`/rest/api/{version}/component` 22.0.alpha1latest		READ	PROJECT_ADMIN	PROJECT_ADMIN	PROJECT_ADMIN
`/rest/api/{version}/configuration` 2latest		READ	N/A	N/A	N/A
`/rest/api/{version}/customFieldOption` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/dashboard/.+/items/.+/properties` 22.0.alpha1latest		READ	WRITE	WRITE	DELETE
`/rest/api/{version}/field` 22.0.alpha1latest		READ	ADMIN	N/A	N/A
`/rest/api/{version}/filter` 22.0.alpha1latest		READ	WRITE	WRITE	DELETE
`/rest/api/{version}/group` 22.0.alpha1latest		ADMIN	N/A	N/A	N/A
`/rest/api/{version}/groups/picker` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/issue` 22.0.alpha1latest		READ	WRITE	WRITE	DELETE
`/rest/api/{version}/issueLink` 22.0.alpha1latest		READ	WRITE	N/A	DELETE
`/rest/api/{version}/issueLinkType` 22.0.alpha1latest		READ	ADMIN	ADMIN	ADMIN
`/rest/api/{version}/issuetype` 22.0.alpha1latest		READ	ADMIN	ADMIN	ADMIN
`/rest/api/{version}/jql/autocompletedata` 2latest		READ	N/A	N/A	N/A
`/rest/api/{version}/mypermissions` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/myself` 2latest		READ	N/A	N/A	N/A
`/rest/api/{version}/priority` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/project` 22.0.alpha1latest		READ	PROJECT_ADMIN	PROJECT_ADMIN	PROJECT_ADMIN
`/rest/api/{version}/resolution` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/role` 2latest		ADMIN	N/A	N/A	N/A
`/rest/api/{version}/screens` 22.0.alpha1latest		ADMIN	ADMIN	N/A	N/A
`/rest/api/{version}/search` 22.0.alpha1latest		READ	READ	N/A	N/A
`/rest/api/{version}/serverInfo` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/status` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/statuscategory` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/user` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/user/picker` 22.0.alpha1latest		READ	N/A	N/A	N/A
`/rest/api/{version}/version` 22.0.alpha1latest		READ	PROJECT_ADMIN	PROJECT_ADMIN	PROJECT_ADMIN
`/rest/api/{version}/workflow` 2latest		ADMIN	N/A	N/A	N/A
`/rest/applinks/{version}/entities` 1.02.0latest	Private	READ	N/A	N/A	N/A
`/rest/applinks/{version}/entitylink` 1.02.0latest	Private	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/entitylink/primary` 1.02.0latest	Private	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/manifest` 1.02.0latest	Private	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/type/entity` 1.02.0latest	Private	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/atlassian-connect/{version}/addons` 1latest		READ	N/A	N/A	N/A
`/rest/atlassian-connect/{version}/license` 1latest		READ	N/A	N/A	N/A
`/secure/attachment`		READ	N/A	N/A	N/A
`/secure/projectavatar`	Private	READ	N/A	N/A	N/A
`/secure/thumbnail`	Private	READ	N/A	N/A	N/A
`/secure/useravatar`	Private	READ	N/A	N/A	N/A

Aug	SEP	Jan
	08
2014	2015	2018