Instaclustr Logo
Powered by Redocly

PostgreSQL Operations

Operations related to PostgreSQL.

Get cluster reload operations

Retrieve the latest reload operation done on each node in the specified cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the PostgreSQL cluster.

Responses
202

Successfully return a list of node reload operations.

404

PostgreSQL cluster not found.

get/cluster-management/v2/operations/applications/postgresql/clusters/v2/{clusterId}/reload
Request samples 
Response samples 
application/json
{
  • "reloadOperations": [
    ],
  • "clusterId": "string"
}
Update the default PostgreSQL user password.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the PostgreSQL cluster.


 
Request Body schema: application/json
required
password
required
string
Password of the default PostgreSQL user.


 
Responses 
202
Default PostgreSQL user password updated.


404
PostgreSQL cluster not found.


503
Service Unavailable


504
Gateway Timeout


put/cluster-management/v2/operations/applications/postgresql/clusters/v2/{clusterId}/update-default-user-password
Request samples 
application/json
{
  • "password": "!mypassword1"
}
Response samples 
application/json
{
  • "password": "!mypassword1"
}
Download PostgreSQL cluster X.509 Certificate Authority certificates
PostgreSQL cluster certificates are returned as a .zip file. The file contains an X.509 cluster Certificate Authority certificate in JKS file, an X.509 cluster Certificate Authority certificate in PEM-encoded (ASCII) format, and an X.509 cluster Certificate Authority certificate in DER-encoded (binary) format.


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string
ID of the cluster


 
Responses 
200
Successfully create the PostgreSQL cluster's certificate


get/cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/certificate/v3/
Request samples 
Trigger an extension instantiate operation
Instantiate Extension for list of databases


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the cluster


 
extensionName
required
string
Name of the extensions


 Enum: "PG_STAT_TUPLE" "PG_BUFFER_CACHE" "PG_VECTOR" "PG_STAT_STATEMENTS" "EARTH_DISTANCE" "CUBE"  
Request Body schema: application/json
required
dataBaseNames
Array of strings  [ 1 .. 32 ] items 
List of database names.


 
Responses 
202
Successfully trigger the operation.


404
PostgreSQL cluster or extension not found.


post/cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/extensions/create/{extensionName}/v1
Request samples 
application/json
{
  • "dataBaseNames": [
    ]
}
Response samples 
application/json
{
  • "name": "string",
  • "message": "string"
}
Trigger an extension drop operation
Drop Extension for list of databases


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the cluster


 
extensionName
required
string
Name of the extensions


 Enum: "PG_STAT_TUPLE" "PG_BUFFER_CACHE" "PG_VECTOR" "PG_STAT_STATEMENTS" "EARTH_DISTANCE" "CUBE"  
Request Body schema: application/json
required
dataBaseNames
Array of strings  [ 1 .. 32 ] items 
List of database names.


 
Responses 
202
Successfully trigger the operation.


404
PostgreSQL cluster or extension not found.


post/cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/extensions/drop/{extensionName}/v1
Request samples 
application/json
{
  • "dataBaseNames": [
    ]
}
Response samples 
application/json
{
  • "name": "string",
  • "message": "string"
}
Delete an ad-hoc PostgreSQL cluster snapshot
Deletes an ad-hoc FSxN snapshot for a PostgreSQL cluster. Only supported for clusters using FSx for NetApp ONTAP storage


SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the cluster.


 
clusterSnapshotId
required
string <uuid> 
ID of the ad-hoc cluster snapshot to delete.


 
Responses 
204
Snapshot delete request processed.


400
The snapshot is not eligible for deletion, or the FSxN Snapshot feature is not enabled.


403
Missing required permissions


404
PostgreSQL cluster or snapshot not found.


409
The snapshot cannot be deleted because one or more clusters were forked from it.


delete/cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/snapshots/{clusterSnapshotId}/v1
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "message": "string"
}
Manually trigger cluster backup.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
ID of the cluster.


 
Request Body schema: application/json
optional
type
string (PostgresqlBackupTypeEnumV2) 
Type of backup


 Enum: "snapshot" "backup"  
Responses 
202
Trigger cluster backup request accepted.


post/cluster-management/v2/operations/applications/postgresql/clusters/{clusterId}/trigger-backup/v3/
Request samples 
application/json
{
  • "type": "snapshot"
}
Get node reload operation
Retrieve the latest reload operation of the specified node.


SecurityBasic Authentication 
Request 
path Parameters
nodeId
required
string <uuid> 
ID of the PostgreSQL node.


 
Responses 
202
Successfully return the latest node reload operation.


404
PostgreSQL node not found.


get/cluster-management/v2/operations/applications/postgresql/nodes/v2/{nodeId}/reload
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "nodeId": "string",
  • "operationId": "string",
  • "status": "GENESIS",
  • "timeCreated": "2019-08-24T14:15:22Z",
  • "timeModified": "2019-08-24T14:15:22Z"
}
Trigger a node reload operation
Trigger a node reload operation, this is generally done to allow configuration changes to take effect without initiating a full restart.


SecurityBasic Authentication 
Request 
path Parameters
nodeId
required
string <uuid> 
ID of the PostgreSQL node.


 
Responses 
202
Successfully trigger the node reload operation.


404
PostgreSQL node not found.


post/cluster-management/v2/operations/applications/postgresql/nodes/v2/{nodeId}/reload
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "nodeId": "string",
  • "operationId": "string",
  • "status": "GENESIS",
  • "timeCreated": "2019-08-24T14:15:22Z",
  • "timeModified": "2019-08-24T14:15:22Z"
}
Trigger a PostgreSQL Cluster Restore
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
object
Configuration for ANF or FSxN Forking.


If used, cdcConfigs and pointInTime values will be ignored


 
Array of objects (ClusterDataCentreRestoreConfigV2) 
An optional list of Cluster Data Centres to determine their VPC in the restored cluster.


Data centres not included will default to being restored to a new VPC.


 
pointInTime
string
Timestamp in milliseconds since epoch or ISO formatted date and time (example - 2023-11-05T13:15:30Z). All backed up data will be restored for this point in time.


Defaults to the current date and time.


 
restoredClusterName
string  [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]*
The display name of the restored cluster.


By default, the restored cluster will be created with its current name appended with “restored” and the date & time it was requested to be restored.


 
clusterId
required
string <uuid> 
ID of the cluster


 
Responses 
202
PostgreSQL Cluster Restore requested


post/cluster-management/v2/operations/applications/postgresql/restore/v3
Request samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterName": "my-restored-cluster"
}
Response samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
➔ Next to PostgreSQL Provisioning V2