Confluence REST Scopes

For more information about the Confluence 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.

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
`/download/attachments/.*`	READ	N/A	N/A	N/A
`/download/temp/.*`	READ	N/A	N/A	N/A
`/rest/api/content`	READ	WRITE	WRITE	DELETE
`/rest/api/contentbody`	N/A	READ	N/A	N/A
`/rest/api/space`	READ	N/A	N/A	N/A
`/rest/applinks/{version}/applicationlink` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/applicationlinkInfo` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/entities` 1.02.0latest	READ	N/A	N/A	N/A
`/rest/applinks/{version}/entitylink` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/entitylink/primary` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/listApplicationLinks` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/manifest` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/applinks/{version}/type/entity` 1.02.0latest	ADMIN	ADMIN	ADMIN	ADMIN
`/rest/atlassian-connect/{version}/license` 1latest	READ	N/A	N/A	N/A
`/rest/atlassian-connect/{version}/macro` 1latest	N/A	N/A	N/A	DELETE
`/rest/mywork/{version}/action` 1latest	N/A	WRITE	WRITE	DELETE
`/rest/mywork/{version}/notification` 1latest	READ	WRITE	WRITE	DELETE
`/rest/mywork/{version}/status` 1latest	READ	N/A	N/A	N/A
`/rest/mywork/{version}/task` 1latest	READ	WRITE	WRITE	DELETE
`/rest/prototype/{version}/attachment` 1latest	READ	N/A	N/A	N/A
`/rest/prototype/{version}/breadcrumb` 1latest	READ	N/A	N/A	N/A
`/rest/prototype/{version}/buildInfo` 1latest	READ	N/A	N/A	N/A
`/rest/prototype/{version}/content` 1latest	READ	WRITE	WRITE	DELETE
`/rest/prototype/{version}/label` 1latest	READ	WRITE	WRITE	DELETE
`/rest/prototype/{version}/search` 1latest	READ	N/A	N/A	N/A
`/rest/prototype/{version}/space` 1latest	READ	N/A	N/A	N/A
`/rest/prototype/{version}/user` 1latest	READ	N/A	N/A	N/A
`/rest/remoteplugintest/{version}/user` 1latest	READ	N/A	N/A	N/A
`/rest/searchv3/{version}/search` 11.0latest	READ	N/A	N/A	N/A
`/rest/ui/{version}/content` 11.0latest	READ	WRITE	WRITE	DELETE