Sign in
Database Branches

Delete a branch

Changed on

Marks the branch for teardown and returns immediately. The branch stops accepting connections at once; its fork and its row are removed by a background job, so a provider outage cannot leave the call hanging or the branch half-deleted.

Deleting a branch that is still provisioning is allowed and stops the build, and repeating the call while teardown is in progress is accepted again. Once the branch is gone the call returns 404.

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

Request

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

branchNamestring required

Branch name (unique within the parent database, lowercase letters, numbers, and underscores only)

Response

Deletion accepted and in progress

statusstring required
messagestring required

Example response

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

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • 3a6f365f3f35Revision changes
    • ▲

      added the new path request parameter branchName

    • ▲

      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

    • ○

      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