Sign in
Databases

Delete a database

Changed on

Deletes a database and the instance backing it. When the instance is removed synchronously the database row is deleted and the response is 204. If the instance cannot be deleted right away, the database row is retained (status deleting) and its teardown is handed to the background reconciler, which retries the deletion and removes the row once the instance is gone; in that case the response is 202. The database row is never dropped while its instance still exists, so an instance is never orphaned without a record to retry from.

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

Request

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

Response

Deletion accepted and in progress. The backing instance could not be removed synchronously, so the database is marked deleting and torn down asynchronously by the reconciler.

statusstring
messagestring

Example response

{
  "status": "deleting",
  "message": "database deletion in progress"
}

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

    • ▲

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