v17

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

Backups

Create 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

Resource	Scopes
Organization	write_backups
Database	write_backups
Branch	write_backups

post/organizations/{organization}/databases/{database}/branches/{branch}/backups

Path parameters

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

namestring

Name for the backup

retention_unit'hour' | 'day' | 'week' | 'month' | 'year'

Unit for the retention period of the backup

retention_valueinteger

Value between 1 and 1000 for the retention period of the backup (i.e retention_value 6 and retention_unit hour means 6 hours)

emergencyboolean

Whether the backup is an immediate backup that may affect database performance. Emergency backups are only supported for PostgreSQL databases.

Response

Returns the created database branch backup

idstring required

The ID of the backup

namestring required

The name of the backup

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