OpenSearch 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/opensearch/clusters/v2/{clusterId}/list-backups/v2/

Request samples

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 OpenSearch.

SecurityBasic Authentication

Responses

200

Successfully retrieved compatible node sizes for OpenSearch.

get/cluster-management/v2/data-sources/applications/opensearch/compatible-node-sizes/v2/

Request samples

Response samples

200

application/json

[{"cloudProviderNodeSizes": [{"nodeSizes": ["m5xl-400-v2",
"r5xl-2000-v2"
],
"cloudProvider": "AWS_VPC",
"document": "string"
}
]
}
]

List all OpenSearch versions.

SecurityBasic Authentication

Responses

200

Successfully retrieved versions of OpenSearch.

get/cluster-management/v2/data-sources/applications/opensearch/versions/v2/

Request samples

Response samples

200

application/json

[{"applicationVersions": [{"application": "[APPLICATION]",
"versions": ["1.0.0",
"1.0.1"
]
}
]
}
]

Download OpenSearch cluster X.509 Certificate Authority certificates

OpenSearch 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 OpenSearch cluster's certificate

get/cluster-management/v2/operations/applications/opensearch/clusters/v2/{clusterId}/certificate/v2/

Request samples

Manually trigger cluster backup.

SecurityBasic Authentication

Request

path Parameters

clusterId

required

string <uuid>

ID of the cluster.

Responses

202

Trigger cluster backup request accepted.

post/cluster-management/v2/operations/applications/opensearch/clusters/v2/{clusterId}/trigger-backup/v2/

Request samples

Trigger a OpenSearch 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.
indexNames	string A comma separated list of index names which follows the format <index-1>,<index-2> Only data for the specified indices will be restored, for the point in time.
clusterId required	string <uuid> ID of the cluster

Responses

202

OpenSearch Cluster Restore requested

post/cluster-management/v2/operations/applications/opensearch/restore/v2

Request samples

application/json

{"cdcConfigs": [{"cdcId": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
"customVpcSettings": {"network": "10.0.0.0/16",
"vpcId": "vpc-002512aa"
},
"restoreMode": "CUSTOM_VPC"
}
],
"clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
"indexNames": "test1,test2",
"pointInTime": 1420070400000,
"restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
"restoredClusterName": "my-restored-cluster"
}

Response samples

202

application/json

{"cdcConfigs": [{"cdcId": "a8c32b20-c8f0-11e7-abc4-cec278b6b50a",
"customVpcSettings": {"network": "10.0.0.0/16",
"vpcId": "vpc-002512aa"
},
"restoreMode": "CUSTOM_VPC"
}
],
"clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
"indexNames": "test1,test2",
"pointInTime": 1420070400000,
"restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
"restoredClusterName": "my-restored-cluster"
}

Create an OpenSearch cluster

SecurityBasic Authentication

Request

Request Body schema: application/json

	Array of objects (OpenSearchDataNodeV2) <= 1 items List of data node settings.
pciComplianceMode required	boolean Creates a PCI compliant cluster, see PCI Compliance.
icuPlugin	boolean Enable icu plugin
opensearchVersion required	string([0-9]+\.){2}[0-9]+ Version of OpenSearch to run on the cluster. Available versions: `1.3.9` `1.3.7` `2.5.0` `2.2.1`
asynchronousSearchPlugin	boolean Enable asynchronous search plugin
	Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
knnPlugin	boolean Enable knn plugin
	Array of objects (OpenSearchDashboardV2) <= 1 items List of openSearch dashboards settings
reportingPlugin	boolean Enable reporting plugin
sqlPlugin	boolean Enable sql plugin
notificationsPlugin	boolean Enable notifications plugin
required	Array of objects (OpenSearchDataCentreV2) = 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"
anomalyDetectionPlugin	boolean Enable anomaly detection plugin
loadBalancer	boolean Enable Load Balancer
privateNetworkCluster	boolean Creates the cluster with private network only, see Private Network Clusters.
name	string [ 3 .. 48 ] characters [a-zA-Z0-9][a-zA-Z0-9_-]* Name of the cluster.
bundledUseOnly	boolean Provision this cluster for Bundled Use only.
required	Array of objects (OpenSearchClusterManagerNodeV2) = 1 items List of cluster managers node settings
indexManagementPlugin	boolean Enable index management plugin
slaTier	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"
alertingPlugin	boolean Enable alerting plugin

Responses

202

OpenSearch Cluster provisioning requested.

post/cluster-management/v2/resources/applications/opensearch/clusters/v2/

Request samples

application/json

{"alertingPlugin": false,
"anomalyDetectionPlugin": false,
"asynchronousSearchPlugin": false,
"clusterManagerNodes": [{"dedicatedManager": true,
"nodeSize": "SRH-DM-DEV-t4g.small-5"
}
],
"dataCentres": [{"cloudProvider": "AWS_VPC",
"name": "AWS_VPC_US_EAST_1",
"network": "10.0.0.0/16",
"numberOfRacks": 3,
"privateLink": false,
"region": "US_EAST_1"
}
],
"dataNodes": [{"nodeCount": 3,
"nodeSize": "SRH-DEV-t4g.small-5"
}
],
"icuPlugin": false,
"indexManagementPlugin": true,
"knnPlugin": false,
"loadBalancer": false,
"name": "OpenSearch_Cluster_V2",
"notificationsPlugin": false,
"opensearchDashboards": [{"nodeSize": "SRH-DEV-t4g.small-5",
"oidcProvider": "",
"version": "opensearch-dashboards:2.5.0"
}
],
"opensearchVersion": "2.5.0",
"pciComplianceMode": false,
"privateNetworkCluster": false,
"reportingPlugin": false,
"slaTier": "NON_PRODUCTION",
"sqlPlugin": false
}

Response samples

202

application/json

{"alertingPlugin": false,
"anomalyDetectionPlugin": false,
"asynchronousSearchPlugin": false,
"clusterManagerNodes": [{"dedicatedManager": true,
"nodeSize": "SRH-DM-DEV-t4g.small-5"
}
],
"dataCentres": [{"cloudProvider": "AWS_VPC",
"name": "AWS_VPC_US_EAST_1",
"network": "10.0.0.0/16",
"numberOfRacks": 3,
"privateLink": false,
"region": "US_EAST_1"
}
],
"dataNodes": [{"nodeCount": 3,
"nodeSize": "SRH-DEV-t4g.small-5"
}
],
"icuPlugin": false,
"indexManagementPlugin": true,
"knnPlugin": false,
"loadBalancer": false,
"name": "OpenSearch_Cluster_V2",
"notificationsPlugin": false,
"opensearchDashboards": [{"nodeSize": "SRH-DEV-t4g.small-5",
"oidcProvider": "",
"version": "opensearch-dashboards:2.5.0"
}
],
"opensearchVersion": "2.5.0",
"pciComplianceMode": false,
"privateNetworkCluster": false,
"reportingPlugin": false,
"slaTier": "NON_PRODUCTION",
"sqlPlugin": false
}

Get OpenSearch cluster details

SecurityBasic Authentication

Request

path Parameters

clusterId

required

string <uuid>

Responses

200

OpenSearch cluster details retrieved.

get/cluster-management/v2/resources/applications/opensearch/clusters/v2/{clusterId}

Request samples

Response samples

200

application/json

{"alertingPlugin": false,
"anomalyDetectionPlugin": false,
"asynchronousSearchPlugin": false,
"clusterManagerNodes": [{"dedicatedManager": true,
"nodeSize": "SRH-DM-DEV-t4g.small-5"
}
],
"dataCentres": [{"cloudProvider": "AWS_VPC",
"name": "AWS_VPC_US_EAST_1",
"network": "10.0.0.0/16",
"numberOfRacks": 3,
"privateLink": false,
"region": "US_EAST_1"
}
],
"dataNodes": [{"nodeCount": 3,
"nodeSize": "SRH-DEV-t4g.small-5"
}
],
"icuPlugin": false,
"indexManagementPlugin": true,
"knnPlugin": false,
"loadBalancer": false,
"name": "OpenSearch_Cluster_V2",
"notificationsPlugin": false,
"opensearchDashboards": [{"nodeSize": "SRH-DEV-t4g.small-5",
"oidcProvider": "",
"version": "opensearch-dashboards:2.5.0"
}
],
"opensearchVersion": "2.5.0",
"pciComplianceMode": false,
"privateNetworkCluster": false,
"reportingPlugin": false,
"slaTier": "NON_PRODUCTION",
"sqlPlugin": false
}

Update a OpenSearch cluster

SecurityBasic Authentication

Request

path Parameters

clusterId

required

string <uuid>

Request Body schema: application/json

	Array of objects (OpenSearchDataNodeV2) <= 1 items Data nodes settings.
	Array of objects (OpenSearchClusterManagerNodeV2) <= 1 items Cluster Manager nodes settings.
	Array of objects (OpenSearchDashboardV2) <= 1 items Dashboards settings.

Responses

202

OpenSearch cluster update request accepted.

404

OpenSearch cluster not found.

put/cluster-management/v2/resources/applications/opensearch/clusters/v2/{clusterId}

Request samples

application/json

{"dataNodes": [{"nodeSize": "SRH-DEV-t4g.small-5",
"nodeCount": 3
}
],
"clusterManagerNodes": [{"nodeSize": "SRH-DEV-t4g.small-5",
"dedicatedManager": true
}
],
"opensearchDashboards": [{"nodeSize": "SRH-DEV-t4g.small-5",
"oidcProvider": "OIDC provider examples",
"version": "opensearch-dashboards:2.5.0"
}
]
}

Response samples

202
404

application/json

{"alertingPlugin": false,
"anomalyDetectionPlugin": false,
"asynchronousSearchPlugin": false,
"clusterManagerNodes": [{"dedicatedManager": true,
"nodeSize": "SRH-DM-DEV-t4g.small-5"
}
],
"dataCentres": [{"cloudProvider": "AWS_VPC",
"name": "AWS_VPC_US_EAST_1",
"network": "10.0.0.0/16",
"numberOfRacks": 3,
"privateLink": false,
"region": "US_EAST_1"
}
],
"dataNodes": [{"nodeCount": 3,
"nodeSize": "SRH-DEV-t4g.small-5"
}
],
"icuPlugin": false,
"indexManagementPlugin": true,
"knnPlugin": false,
"loadBalancer": false,
"name": "OpenSearch_Cluster_V2",
"notificationsPlugin": false,
"opensearchDashboards": [{"nodeSize": "SRH-DEV-t4g.small-5",
"oidcProvider": "",
"version": "opensearch-dashboards:2.5.0"
}
],
"opensearchVersion": "2.5.0",
"pciComplianceMode": false,
"privateNetworkCluster": false,
"reportingPlugin": false,
"slaTier": "NON_PRODUCTION",
"sqlPlugin": 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/opensearch/clusters/v2/{clusterId}

Request samples