Documentation

Confluence REST Scopes

For more information about the Confluence 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
/download/attachments(/.*)

READN/AN/AN/A
/download/temp(/.*)

READN/AN/AN/A
/download/thumbnails(/.*)

READN/AN/AN/A
/images(/.*)

READN/AN/AN/A
/plugins/servlet/confluence/placeholder(/.*)

READN/AN/AN/A
/plugins/servlet/roadmap(/.*)

READN/AN/AN/A
/rest/api/content

READWRITEWRITEDELETE
/rest/api/contentbody

N/AREADN/AN/A
/rest/api/group

READN/AN/AN/A
/rest/api/longtask

READN/AN/AN/A
/rest/api/relation

READN/AWRITEDELETE
/rest/api/search

READN/AN/AN/A
/rest/api/settings

READWRITEWRITEDELETE
/rest/api/space

READWRITEWRITEDELETE
/rest/api/template

READWRITEWRITEDELETE
/rest/api/user

READN/AN/AN/A
/rest/api/user/watch

READWRITEN/ADELETE
/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
/rest/atlassian-connect/{version}/macro/app/.+

1latest

N/AN/AN/AWRITE
/rest/create-dialog/{version}/spaces

1.0latest

PrivateREADN/AN/AN/A
/rest/inlinetasks/{version}/task

1latest

PrivateN/AWRITEN/AN/A
/rest/jiraanywhere/{version}/jira/clientIds

1.0

PrivateN/AREADN/AN/A
/rest/jiraanywhere/{version}/jira/renderTable

1.0

PrivateN/AREADN/AN/A
/rest/masterdetail/{version}/detailssummary

1.0

PrivateREADN/AN/AN/A
/rest/mywork/{version}/action

1latest

PrivateN/AWRITEN/AN/A
/rest/mywork/{version}/notification

1latest

PrivateREADWRITEWRITEDELETE
/rest/mywork/{version}/status

1latest

PrivateREADN/AN/AN/A
/rest/mywork/{version}/task

1latest

PrivateREADWRITEWRITEDELETE
/rest/prototype/{version}/attachment

1latest

PrivateREADN/AN/AN/A
/rest/prototype/{version}/breadcrumb

1latest

PrivateREADN/AN/AN/A
/rest/prototype/{version}/buildInfo

1latest

PrivateREADN/AN/AN/A
/rest/prototype/{version}/content

1latest

PrivateREADWRITEN/ADELETE
/rest/prototype/{version}/label

1latest

PrivateREADWRITEN/ADELETE
/rest/prototype/{version}/search

1latest

PrivateREADN/AN/AN/A
/rest/prototype/{version}/space

1latest

PrivateREADN/AN/AN/A
/rest/prototype/{version}/user

1latest

PrivateREADN/AN/AN/A
/rest/searchv3/{version}/search

11.0latest

PrivateREADN/AN/AN/A