Skip to main content
GET
Retrieve branch credentials

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
default:xata

Username that the credentials requested for, defaults to xata

Response

Credentials for the branch retrieved successfully

Credentials and connection details for accessing a branch

username
string
required

Username for accessing the branch database

password
string
required

Password for accessing the branch database

hostname
string
required

Hostname for accessing the branch database

port
integer
required

Port for accessing the branch database

dbname
string
required

Name of the database to connect to

connectionString
string
required

Database connection string for accessing this branch. It carries no sslmode parameter, clients choose their own TLS settings.