v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Backups

Update 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 write_backups

OAuth Scopes

ResourceScopes
Organizationwrite_backups
Databasewrite_backups
Branchwrite_backups
patch/organizations/{organization}/databases/{database}/branches/{branch}/backups/{id}

Path parameters

idstring required

The ID of the backup

organizationstring required

The name of the organization the branch belongs to

databasestring required

The name of the database the branch belongs to

branchstring required

The name of the branch

Request body

protectedboolean

Whether the backup is protected from deletion or not

Response

Returns the backup

idstring required

The ID of the backup

namestring required

The name of the backup

state'pending' | 'running' | 'success' | 'failed' | 'canceled' | 'ignored' required

The current state of the backup

sizeinteger required

The size of the backup in bytes

estimated_storage_costnumber required

The estimated storage cost of the backup

created_atstring required

When the backup was created

updated_atstring required

When the backup was last updated

started_atstring nullable required

When the backup started

expires_atstring nullable required

When the backup expires

completed_atstring nullable required

When the backup completed

deleted_atstring nullable required

When the backup was deleted

pvc_sizeinteger required

Size of the PVC used for the backup

uncompressed_sizeinteger required

The uncompressed (logical) size of the backup in bytes

protectedboolean required

Whether or not the backup is protected from deletion

requiredboolean required

Whether or not the backup policy is required