Update a sidecar 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
write_database
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | write_databases |
| Database | write_database |
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.
ID from list_sidecars, or the configuration profile name.
Body
Sidecar parameters nested by namespace (e.g., {"sidecar": {"pool-capacity": "100"}})
Response
Returns the sidecar
The ID of the sidecar
The name of the shard configuration profile the sidecar belongs to
The current state of the sidecar
pending, applying, ready When the sidecar was created
When the sidecar was last updated

