Analyze Backup

This endpoint starts the offline analysis of a completed backup. The analysis scans the backup without touching the running database and takes minutes for large backups; poll the GET endpoint until the state is completed or failed. Available for databases on a Pro plan or with the Production Pack; other databases get 404. Not available for RDB exports, backups over 200 GiB, HIPAA databases or regional databases, nor for a backup whose analysis is already pending or completed.

1 min read

post/redis/backup-analysis/{id}/{backupid}

Request example

curl --request POST \
  --url https://api.upstash.com/v2/redis/backup-analysis/{id}/{backupid} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/redis/backup-analysis/{id}/{backupid}"
headers = {
    "Authorization": "Basic <encoded-value>",
}

response = requests.request("POST", url, headers=headers)

print(response.text)

const response = await fetch('https://api.upstash.com/v2/redis/backup-analysis/{id}/{backupid}', {
  method: 'POST',
  headers: {
    'Authorization': 'Basic <encoded-value>'
  }
});

const data = await response.json();
console.log(data);

Response

{
  "analysis_state": "pending"
}

post/redis/backup-analysis/{id}/{backupid}

Authorization

Authorizationstringheaderrequired#

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#

The ID of the database

backupidstringrequired#

The ID of the backup

Responses

application/json

200

Analysis started

analysis_statestring#

Get Backup Analysis Create Backup