Sign in
Database Backups

Get a restore

Changed on

Returns the restore. Poll this after starting one; the database is connectable again once it reports completed.

get/projects/{id}/databases/{databaseName}/restores/{restoreId}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/databases/{databaseName}/restores/{restoreId}
  • 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)

restoreIdstring uuid required

Database restore ID

Response

Successful response

idstring uuid required
database_idstring uuid required
project_idstring uuid required
kind'snapshot' | 'point_in_time' required

Whether the restore targets a named backup or an arbitrary point in time. Both replace the database's data in place.

status'pending' | 'running' | 'completed' | 'failed' | 'exhausted' required

Restore status. pending and running both mean the restore is still in flight and the database is not connectable; an attempt that fails with tries left goes back to pending. failed and exhausted both mean Volcano gave up: the database is left failed if its data may already have been replaced, and active if the restore never started — a backup that no longer exists at the provider ends the restore without touching the database. A restore cannot be cancelled once it starts.

backup_namestring

The backup restored, kept even if that backup is later deleted. Absent for a point-in-time restore.

restore_tostring date-time

The point in time restored to. Absent for a backup restore.

errorstring

Why the most recent attempt failed, when one has.

completed_atstring date-time
created_atstring date-time required
updated_atstring date-time required

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 path request parameter restoreId

    • ▲

      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

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status