Sign in
Database Backups

Back up a database

Changed on

Captures the database as it is now. The backup is available immediately; its size_bytes appears once the storage provider has costed it.

Backups are rate-limited to one per minute per database, and capped by the owner's plan.

post/projects/{id}/databases/{databaseName}/backups

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/databases/{databaseName}/backups
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

databaseNamestring required

Database name (unique within project, lowercase letters, numbers, and underscores only)

Request body

namestring required

Backup name, unique within the database. Names beginning with volcano- are reserved for the platform's own snapshots.

Example request

{
  "name": "before_migration"
}

Response

Backup created

namestring required

Backup name, unique within the database. Backups you create are named by you; scheduled backups are named by the storage provider.

source'manual' | 'scheduled' required

Whether the backup was requested explicitly or produced by the backup schedule. Only manual backups count against the plan's backup allowance.

size_bytesinteger

Storage the backup occupies. Absent until the provider has costed it, which takes a few minutes after the backup is taken; absent is not the same as empty.

expires_atstring date-time

When the backup is deleted automatically, from the plan's retention. Absent means it is kept until deleted explicitly.

created_atstring date-time required

The point in time the backup captures.

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter databaseName

    • ▲

      added the new path request parameter id

    • ▲

      added the new required request property

    • ▲

      the request's body type changed from no type to object

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status