Sign in
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

ResourceScopes
Organizationread_branches
Databaseread_branches
Branchread_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

idstring required

The ID of the parameter

namestring required

The name of the parameter

display_namestring required

The display name of the parameter

namespace'patroni' | 'pgconf' | 'pgbouncer' required

The namespace of the parameter

categorystring required

The category of the parameter

descriptionstring required

The description of the parameter

extensionboolean required

Configures an extension

immutableboolean required

Whether the parameter can be changed

parameter_type'array' | 'boolean' | 'bytes' | 'float' | 'integer' | 'seconds' | 'select' | 'string' | 'time' required

The type of the parameter

default_valuestring required

The default value of the parameter

valuestring required

The configured value of the parameter

requiredboolean required

Whether the parameter is required

created_atstring required

When the parameter was created

updated_atstring required

When the parameter was last updated

restartboolean required

True if processes require a server restart on change

maxnumber required

The maximum value of the parameter

minnumber required

The minimum value of the parameter

urlstring required

The URL of the parameter

optionsstring[] required

Valid options for the parameter value

Changes

Changed in 3 of the 24 revisions of this API.23

  • 2499429954891See the full diff
    • ▲

      removed the required property items/step from the response with the 200 status

      response-required-property-removed

  • 3c33e46f8ff212See the full diff
    • ▲

      removed the required property items/internal from the response with the 200 status

      response-required-property-removed

    • ○

      removed the internal enum value from the items/parameter_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      added the required property items/immutable to the response with the 200 status

      response-required-property-added

  • be036c71496f1See the full diff
    • ○

      removed the milliseconds enum value from the items/parameter_type response property for the response status 200

      response-property-enum-value-removed