Skip to main content
POST
/
organizations
/
{organizationID}
/
projects
/
{projectID}
/
branches
/
{branchID}
/
credentials
/
rotate
Rotate branch credentials
curl --request POST \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/credentials/rotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>"
}
'
{
  "message": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organizationID
string
required
Pattern: [a-zA-Z0-9_-~:]+
​
projectID
string
required
​
branchID
string
required

Body

application/json

Request to rotate credentials for a branch database user

​
username
string
required

Database username to rotate credentials for

Response

Credential rotation initiated successfully