v1

latestSwagger 2.02026-07-172964242.9 KB

Database

Backup database node

Initiates a backup for a database node.

post/v1/databases/{database_id}/nodes/{node_name}/backups

Path parameters

database_idstring required

A user-specified identifier. Must be 1-36 characters, contain only lower-cased letters and hyphens, start and end with a letter or number, and not contain consecutive hyphens.

node_namestring required

Name of the node to back up.

Query parameters

forceboolean

Forcibly attempt backup even in unmodifiable state

Request body

annotationsobject

Annotations for the backup.

backup_optionsobject

Options for the backup.

type'full' | 'diff' | 'incr' required

The type of backup.

Example request

{
  "annotations": {
    "initiated-by": "backup-cron-job"
  },
  "backup_options": {
    "archive-check": "n"
  },
  "type": "full"
}

Response

OK response.

Example response

{
  "task": {
    "created_at": "2025-06-18T17:54:28Z",
    "database_id": "storefront",
    "status": "pending",
    "task_id": "0197842d-9082-7496-b787-77bd2e11809f",
    "type": "node_backup"
  }
}