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

Resource	Scopes
Organization	manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Database	manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords
Branch	manage_passwords, manage_read_only_passwords

DELETE /organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}

Delete role credentials

cURL

curl --request DELETE \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} \
  --header 'Authorization: Bearer <token>'

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization · string · required

Organization name slug from list_organizations. Example: acme.

database · string · required

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

branch · string · required

Branch name from list_branches. Example: main.

id · string · required

The ID of the role

Query Parameters

successor · string

The optional role to reassign ownership to before dropping

Response

204

Deletes the role credentials