Sign in

v35

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-016584221.4 KB
Branches

Retrieve branch credentials

get/organizations/{organizationID}/projects/{projectID}/branches/{branchID}/credentials

Path parameters

organizationIDstring required
projectIDstring required
branchIDstring required

Query parameters

usernamestring

Username that the credentials requested for, defaults to xata

Response

Credentials for the branch retrieved successfully

usernamestring required

Username for accessing the branch database

passwordstring required

Password for accessing the branch database

hostnamestring required

Hostname for accessing the branch database

portinteger required

Port for accessing the branch database

dbnamestring required

Name of the database to connect to

connectionStringstring required

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