XAxataio
Branches

Get branch details

Changed on

Retrieves detailed information about a specific branch by its ID, including status, connection string, and configuration.

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

Request

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

Path parameters

organizationIDstring required

Unique identifier of the organization containing the project

projectIDstring required

Unique identifier of the project containing the branch

branchIDstring required

Unique identifier of the branch to retrieve details for

Response

Branch details retrieved successfully

idstring required

Unique identifier for the branch

namestring required

Human-readable name of the branch

descriptionstring

Optional description of the branch purpose or contents

createdAtstring date-time required

Timestamp when the branch was created

updatedAtstring date-time required

Timestamp when the branch was last updated

parentIDstring nullable

Identifier of the parent branch if this is a derived branch, null otherwise

regionstring required

Geographic region where the branch is deployed

connectionStringstring nullable required

Deprecated: retrieve the connection string from the branch credentials endpoint (GET .../branches/{branchID}/credentials) instead. The hostname in this connection string carries a -deprecated marker in its first DNS label.

publicAccessboolean required

Whether the branch allows public access without authentication

backupsEnabledboolean required

Whether the branch is in a region that supports backups

Changes