Backups

ZIP backups of the organization, with every workspace. download fetches the file; restore create restores a backup into the calling workspace — it is destructive and asynchronous — and cancel stops a restore in progress.

Command	HTTP	Description
`backups list`	`GET /v1/backups`	List backups
`backups create`	`POST /v1/backups`	Request backup
`backups get`	`GET /v1/backups/{id}`	Get backup
`backups delete`	`DELETE /v1/backups/{id}`	Delete backup
`backups cancel`	`POST /v1/backups/{id}/cancel`	Cancel restore
`backups download`	`GET /v1/backups/{id}/download`	Download backup
`backups restore create`	`POST /v1/backups/restore`	Restore backup

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List backups
kobana dashboards backups list \
  --fields "id,type,status,file_size_bytes,created_at"

# Request backup
kobana dashboards backups create

# Download backup
kobana dashboards backups download \
  --params '{"id": "BACKUP_ID"}' \
  --output backup.zip

# Restore backup
kobana dashboards backups restore create \
  --json '{"backup_id": "BACKUP_ID"}' \
  --dry-run

Next steps

Data purge
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps