Last updated Jun 26, 2025

Jira Software REST API scopes

About REST API scopes

Scopes provide static authorization for apps. Scopes are defined in the app descriptor and specify the maximum set of actions that an app may perform: read, write, etc. This security level is enforced by Atlassian Connect and cannot be bypassed by app implementations.

How to read scope reference

The required scope for your app depends on how you interact with the resources that are exposed by the REST API.

This page 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 under the path. This example shows how to read the table:

Example scope

PathGETPOSTPUTDELETE
/rest/atlassian-connect/{version}/license
1, latest
READN/AN/AN/A

A GET operation on /rest/atlassian-connect/1/license or /rest/atlassian-connect/latest/license requires your app to declare the READ scope. No other HTTP operations are supported.

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

Private APIs: Some APIs are marked as PRIVATE. As opposed to public APIs, private APIs don't follow the principles described in the Atlassian 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.

Rate this page: