Backup management APIs troubleshooting

This page lists the most common issues that you may encounter when using the backup management APIs.

Create backup policy

Product license errors

1
2
  "errorCode": "139",
  "errorMessage": "The site is either not licensed or does not exist

Check your product license. These APIs won’t work for products on Free plans. Currently, we offer backup and restore functionalities to users who have either Standard, Premium, or Enterprise licenses. For more details on billing and licensing, see the support FAQs.

Backup policy already exists

1
2
  "errorCode": "127",
  "errorMessage": "Backup Policy already exists with orgId: {} cloudId: {} product: {PRODUCT}"

You already have a backup policy for the given set of cloudId and product.

• If you wish to create a new backup policy for another site, modify the cloudId field in the request.
• If you wish to create a new backup policy for another product within the same site, modify the product field in the request.
• If you do not have your backup policy ID, you can retrieve it by calling the Get all backup policies API and searching for the given combination of cloudId and product.
• If you wish to update an existing backup policy, make a request to the Update backup policy API instead.

Product not supported error

1
2
  "errorCode": "103",
  "errorMessage": "{PRODUCT} is not present in cloud site {}"

The given site doesn't have the given product (Jira or Confluence), so the request can't be processed.

• Modify the request by adding a product which exists on your site.

Get backup status

Invalid backup ID error

1
2
  "errorCode": "108",
  "errorMessage": "The backupId : {} is invalid or does not belong to operation Backup"

The backupId passed in the given request is either invalid or doesn't exist for this org. If you don't remember the exact value, you can fetch the list of all the backups available under this org for a given backup policy by calling the Get all backups API

Create restore

Restore already exists error

1
2
  "errorCode": "137",
  "errorMessage": "A restore request for this product already exists"

Check the status of the existing restores by passing a restoreId to the Get restore details API, or Get all restores if you don't remember the restoreId.

Validations not passed error

If you see validationStatus = WARNING in the response from the Create restore API:

1
2
{
  "validationStatus": "WARNING",
  "restoreId": {},
  "operations": [
      {
          "operationKey": "TDP_SHARD_CHECK",
          "name": "Operation",
          "status": "SUCCESS"
      },
      {
          "operationKey": "CONFLICTING_GROUP_CHECK",
          "name": "Conflicting group check",
          "status": "WARNING",
          "description": "Conflicting group check WARNING",
          "remediation": "Please resolve the conflicting groups, If wanted to continue please give consent for this operation",
          "url": "https://rps--validation-engine--file-storage.s3.amazonaws.com/Default_File_08733657-e8d0-451d-97........""
      },
      {
          "operationKey": "SITE_LICENSE_CHECK",
          "name": "Site license check",
          "status": "SUCCESS"
      },
      {
          "operationKey": "PRODUCT_LICENSE_CHECK",
          "name": "Product license check",
          "status": "SUCCESS"
      }
  ]
}

Call the Revalidate API by passing the failing check in this format for the checks that have failed validation:

1
2
{
  "restoreId": {},
  "consent": [
      {
          "name": "PREFLIGHT_CONFLICTING_SPACE_CHECK_CONSENT",
          "value": "true"
      },   
      {
          "name": "PREFLIGHT_DUPLICATE_GROUP_CHECK_CONSENT",
          "value": "true"
      },
      {
          "name": "PREFLIGHT_TDP_SHARD_CHECK_CONSENT",
          "value": "true"
      },
      {
          "name": "PREFLIGHT_CUSTOM_GROUP_CHECK_CONSENT",
          "value": "true/false"
      },
  ]
}

Get restore status

Invalid restore ID error

1
2
{
  "errorCode": "120",
  "errorMessage": "The restoreId : {} is invalid or does not belong to operation Restore"
}

The restoreId passed in the given request is either invalid or doesn't exist for this org. If you don't remember the exact value, you can retrieve the list of all the restores available under this org by calling the Get all restores API.

Create storage errors

Storage already exists error

1
2
{
  "errorCode": "128",
  "errorMessage": "Conflicting Storage name = {}"
}

The storage bucket name passed in the given request already exists within the system. Create a request using another bucket or fetch the details using the Get all storages API.

Incorrect storage data error

1
2
{
  "errorCode": "130",
  "errorMessage": "Incorrect principalTag = {} or roleIdentifier = {}"
}

Check if the values of the principalTag and roleIdentifier passed in the request are correct. You can fetch this from the Get supported regions for org API.

Unsupported region error code

1
2
{
  "errorCode": "133",
  "errorMessage": "Storage region = {} is not eligible for the org:{} and cloud: {}"
}

Check the list of supported regions using the Get supported regions for org API.

Storage validation exception

1
2
{
  "errorCode": "142",
  "errorMessage": "Validation failed for storage creation for bucketName = {} and basePath = {} and region = {}"
}

Validate if the bucketName, basePath, and region passed in the request are correct.

Get storage details errors

Storage details not found

1
2
{
  "errorCode": "129",
  "errorMessage": "Storage Details not found for storageId = {}"
}

The storageId passed in the request is either invalid or doesn't exist in the system. If you don't remember the storageId, you can fetch the list of all the storage in org using the Get all storages API.

Get post-operation report

Post-operation report not found

1
2
{
  "errorCode": "143",
  "errorMessage": "Post operation report not available for migration = {}"
}

The migrationId passed in the request is either invalid or doesn't exist in the system. You can revalidate and pass the migrationId for the report you're looking for.