Instaclustr Logo
Powered by Redocly

MongoDB Provisioning V2

List recent cluster backup events.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the cluster.

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/mongodb/clusters/v2/{clusterId}/list-backups/v2/
Request samples 
Response samples 
application/json
{
  • "clusterDataCentres": [
    ],
  • "id": "7dd06b80-effb-42ca-bc61-9e0897d92746",
  • "name": "example-cluster"
}
List compatible node sizes for MongoDB.
SecurityBasic Authentication 
Responses 
200
Successfully retrieved compatible node sizes for MongoDB.


get/cluster-management/v2/data-sources/applications/mongodb/compatible-node-sizes/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
List all MongoDB versions.
SecurityBasic Authentication 
Responses 
200
Successfully retrieved versions of MongoDB.


get/cluster-management/v2/data-sources/applications/mongodb/versions/v2/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Download MongoDB cluster X.509 Certificate Authority certificates
MongoDB 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 MongoDB cluster's certificate


get/cluster-management/v2/operations/applications/mongodb/clusters/v2/{clusterId}/certificate/v2/
Request samples 
Trigger a MongoDB Cluster Restore
SecurityBasic Authentication 
Request 
Request Body schema: application/json
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
MongoDB Cluster Restore requested


post/cluster-management/v2/operations/applications/mongodb/restore/v2
Request samples 
application/json
{
  • "cdcConfigs": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "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"
}
Create a MongoDB cluster.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
pciComplianceMode
required
boolean
Creates a PCI compliant cluster, see PCI Compliance.


 
Array of objects (TwoFactorDeleteSettingsV2)   <= 1 items 
 
mongodbInitCommands
Array of strings
List of command objects to run against the admin database on cluster creation. Equivalent to running db.adminCommand()


 
mongodbVersion
required
string[0-9]+\.[0-9]+\.[0-9]+
Version of MongoDB to run on the cluster. Available versions: 
     
  • 6.0.6
    •  
  • 6.0.3
    •  


 
required
Array of objects (MongodbDataCentreV2)   = 1 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"  
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 (KeyValuePair) 
Key/Value pairs of mongod configuration options to override from the platform defaults


 
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
MongoDB Cluster provisioning requested.


post/cluster-management/v2/resources/applications/mongodb/clusters/v2
Request samples 
application/json
{
  • "dataCentres": [
    ],
  • "mongodbVersion": "[x.y.z]",
  • "name": "MyMongoDBCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Response samples 
application/json
{
  • "dataCentres": [
    ],
  • "mongodbVersion": "[x.y.z]",
  • "name": "MyMongoDBCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Get MongoDB cluster details.
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Responses 
200
MongoDB cluster details retrieved.


get/cluster-management/v2/resources/applications/mongodb/clusters/v2/{clusterId}
Request samples 
Response samples 
application/json
{
  • "dataCentres": [
    ],
  • "mongodbVersion": "[x.y.z]",
  • "name": "MyMongoDBCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
Update Mongodb Cluster Details
SecurityBasic Authentication 
Request 
path Parameters
clusterId
required
string <uuid> 
 
Request Body schema: application/json
required
Array of objects (MongodbDataCentreUpdateV2)   non-empty 
List of data centre settings.


 
Responses 
202
MongoDB cluster update request accepted.


404
Mongodb cluster not found


put/cluster-management/v2/resources/applications/mongodb/clusters/v2/{clusterId}
Request samples 
application/json
{
  • "dataCentres": [
    ]
}
Response samples 
application/json
{
  • "dataCentres": [
    ],
  • "mongodbVersion": "[x.y.z]",
  • "name": "MyMongoDBCluster",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "slaTier": "NON_PRODUCTION"
}
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/mongodb/clusters/v2/{clusterId}
Request samples 
➔ Next to OpenSearch Egress Rules V2