List recent cluster backup events.
SecurityBasic Authentication
Responses
200
List backups and restores for each node in a given cluster, for the last 7 days.
get/cluster-management/v2/data-sources/applications/postgresql/clusters/v2/{clusterId}/list-backups/v2/
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
{- "clusterDataCentres": [
- {
- "id": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
- "name": "AWS_VPC_US_EAST_1",
- "nodes": [
- {
- "events": [
- {
- "end": 1510585212265,
- "progress": 0.5,
- "start": 1510585212265,
- "state": "ACTIVE",
- "type": "snapshot-upload"
}
], - "id": "cb986e08-f6be-4d08-8de2-4352c2cfaf1f",
- "privateAddress": "10.0.0.1",
- "publicAddress": "50.0.0.1"
}
]
}
], - "id": "77b5a4e1-c422-4a78-b551-d8fa5c42ad95",
- "name": "example-cluster"
}List compatible node sizes for PostgreSQL and any specified addon applications.
SecurityBasic Authentication
Request
Responses
200
Successfully retrieved compatible node sizes for PostgreSQL.
get/cluster-management/v2/data-sources/applications/postgresql/compatible-node-sizes/v2/
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
[- {
- "cloudProviderNodeSizes": [
- {
- "nodeSizes": [
- "m5xl-400-v2",
- "r5xl-2000-v2"
], - "cloudProvider": "AWS_VPC",
- "document": "string"
}
]
}
]List all versions of applications compatible with a PostgreSQL version.
SecurityBasic Authentication
Responses
200
Successfully retrieved versions of applications compatible with a PostgreSQL version.
get/cluster-management/v2/data-sources/applications/postgresql/compatible-versions/v2/{version}
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
[- {
- "compatibleVersions": [
- {
- "compatibleApplicationGroup": [
- {
- "application": "[APPLICATION]",
- "version": "1.0.0"
}
]
}
]
}
]List all PostgreSQL applications and versions.
SecurityBasic Authentication
Responses
200
Successfully retrieved applications and versions for PostgreSQL.
get/cluster-management/v2/data-sources/applications/postgresql/versions/v2/
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
[- {
- "applicationVersions": [
- {
- "application": "[APPLICATION]",
- "versions": [
- "1.0.0",
- "1.0.1"
]
}
]
}
]Create a Postgresql cluster.
SecurityBasic Authentication
Request
Request Body schema: application/jsonrequired
| postgresqlVersion required | string[0-9]+\.[0-9]+\.[0-9]+ Version of Postgresql to run on the cluster. Available versions:
|
| description | string A description of the cluster |
Array of objects (TwoFactorDeleteSettingsV2) <= 1 items | |
| extensions | Array of strings (PostgresqlExtensionsV2) List of PostgreSQL extensions. |
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 |
| 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 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]* Name of the cluster. |
Array of objects (ResizeSettingsV2) <= 1 items Settings to determine how resize requests will be performed for the cluster. | |
| 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. |
Responses
202
PostgreSQL Cluster provisioning requested.
post/cluster-management/v2/resources/applications/postgresql/clusters/v2/
Request samples
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
application/json
{- "dataCentres": [
- {
- "clientToClusterEncryption": true,
- "cloudProvider": "AWS_VPC",
- "intraDataCentreReplication": [
- {
- "replicationMode": "SYNCHRONOUS"
}
], - "name": "dc_1",
- "network": "10.1.0.0/16",
- "nodeSize": "PGS-DEV-t4g.small-5",
- "numberOfNodes": 2,
- "region": "US_EAST_1"
}
], - "extensions": [
- "PG_CRON"
], - "name": "test_apiv2_postgresql_create",
- "postgresqlVersion": "[x.y.z]",
- "privateNetworkCluster": false,
- "slaTier": "NON_PRODUCTION",
- "synchronousModeStrict": false
}Response samples
- 202
application/json
{- "dataCentres": [
- {
- "clientToClusterEncryption": true,
- "cloudProvider": "AWS_VPC",
- "intraDataCentreReplication": [
- {
- "replicationMode": "SYNCHRONOUS"
}
], - "name": "dc_1",
- "network": "10.1.0.0/16",
- "nodeSize": "PGS-DEV-t4g.small-5",
- "numberOfNodes": 2,
- "region": "US_EAST_1"
}
], - "extensions": [
- "PG_CRON"
], - "name": "test_apiv2_postgresql_create",
- "postgresqlVersion": "[x.y.z]",
- "privateNetworkCluster": false,
- "slaTier": "NON_PRODUCTION",
- "synchronousModeStrict": false
}Get PostgreSQL cluster details.
SecurityBasic Authentication
Responses
200
PostgreSQL cluster details retrieved.
get/cluster-management/v2/resources/applications/postgresql/clusters/v2/{clusterId}/
Request samples
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
Response samples
- 200
application/json
{- "dataCentres": [
- {
- "clientToClusterEncryption": true,
- "cloudProvider": "AWS_VPC",
- "intraDataCentreReplication": [
- {
- "replicationMode": "SYNCHRONOUS"
}
], - "name": "dc_1",
- "network": "10.1.0.0/16",
- "nodeSize": "PGS-DEV-t4g.small-5",
- "numberOfNodes": 2,
- "region": "US_EAST_1"
}
], - "extensions": [
- "PG_CRON"
], - "name": "test_apiv2_postgresql_create",
- "postgresqlVersion": "[x.y.z]",
- "privateNetworkCluster": false,
- "slaTier": "NON_PRODUCTION",
- "synchronousModeStrict": false
}Update PostgreSQL cluster details
SecurityBasic Authentication
Request
Request Body schema: application/jsonrequired
Responses
202
PostgreSQL cluster update request accepted.
404
PostgreSQL cluster not found.
put/cluster-management/v2/resources/applications/postgresql/clusters/v2/{clusterId}/
Request samples
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Java 8 with Apache
- Go
- PHP
- Ruby
application/json
{- "dataCentres": [
- {
- "clientToClusterEncryption": true,
- "cloudProvider": "AWS_VPC",
- "interDataCentreReplication": {
- "isPrimaryDataCentre": true
}, - "intraDataCentreReplication": {
- "replicationMode": "SYNCHRONOUS"
}, - "name": "dc_1",
- "network": "10.2.0.0/16",
- "nodeSize": "PGS-DEV-t4g.small-5",
- "numberOfNodes": 2,
- "region": "US_WEST_2"
}
]
}Response samples
- 202
- 404
application/json
{- "dataCentres": [
- {
- "clientToClusterEncryption": true,
- "cloudProvider": "AWS_VPC",
- "intraDataCentreReplication": [
- {
- "replicationMode": "SYNCHRONOUS"
}
], - "name": "dc_1",
- "network": "10.1.0.0/16",
- "nodeSize": "PGS-DEV-t4g.small-5",
- "numberOfNodes": 2,
- "region": "US_EAST_1"
}
], - "extensions": [
- "PG_CRON"
], - "name": "test_apiv2_postgresql_create",
- "postgresqlVersion": "[x.y.z]",
- "privateNetworkCluster": false,
- "slaTier": "NON_PRODUCTION",
- "synchronousModeStrict": false
}