Get branch details
Retrieves detailed information about a specific branch by its ID, including status, connection string, and configuration.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Authorization URL
- https://auth.xata.io/realms/xata/protocol/openid-connect/auth
Path Parameters
Unique identifier of the organization containing the project
[a-zA-Z0-9_-~:]+Unique identifier of the project containing the branch
Unique identifier of the branch to retrieve details for
Response
Branch details retrieved successfully
Detailed metadata about a branch, including its status and configuration
Unique identifier for the branch
Human-readable name of the branch
Timestamp when the branch was created
Timestamp when the branch was last updated
Geographic region where the branch is deployed
Detailed status information about a branch and its underlying database cluster
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.
Whether the branch allows public access without authentication
Whether the branch is in a region that supports backups
Configuration for scaling branches to zero when not in use
Configuration details for a database cluster backing a branch
Optional description of the branch purpose or contents
Identifier of the parent branch if this is a derived branch, null otherwise
Details about the branch continuous backup configuration