List configuration profiles 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.
Response
Returns shard configuration profiles for the branch
The ID of the shard configuration profile
The name of the shard configuration profile
The architecture of the cluster size SKU
The name of the cluster size SKU
The display name of the cluster size SKU
Whether this is the default shard configuration profile
Whether shards using this configuration profile use metal instances
The number of replicas for shards using this configuration profile
The PostgreSQL image used by the shard configuration profile
The latest PostgreSQL image available to the shard configuration profile
The PostgreSQL major version used by the shard configuration profile
The PostgreSQL minor version used by the shard configuration profile
The latest PostgreSQL minor version available to the shard configuration profile
The number of shards using this configuration profile
The current state of the shard configuration profile
draft, pending, applying, ready When the shard configuration profile was created
When the shard configuration profile was last updated

