Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Cloud
Control REST API / Reference / REST API

Resources

Postman Collection
OpenAPI
GET

Get list of resources associated with a policyDeprecated

Scopes

OAuth 2.0 scopes required: read:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has succeeded.

application/json

Models.PolicyResourcePage
GET/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 { "data": [ { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" } ], "meta": { "next": "<string>", "page_size": 25 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>", "page_size": "<string>" } }
POST

Create a new policy resourceDeprecated

Add a new resource to a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Request bodyapplication/json

meta

Models.PolicyResourceMeta

links

Models.PolicyResourceLinks

id

string

Required

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResource
POST/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>" }'
202Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" }
DEL

Delete all policy resourcesDeprecated

Remove all resources from a policy.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

No content

DEL/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>'
PUT

Update single policy resource

Delete one resource from a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required
resourceId

string

Required

Request bodyapplication/json

meta

Models.PolicyResourceMeta

links

Models.PolicyResourceLinks

Responses

The request has been accepted for processing, but processing has not yet completed.

application/json

Models.PolicyResource
PUT/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request PUT \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" } }'
202Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "meta": { "scheduledDate": "<string>", "migrationStartDateTime": "<string>", "migrationEndDateTime": "<string>", "atlassianAccountId": "<string>" }, "links": { "ticket": "<string>" }, "id": "<string>", "applicationStatus": "validating" }
DEL

Delete single policy resource

Delete one resource from a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required
resourceId

string

Required

Responses

No content

DEL/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/admin/control/v1/orgs/{orgId}/policies/{policyId}/resources/{resourceId}' \ --header 'Authorization: Bearer <access_token>'
GET

Get list of resources associated with a policy V2

Scopes

OAuth 2.0 scopes required: read:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

The request has succeeded.

application/json

Models.PolicyResourcePageV2
GET/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 { "data": [ { "parentResourceId": "ari:cloud:jira::site/ee3c3183-3d6e-4077-8053-676d62c40929", "resourceId": "ari:cloud:jira::site/ee3c3183-3d6e-4077-8053-676d62c40929/project/10003", "resourceName": "Test project", "createdAt": "2024-04-06T02:46:56.707Z", "updatedAt": "2024-04-06T02:46:56.707Z", "resourceKey": "~62cf0218ec233f24684a01a1", "self": "https://beacon-staging.jira-dev.com/admin/private/rest/api/2/project/10000", "projectType": "service_desk", "applicationStatus": "applying", "type": "<string>", "resourceLogoUrls": { "default": "/images/logo/default-space-logo-256.png", "16x16": "https://beacon-staging.jira-dev.com/admin/private/rest/api/2/universal_avatar/view/type/project/avatar/10404?size=xsmall", "24x24": "https://beacon-staging.jira-dev.com/admin/private/rest/api/2/universal_avatar/view/type/project/avatar/10404?size=small", "32x32": "https://beacon-staging.jira-dev.com/admin/private/rest/api/2/universal_avatar/view/type/project/avatar/10404?size=medium", "48x48": "https://beacon-staging.jira-dev.com/admin/private/rest/api/2/universal_avatar/view/type/project/avatar/10404" } } ], "meta": { "next": "<string>", "page_size": 25 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>", "page_size": "<string>" } }
POST

Add or remove policy resources V2

Add or remove resources to a policy

Scopes

OAuth 2.0 scopes required: write:policies:admin

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Request bodyapplication/json

array<object>

operation

string

Required
resourceAri

string

Responses

The request has been accepted for processing, but processing has not yet completed.

POST/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>' \ --header 'Content-Type: application/json' \ --data '[ { "operation": "ADD", "resourceAri": "ari:cloud:platform::classification-tag/5aa92f75-aee6-473f-aa93-d17e705a31c8" } ]'
DEL

Delete all policy resources V2

Remove all resources from a policy.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

orgId

string

Required
policyId

string

Required

Responses

No content

DEL/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/admin/control/v2/orgs/{orgId}/policies/{policyId}/resources' \ --header 'Authorization: Bearer <access_token>'

Rate this page: