Cluster parameters
List cluster parameters
Returns the parameters for a branch. To update the parameters, use the "update_branch_change_request" endpoint.
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 |
get/organizations/{organization}/databases/{database}/branches/{branch}/parameters
Path parameters
organizationstring required
Organization name slug from list_organizations. Example: acme.
databasestring required
Database name slug from list_databases. Example: app-db.
branchstring required
Branch name from list_branches. Example: main.
Response
Returns cluster parameters