Sign in
Database Backups

Delete a backup

Changed on

Deletes the backup and frees its storage. Scheduled backups can be deleted too. A backup that is already gone reports 404, so a name that never existed and a name that no longer does read the same. Refused with 409 while the database is being restored.

delete/projects/{id}/databases/{databaseName}/backups/{backupName}

Request

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

backupNamestring required

Backup name, unique within the database, exactly as returned by the list endpoint.

Deliberately looser than the names you can create: a backup made by a schedule is named for you, so reading or deleting one accepts any name a backup can have.

Response

Backup deleted

statusstring required
messagestring required

Example response

{
  "status": "deleted",
  "message": "backup deleted"
}

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter backupName

    • ▲

      added the new path request parameter databaseName

    • ▲

      added the new path request parameter id

    • ▲

      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 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