GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
backups
/
{id}
Get a backup
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/backups/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "state": "pending",
  "size": 123,
  "estimated_storage_cost": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "started_at": "<string>",
  "expires_at": "<string>",
  "completed_at": "<string>",
  "deleted_at": "<string>",
  "pvc_size": 123,
  "protected": true,
  "required": true,
  "restored_branches": [
    {}
  ],
  "actor": {},
  "backup_policy": {},
  "schema_snapshot": {},
  "database_branch": {}
}

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The ID for the backup

organization
string
required

The name of the organization the branch belongs to

database
string
required

The name of the database the branch belongs to

branch
string
required

The name of the branch

Response

Returns a database branch backup

id
string
required

The ID of the backup

name
string
required

The name of the backup

state
enum<string>
required

The current state of the backup

Available options:
pending,
running,
success,
failed,
canceled,
ignored
size
number
required

The size of the backup in bytes

estimated_storage_cost
number
required

The estimated storage cost of the backup

created_at
string
required

When the backup was created

updated_at
string
required

When the backup was last updated

started_at
string
required

When the backup started

expires_at
string
required

When the backup expires

completed_at
string
required

When the backup completed

deleted_at
string
required

When the backup was deleted

pvc_size
number
required

Size of the PVC used for the backup

protected
boolean
required

Whether or not the backup is protected from deletion

required
boolean
required

Whether or not the backup policy is required

restored_branches
object[]
required
actor
object
required
backup_policy
object
required
schema_snapshot
object
required
database_branch
object
required