Retrieve branch credentials

GET

organizations

{organizationID}

projects

{projectID}

branches

{branchID}

credentials

Retrieve branch credentials

curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/credentials \
  --header 'Authorization: Bearer <token>'

{
  "username": "<string>",
  "password": "<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

Query Parameters

username

string

Username that the credentials requested for

Response

Credentials for the branch retrieved successfully

Credentials for accessing a branch, username and password

username

string

required

Username for accessing the branch database

password

string

required

Password for accessing the branch database

Rotate branch credentialsTriggers a credential rotation for the branch database user. The new credentials can be retrieved via the credentials endpoint after rotation completes.

Retrieve branch credentials

curl --request GET \
  --url https://api.xata.tech/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/credentials \
  --header 'Authorization: Bearer <token>'

{
  "username": "<string>",
  "password": "<string>"
}