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": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>"
    }
  ],
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "backup_policy": {
    "id": "<string>",
    "name": "<string>",
    "target": "production",
    "retention_value": 123,
    "retention_unit": "<string>",
    "frequency_value": 123,
    "frequency_unit": "<string>",
    "schedule_time": "<string>",
    "schedule_day": 123,
    "schedule_week": 123,
    "created_at": "<string>",
    "updated_at": "<string>",
    "last_ran_at": "<string>",
    "next_run_at": "<string>",
    "required": true
  },
  "schema_snapshot": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "linted_at": "<string>",
    "url": "<string>"
  },
  "database_branch": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  }
}

Backups

Get a backup

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_backups

OAuth Scopes

Resource	Scopes
Organization	`read_backups`
Database	`read_backups`
Branch	`read_backups`

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": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "deleted_at": "<string>"
    }
  ],
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "backup_policy": {
    "id": "<string>",
    "name": "<string>",
    "target": "production",
    "retention_value": 123,
    "retention_unit": "<string>",
    "frequency_value": 123,
    "frequency_unit": "<string>",
    "schedule_time": "<string>",
    "schedule_day": 123,
    "schedule_week": 123,
    "created_at": "<string>",
    "updated_at": "<string>",
    "last_ran_at": "<string>",
    "next_run_at": "<string>",
    "required": true
  },
  "schema_snapshot": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "linted_at": "<string>",
    "url": "<string>"
  },
  "database_branch": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "deleted_at": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Path Parameters

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

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

integer

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

integer

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

Show child attributes

restored_branches.id

string

required

The ID for the resource

restored_branches.name

string

required

The name for the resource

restored_branches.created_at

string

required

When the resource was created

restored_branches.updated_at

string

required

When the resource was last updated

restored_branches.deleted_at

string

required

When the resource was deleted, if deleted

actor

object

required

Show child attributes

actor.id

string

required

The ID of the actor

actor.display_name

string

required

The name of the actor

actor.avatar_url

string

required

The URL of the actor's avatar

backup_policy

object

required

Show child attributes

backup_policy.id

string

required

The ID of the backup policy

backup_policy.name

string

required

The name of the backup policy

backup_policy.target

enum<string>

required

Whether the policy is for production or development branches

Available options:

production,

development

backup_policy.retention_value

integer

required

A number value for the retention period of the backup policy

backup_policy.retention_unit

string

required

The unit for the retention period of the backup policy

backup_policy.frequency_value

integer

required

A number value for the frequency of the backup policy

backup_policy.frequency_unit

string

required

The unit for the frequency of the backup policy

backup_policy.schedule_time

string

required

The time of day that the backup is scheduled, in HH:MM format

backup_policy.schedule_day

integer

required

Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday

backup_policy.schedule_week

integer

required

Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week

backup_policy.created_at

string

required

When the backup policy was created

backup_policy.updated_at

string

required

When the backup policy was last updated

backup_policy.last_ran_at

string

required

When the backup was last run

backup_policy.next_run_at

string

required

When the backup will next run

backup_policy.required

boolean

required

Whether the policy is a required system backup

schema_snapshot

object

required

Show child attributes

schema_snapshot.id

string

required

The ID of the schema snapshot

schema_snapshot.name

string

required

The name of the schema snapshot

schema_snapshot.created_at

string

required

When the schema snapshot was created

schema_snapshot.updated_at

string

required

When the schema snapshot was last updated

schema_snapshot.linted_at

string

required

When the schema snapshot was last linted

schema_snapshot.url

string

required

The URL to the schema snapshot in the PlanetScale app

database_branch

object

required

Show child attributes

database_branch.id

string

required

The ID for the resource

database_branch.name

string

required

The name for the resource

database_branch.created_at

string

required

When the resource was created

database_branch.updated_at

string

required

When the resource was last updated

database_branch.deleted_at

string

required

When the resource was deleted, if deleted

Create a backup

Delete a backup

⌘I

Introduction

Webhooks in PlanetScale

Authentication

General API endpoints

Postgres API endpoints

Vitess API endpoints

Get a backup

Authorization

Authorizations

Path Parameters

Response