Postgresql Configuration V2

Operations related to PostgreSQL configuration properties.

Get cluster configurations

Get a list of applied configurations for the specified cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the PostgreSQL cluster.

Responses
200

Successfully retrieved a list of the configuration properties applied to the cluster.

get/cluster-management/v2/data-sources/postgresql_cluster/{clusterId}/configurations
Request samples
Response samples
application/json
[
  • {
    }
]

Create configuration

Create a cluster configuration with the provided input. If the specified configuration has not been set, it will be created. Cluster nodes will need to be manually reloaded to apply configuration changes.

SecurityBasic Authentication
Request
Request Body schema: application/json
name
required
string

Name of the configuration property.

clusterId
required
string

Id of the PostgreSQL cluster.

value
required
string

Value of the configuration property.

Responses
202

Configuration property created successfully.

404

PostgreSQL cluster not found.

post/cluster-management/v2/resources/applications/postgresql/configurations/v2/
Request samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "name": "idle_in_transaction_session_timeout",
  • "value": "1"
}
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "name": "idle_in_transaction_session_timeout",
  • "value": "1"
}

Get configuration

Get a configuration applied to the cluster.

SecurityBasic Authentication
Request
path Parameters
configurationId
required
string

Instaclustr identifier for the PostgreSQL configuration property. The value of this property has the form: [cluster-id]|[configuration_name]

Responses
202

configuration property successfully retrieved.

404

PostgreSQL cluster not found.

get/cluster-management/v2/resources/applications/postgresql/configurations/v2/{configurationId}
Request samples
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "name": "idle_in_transaction_session_timeout",
  • "value": "1"
}

Update configuration

Update an applied configuration to the cluster. Cluster nodes will need to be manually reloaded to apply configuration changes.

SecurityBasic Authentication
Request
path Parameters
configurationId
required
string

Instaclustr identifier for the PostgreSQL configuration property. The value of this property has the form: [cluster-id]|[configuration_name]

Request Body schema: application/json
value
required
string

Value of the configuration property.

Responses
202

configuration property successfully updated.

404

PostgreSQL cluster not found.

put/cluster-management/v2/resources/applications/postgresql/configurations/v2/{configurationId}
Request samples
application/json
{
  • "value": "1"
}
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "name": "idle_in_transaction_session_timeout",
  • "value": "1"
}

Reset a configuration

Restore an altered configuration property to its default value. Cluster nodes will need to be manually reloaded to apply configuration changes.

SecurityBasic Authentication
Request
path Parameters
configurationId
required
string

Instaclustr identifier for the PostgreSQL configuration property. The value of this property has the form: [cluster-id]|[configuration_name]

Responses
204

Successfully reset the cluster configuration.

404

PostgreSQL cluster not found.

delete/cluster-management/v2/resources/applications/postgresql/configurations/v2/{configurationId}
Request samples
Response samples
application/json
{
  • "name": "string",
  • "message": "string"
}