Get a switchover
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 switchover
Response
Returns a switchover
The ID of the switchover
The state of the switchover
pending, running, succeeded, failed, canceled When the switchover was requested
When the switchover finished
When the switchover was created
When the switchover was last updated
How the primary was moved. switchover promotes a replica on a highly available branch; restart restarts the single instance of a branch that has no replicas. Absent until the operator selects one.
switchover, restart Why the switchover failed. A failed switchover has an unconfirmed outcome and does not imply the primary stayed put.

