XAxataio
Projects

Get project backup by ID

Retrieves a backup by ID for the specified project.

get/organizations/{organizationID}/projects/{projectID}/backups/{backupID}

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: project:read

Path parameters

organizationIDstring required

Unique identifier of the organization containing the project

projectIDstring required

Unique identifier of the project to retrieve backups for

backupIDstring required

Unique identifier of the backup for the project

Response

The backup metadata

idstring required

unique identifier for the backup

branchIDstring required

ID of the branch that the backup belongs to

earliestRestorestring date-time

The earliest point in time that the branch can be restored to. It is absent until the first backup of the branch completes.

latestRestorestring date-time

The latest point in time that the branch is known to be restorable to. It is updated from the archived WAL at most every five minutes, so it can be several minutes behind the current time. It is absent until the first backup of the branch completes.

descriptionstring required

description of the backup

Changes

No recorded changes to this operation across all 68 revisions of this API.