Sign in
Environments

Delete a database branch

Deletes the specified database branch. By default, deletes immediately. Use force=false to schedule deletion with 1-hour grace period (only when soft deletion is enabled).

delete/v1/branches/{branch_id_or_ref}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • fga_permissions (a scheme the document does not define)
    • fga_permissions (a scheme the document does not define)

Path parameters

string required

Project ref

OR
string uuid required

Branch ID

Query parameters

forceboolean

If set to false, schedule deletion with 1-hour grace period (only when soft deletion is enabled).

Response

message'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.