Activate the backup policy in the org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredPolicy activated
1
2
3
curl --request PUT \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/policies/{policyId}/activate' \
--header 'Accept: application/json'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
{
"backups": [
{
"backupId": "<string>",
"name": "<string>",
"cloudId": "<string>",
"product": "JIRA",
"status": "CREATED",
"statusMessage": "<string>",
"accountId": "<string>",
"expiryTime": "<string>",
"selections": [
"USERS"
],
"backupSize": {
"usersSize": 2154,
"dataSize": 2154,
"attachmentsSize": 2154,
"totalBackupSizeInGB": 2154
},
"createdAt": "<string>",
"lastUpdatedAt": "<string>",
"storageId": "<string>",
"encryptionType": "<string>"
}
],
"totalItems": 2154
}Get Backup policy by policy Id in an org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredboolean
boolean
Backup policy retrieved
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/policies/{policyId}' \
--header 'Accept: application/json'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
{
"policyId": "<string>",
"policyName": "<string>",
"cloudInfo": {
"cloudId": "<string>",
"cloudUrl": "<string>",
"cloudName": "<string>",
"encryptionType": "CMK"
},
"productType": "JIRA",
"status": "ACTIVE",
"includeAttachments": true,
"includePersonalSpaces": true,
"includeUsersAndGroups": true,
"details": {
"storageId": "<string>",
"backupDetails": {
"lastBackupTime": "<string>",
"totalAvailableBackups": 2154
},
"scheduleDetails": {
"interval": "ONCE",
"startDate": "<string>",
"scheduleSlot": "<string>"
}
},
"createdAt": "<string>",
"createdBy": "<string>"
}Update Backup policy for a site in an org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
boolean
boolean
ScheduleBackupPolicyRequest
Backup policy updated
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/policies/{policyId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"storageId": "<string>",
"includeAttachments": true,
"includePersonalSpaces": true,
"scheduleRequest": {
"interval": "ONCE",
"startDate": "<string>"
}
}'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
{
"policyId": "<string>",
"policyName": "<string>",
"cloudInfo": {
"cloudId": "<string>",
"cloudUrl": "<string>",
"cloudName": "<string>",
"encryptionType": "CMK"
},
"productType": "JIRA",
"status": "ACTIVE",
"includeAttachments": true,
"includePersonalSpaces": true,
"includeUsersAndGroups": true,
"details": {
"storageId": "<string>",
"backupDetails": {
"lastBackupTime": "<string>",
"totalAvailableBackups": 2154
},
"scheduleDetails": {
"interval": "ONCE",
"startDate": "<string>",
"scheduleSlot": "<string>"
}
},
"createdAt": "<string>",
"createdBy": "<string>"
}Get all the storages in the organisation. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredStorage Details are retrieved
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/storages' \
--header 'Accept: */*'Creates a new storage for the specified organization. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
Requiredstring
RequiredStorage created successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request POST \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/storages' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"storageName": "<string>",
"storageRegion": "<string>",
"storagePrefix": "<string>",
"storageType": "<string>",
"roleIdentifier": "<string>",
"principalTag": "<string>",
"cloudId": "<string>"
}'1
2
3
{
"storageId": "<string>"
}Initiate import for the given orgId and cloudId. The import will be created in the background and the response will contain the importId.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
RequiredSuccessfully created import
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/imports' \
--header 'Accept: */*' \
--header 'Content-Type: application/json' \
--data '{
"cloudId": "<string>",
"product": "JIRA",
"backupId": "<string>"
}'Start restore operation for a specified backup into another site
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredboolean
Requiredboolean
Restore scheduled
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/cloud/{destCloudId}/restores' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"backupId": "<string>",
"product": "JIRA",
"includeAttachments": true,
"includeUsersAndGroups": true
}'1
2
3
4
5
6
7
{
"restoreId": "<string>",
"cloudId": "<string>",
"product": "JIRA",
"status": "READY",
"createdAt": "<string>"
}Revalidates and schedule restore. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredarray<Consent>
Restore revalidated and scheduled
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request POST \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/cloud/{cloudId}/restores/revalidate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"restoreId": "<string>",
"consent": [
{
"name": "PREFLIGHT_CONFLICTING_SPACE_CHECK_CONSENT",
"value": true
}
]
}'1
2
3
4
5
6
7
{
"restoreId": "<string>",
"cloudId": "<string>",
"product": "JIRA",
"status": "READY",
"createdAt": "<string>"
}Create a Backup policy for a product in a site in an org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
boolean
Requiredboolean
ScheduleBackupPolicyRequest
string
RequiredBackup policy created
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl --request POST \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/cloud/{cloudId}/policies' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"product": "JIRA",
"storageId": "<string>",
"includeAttachments": true,
"includePersonalSpaces": true,
"scheduleRequest": {
"interval": "ONCE",
"startDate": "<string>"
},
"policyName": "<string>"
}'1
2
3
4
{
"policyId": "<string>",
"policyName": "<string>"
}Get storage details for the given storage Id. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
RequiredStorage Details are retrieved
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/storages/{storageId}' \
--header 'Accept: */*'Get all the supported regions for given orgId, cloud and product. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
string
RequiredSupported regions fetched successfully
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/storages/regions' \
--header 'Accept: */*'Get all restores for a site. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
QueryParamFilter
RequiredRestores fetched
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/restores?queryParamFilter={queryParamFilter}' \
--header 'Accept: */*'Get restore status by restoreId. Requires authentication and proper permissions.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredRestore status fetched
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/restores/{restoreId}' \
--header 'Accept: */*'Get all Backup policies for an org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
QueryParamFilterForV2BackupPolicy
RequiredBackup policies retrieved
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/policies?queryParamFilterForV2BackupPolicy={queryParamFilterForV2BackupPolicy}' \
--header 'Accept: application/json'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
34
{
"policies": [
{
"policyId": "<string>",
"policyName": "<string>",
"cloudInfo": {
"cloudId": "<string>",
"cloudUrl": "<string>",
"cloudName": "<string>",
"encryptionType": "CMK"
},
"productType": "JIRA",
"status": "ACTIVE",
"includeAttachments": true,
"includePersonalSpaces": true,
"includeUsersAndGroups": true,
"details": {
"storageId": "<string>",
"backupDetails": {
"lastBackupTime": "<string>",
"totalAvailableBackups": 2154
},
"scheduleDetails": {
"interval": "ONCE",
"startDate": "<string>",
"scheduleSlot": "<string>"
}
},
"createdAt": "<string>",
"createdBy": "<string>"
}
],
"totalItems": 2154
}Get all Backups for a policy by policy id in an org
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
RequiredQueryParamFilter
RequiredBackups retrieved
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/policies/{policyId}/backups?queryParamFilter={queryParamFilter}' \
--header 'Accept: application/json'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
{
"backups": [
{
"backupId": "<string>",
"name": "<string>",
"cloudId": "<string>",
"product": "JIRA",
"status": "CREATED",
"statusMessage": "<string>",
"accountId": "<string>",
"expiryTime": "<string>",
"selections": [
"USERS"
],
"backupSize": {
"usersSize": 2154,
"dataSize": 2154,
"attachmentsSize": 2154,
"totalBackupSizeInGB": 2154
},
"createdAt": "<string>",
"lastUpdatedAt": "<string>",
"storageId": "<string>",
"encryptionType": "<string>"
}
],
"totalItems": 2154
}Get import details for specified importId and cloudId
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredRetrieved import details
1
2
3
curl --request GET \
--url 'https://api.atlassian.com/public/backup-management/v2/orgs/{orgId}/cloud/{cloudId}/imports/{importId}' \
--header 'Accept: application/json'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
{
"id": "<string>",
"name": "<string>",
"createdAt": "<string>",
"lastUpdatedAt": "<string>",
"status": "CREATED",
"source": {
"locationType": "CLOUD_URL",
"cloudInfo": {
"cloudId": "<string>",
"cloudUrl": "<string>",
"cloudName": "<string>",
"encryptionType": "CMK"
}
},
"productType": "JIRA",
"accountId": "<string>",
"expiryTime": "<string>",
"selections": [
"USERS"
],
"backupSize": {
"usersSize": 2154,
"dataSize": 2154,
"attachmentsSize": 2154,
"totalBackupSizeInGB": 2154
}
}Rate this page: