Instaclustr Logo
Powered by Redocly

Postgresql Cluster V2

Operations related to managing a Postgresql cluster

Create a Postgresql cluster.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
Array of objects (PostgresqlDataCentreV2) [ 1 .. 2 ] items

List of data centre settings.

currentClusterOperationStatus
string (CurrentClusterOperationStatusV2)

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

Enum: "NO_OPERATION" "OPERATION_IN_PROGRESS" "OPERATION_FAILED"
synchronousModeStrict
required
boolean

Create the PostgreSQL cluster with the selected replication mode, see [PostgreSQL replication mode] (https://www.instaclustr.com/support/documentation/postgresql/options/replication-mode/).

privateNetworkCluster
required
boolean

Creates the cluster with private network only, see Private Network Clusters.

name
required
string [ 3 .. 32 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*

Name of the cluster.

postgresqlVersion
required
string[0-9]+\.[0-9]+\.[0-9]+

Version of Postgresql to run on the cluster. Available versions:

  • 13.8.0
  • 13.9.0
  • 14.5.0
  • 14.6.0
  • 15.1.0

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
slaTier
required
string (SlaTierV2)

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See SLA Tier for more information.

Enum: "PRODUCTION" "NON_PRODUCTION"
Responses
202

Postgresql Cluster provisioning requested.

post/cluster-management/v2/resources/applications/postgresql/clusters/v2/
Request samples
application/json
{
  • "dataCentres": [
    ],
  • "name": "test_apiv2_postgresql_create",
  • "postgresqlVersion": "[x.y.z]",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION",
  • "synchronousModeStrict": false
}
Response samples
application/json
{
  • "dataCentres": [
    ],
  • "name": "test_apiv2_postgresql_create",
  • "postgresqlVersion": "[x.y.z]",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION",
  • "synchronousModeStrict": false
}

Get Postgresql cluster details.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>
Responses
200

Postgresql cluster details retrieved.

get/cluster-management/v2/resources/applications/postgresql/clusters/v2/{clusterId}/
Request samples 
Response samples 
application/json
{
  • "dataCentres": [
    ],
  • "name": "test_apiv2_postgresql_create",
  • "postgresqlVersion": "[x.y.z]",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION",
  • "synchronousModeStrict": false
}
Update PostgreSQL cluster details
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Request Body schema: application/json
required
Array of objects (PostgresqlDataCentreV2)   = 1 items 
List of datacentre settings.


 
Responses 
202
PostgreSQL cluster update request accepted.


404
PostgreSQL cluster not found.


put/cluster-management/v2/resources/applications/postgresql/clusters/v2/{clusterId}/
Request samples 
application/json
{
  • "dataCentres": [
    ]
}
Response samples 
application/json
{
  • "dataCentres": [
    ],
  • "name": "test_apiv2_postgresql_create",
  • "postgresqlVersion": "[x.y.z]",
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION",
  • "synchronousModeStrict": false
}
Delete cluster
Delete an active cluster.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
204
Cluster delete requested.


delete/cluster-management/v2/resources/applications/postgresql/clusters/v2/{clusterId}/
Request samples 
➔ Next to Postgresql Configuration V2