v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Roles

Delete role credentials

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses delete_production_branch_password, delete_production_read_only_branch_password, delete_branch_password

OAuth Scopes

ResourceScopes
Organizationmanage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Databasemanage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Branchmanage_passwords, manage_read_only_passwords
delete/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

idstring required

The ID of the role

Query parameters

successorstring

The optional role to reassign ownership to before dropping

Response

Deletes the role credentials