Get a router 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.
Name from list_routers.
Response
Returns the router
The ID of the router
The name of the router
Whether this is the default router
The router size SKU name
The count of replicas in each cell
Whether the router scales horizontally within each cell
The maximum count of replicas in each cell when autoscaling
The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70
The current state of the router
pending, applying, ready When the router was created
When the router was last updated

