Configuration parameter

Manage cluster configuration parameters.

Configuration parameters control various behaviors of the cluster. For instance, items like logging, resource allocation, replication, etc.

While PostgreSQL provides many configuration parameter options, Bridge only allows for the modification of a subset. The GET /configuration-parameters endpoint provides a list of the currently supported configuration parameters that are available to be set via this API.

More information on PostgreSQL's configuration parameters as well as more detailed descriptions of each can be found in the official docs.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

The `ClusterConfigurationParameterList` API resource

Response for listing configuration parameters for a cluster.

Content type: application/json

Name	Nullable	Type	Description
`parameters`		`array` of `array`	List of configuration parameters.

List supported cluster configuration parameters

List all of the currently supported cluster configuration parameters.

Unlike other list endpoints, this one doesn't support pagination.

GET /configuration-parameters

cURL example

curl -X GET https://api.crunchybridge.com/configuration-parameters
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Response for listing supported configuration parameters.

Content type: application/json

Name	Nullable	Type	Description
`parameters`		`array` of `array`	List of supported configuration parameters.

List cluster configuration parameters

List all configuration parameters for a cluster.

Unlike other list endpoints, this one doesn't support pagination.

GET /clusters/{cluster_id}/configuration-parameters

Request

Path parameters

cluster_id: Unique ID of the cluster.

cURL example

curl -X GET https://api.crunchybridge.com/clusters/{cluster_id}/configuration-parameters
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

Responds with the standard ClusterConfigurationParameterList API resource.

Update cluster configuration parameters

Update cluster configuration parameters.

PUT /clusters/{cluster_id}/configuration-parameters

Request

Path parameters

cluster_id: Unique ID of the cluster.

Request body schema

Content type: application/json

Name	Required	Type	Description
`parameters`	✔	`array` of `array`	A list of parameters to update.
`allow_restart`		`boolean`	Allow restarting cluster if any parameters require it.

Example request body

{
    "allow_restart": true,
    "parameters": [
        {
            "name": "postgres:log_statement",
            "value": "all"
        }
    ]
}

cURL example

curl -X PUT https://api.crunchybridge.com/clusters/{cluster_id}/configuration-parameters
    -H "Authorization: Bearer $CRUNCHY_API_KEY"
    -H "Content-Type: application/json"
    -d '{"allow_restart":true,"parameters":[{"name":"postgres:log_statement","value":"all"}]}'

Response

Status: 200

Responds with the standard ClusterConfigurationParameterList API resource.

Get a cluster configuration parameter

Get the value of a specific cluster configuration parameter.

GET /clusters/{cluster_id}/configuration-parameters/{configuration_parameter_name}

Request

Path parameters

cluster_id: Unique ID of the cluster.
configuration_parameter_name: The fully qualified name of the configuration parameter, e.g. postgres:log_statement.

cURL example

curl -X GET https://api.crunchybridge.com/clusters/{cluster_id}/configuration-parameters/{configuration_parameter_name}
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

A configuration parameter for a cluster.

Content type: application/json

Name	Nullable	Type	Description
`cluster_id`		`string` in EID format	The ID of cluster that the configuration parameter belongs to.
`component`		`string`	Component to which the configuration parameter belongs. For example: `postgres`.
`name`		`string`	The fully qualified name of the parameter that takes the following form: `<component>:<parameter_name>`. For example: `postgres:log_statement`
`parameter_name`		`string`	The name of the configuration parameter. For example: `log_statement`.
`value`	✔	`string`	The value of the configuration parameter.

Example

{
    "cluster_id": "rvf73a77ozfsvcttryebfrnlem",
    "component": "postgres",
    "name": "postgres:log_statement",
    "parameter_name": "log_statement",
    "value": "all"
}