rds.branches.delete

Delete a branch and what was written to it

DELETE /rds/api/branches/{branchId}IAM rds:DeleteDBBranchChanges stateDestructive

Request syntax

DELETE /rds/api/branches/{branchId}

Path parameters

  • branchIdRequired

    string

    Constraints: /^ewbr-[0-9a-f]{12}$/

Response

202 with { id, status } (status "deleting" while it is removed).

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    Branch id
  • statusAlways

    one of queued, creating, available, deleting, deleted, failed

    deleting while it is removed

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow rds:DeleteDBBranch on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud rds branches delete branchId

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_rds_branches_delete.