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

Solution - 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 license. For more details on the billing and licensing part, see the support FAQs

Backup policy already exists

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

Solution - 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, kindly modify the product field in the request
• If you do not have your backup policy id, you can retrieve it by calling our 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 on our Update backup policy API instead

Product not supported error

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

Solution - The given site does not have the product(JIRA/CONFLUENCE) and hence a request cannot be initiated further.

• Modify the request by adding that product which exists for your site
• If you wish to purchase a product kindly browse through our Support page

Create backup errors

Invalid backup policy error

1
2
  "errorCode": "126",
  "errorMessage": "Backup policy not found, orgId = {}, policyId = {}"

Solution - Retrieve your backup policy id by calling our Get All Backup Policies API and searching for the given combination of cloudId and product

Backup already exists error

1
2
  "errorCode": "136",
  "errorMessage": "A backup request for this product already exists"

Solution - You can check the status of the existing backup by passing a backupId in Get Backup Details API, or Get all backups if you do not remember the backupId

Product license error

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

Solution - Follow the solution steps mentioned in first issue here

Get backup status

Invalid backup id error

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

Solution - The backupId passed in the given request is either invalid or does not exist for this org. If you do not remember the exact value, you can fetch the list of all the backups available under this org for a given backup policy by calling our Get all backups API

Create restore

Restore already exists error

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

Solution - You can check the status of the existing restores by passing a restoreId in Get restore details API, or Get all restores if you do not remember the restoreId

Validations not passed error

If you see validationStatus = WARNING in the response for Create restore API just like the below response snippet -

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"
      }
  ]
}

Solution - Call the Revalidate API by passing the failing check in this format -

1
2
{
  "restoreId": {},
  "consent": ["Consent_Conflicting_Group_Check"]
}

Get restore status

Invalid restore id error

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

Solution - The restoreId passed in the given request is either invalid or does not exist for this org. If you do not remember the exact value, you can retrieve the list of all the restores available under this org by calling our Get all restores API

Create storage errors

Storage already exists error

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

Solution: 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 Get all storages API

Incorrect storage data error

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

Solution: Check if the value of the principalTag and roleIdentifier passed in the request is 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: {}"
}

Solution : Check the list of supported regions using 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 = {}"
}

Solution: 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 = {}"
}

Solution: The storage Id passed in the request is either invalid or does not exist in the system. If you do not remember the storage Id, you can fetch the list of all the storage in org using our 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 = {}"
}

Solution: The migration Id passed in the request is either invalid or does not exist in the system. You can revalidate and pass the migration Id for the report you are looking for.