XAxataio
Branches

Retrieve branch credentials

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

Request

  • Base URL
    https://api.xata.tech
  • Auth
    OAuth 2
    Implicit: https://auth.xata.io/realms/xata/protocol/openid-connect/auth
    Scopes: credentials:read

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.

Changes

  • ef4485f6428eRevision changes
    • breaking

      for the query request parameter username, default value xata was added

  • 16f6200eae92Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status