Delete role credentials

curl --request DELETE \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "successor": "<string>"
}'

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_branch_password

OAuth Scopes

Resource	Scopes
Organization	`manage_passwords`, `manage_production_branch_passwords`
Database	`manage_passwords`, `manage_production_branch_passwords`
Branch	`manage_passwords`

DELETE

organizations

{organization}

databases

{database}

branches

{branch}

roles

{id}

Delete role credentials

curl --request DELETE \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "successor": "<string>"
}'

Authorizations

Authorization

string

header

required

Path Parameters

organization

string

required

The name of the organization that owns this resource

database

string

required

The name of the database that owns this resource

branch

string

required

The name of the branch that owns this resource

string

required

The ID of the role

Body

application/json

successor

string

The optional role to reassign ownership to before dropping

Response

Deletes the role credentials

Get a role

Update role name

⌘I

Introduction

Webhooks in PlanetScale

Authentication

PlanetScale API

Delete role credentials

Authorization

Authorizations

Path Parameters

Body

Response