Cluster Config

Operations related to configurations of a cluster.

Get cluster configurations

Get a list of applied configurations for the specified cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
bundle
required
string
Value: "POSTGRESQL"
Responses
200

Successfully returned a JSON list of applied configurations on the cluster.

400

The requested bundle is not attached to this cluster.

404

Cluster not found

get/provisioning/v1/{clusterId}/{bundle}/configurations
Request samples
Response samples
application/json
[
  • {
    }
]

Update cluster configurations

Update the cluster configuration with the provided input. If the specified configuration has not been set, it will be created.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
bundle
required
string
Value: "POSTGRESQL"
Request Body schema: application/json
parameterName
string
parameterValue
string
Responses
201

Successfully updated the cluster configuration.

400

The requested bundle is not attached to this cluster.

404

Cluster not found

502

Failed to update the configuration due to an internal issue.

put/provisioning/v1/{clusterId}/{bundle}/configurations
Request samples
application/json
{
  • "parameterName": "string",
  • "parameterValue": "string"
}
Response samples
application/json
{
  • "error": "string"
}

Reset a configuration

Restore an altered configuration parameter to its default value.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
bundle
required
string
Value: "POSTGRESQL"
parameterName
required
string
Responses
204

Successfully reset the cluster configuration.

400

The requested bundle is not attached to this cluster.

404

Cluster not found

delete/provisioning/v1/{clusterId}/{bundle}/configurations/parameter/{parameterName}
Request samples
Response samples
application/json
{
  • "error": "string"
}