Get a shard for a branch
Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses
read_branch, delete_branch, create_branch, connect_production_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_branches |
| Database | read_branches |
| Branch | read_branch |
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Organization name slug from list_organizations. Example: acme.
Database name slug from list_databases. Example: app-db.
Branch name from list_branches. Example: main.
The ID of the shard
Response
Returns the shard
The ID of the shard
The name of the shard
The display name of the shard
The name of the shard configuration profile
When the shard was created
Whether the shard has been created on the cluster
Whether the shard is the authoritative shard of the cluster

