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
application/json
{
  • "clusterDataCentres": [
    ],
  • "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
application/json
[
  • {
    }
]

List all versions of applications compatible with a Opensearch version

SecurityBasic Authentication
Request
path Parameters
version
required
string[0-9]+\.[0-9]+\.[0-9]+

An Opensearch version

Responses
200

Successfully retrieved versions of applications compatible with a Opensearch version

get/cluster-management/v2/data-sources/applications/opensearch/compatible-versions/v2/{version}
Request samples
Response samples
application/json
[
  • {
    }
]

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
application/json
[
  • {
    }
]

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
required
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": [
    ],
  • "clusterId": "c0e5e2ff-affe-444c-bdca-707c7b48aaad",
  • "indexNames": "test1,test2",
  • "pointInTime": 1420070400000,
  • "restoredClusterId": "b8a32a20-d8e0-11a7-def4-sdc278a6a50b",
  • "restoredClusterName": "my-restored-cluster"
}
Response samples
application/json
{
  • "cdcConfigs": [
    ],
  • "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
required
Array of objects (OpenSearchDataNodeV2) <= 1 items

List of data node settings.

opensearchVersion
string([0-9]+\.){2}[0-9]+

Version of OpenSearch to run on the cluster. Must be provided if opensearchMajorVersion is not provided. Available versions:

  • 1.3.19
  • 2.14.0
  • 1.3.17
  • 2.16.0

searchableSnapshots
boolean

Enable searchable snapshots. Available only for OpenSearch versions 2.7.0 or higher.

asynchronousSearchPlugin
boolean

Enable asynchronous search plugin

description
string

A description of the cluster

knnPlugin
boolean

Enable the k-NN 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

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
required
boolean

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

bundledUseOnly
boolean

Provision this cluster for Bundled Use only.

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.

Enum: "PRODUCTION" "NON_PRODUCTION"
pciComplianceMode
required
boolean

Creates a PCI compliant cluster, see PCI Compliance.

icuPlugin
boolean

Enable icu plugin

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
opensearchMajorVersion
integer [ 1 .. 2 ]

Major version of OpenSearch to run on the cluster. Must be provided if opensearchVersion is not provided.

required
Array of objects (OpenSearchDataCentreV2) = 1 items

List of data centre settings.

Array of objects (OpenSearchIngestNodeV2) <= 1 items

Ingest nodes settings.

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

Name of the cluster.

required
Array of objects (OpenSearchClusterManagerNodeV2) = 1 items

List of cluster managers node settings

indexManagementPlugin
boolean

Enable index management plugin

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": [
    ],
  • "dataCentres": [
    ],
  • "dataNodes": [
    ],
  • "icuPlugin": false,
  • "indexManagementPlugin": true,
  • "knnPlugin": false,
  • "loadBalancer": false,
  • "name": "OpenSearch_Cluster_V2",
  • "notificationsPlugin": false,
  • "opensearchDashboards": [
    ],
  • "opensearchVersion": "2.7.0",
  • "pciComplianceMode": false,
  • "privateNetworkCluster": false,
  • "reportingPlugin": false,
  • "slaTier": "NON_PRODUCTION",
  • "sqlPlugin": false
}
Response samples
application/json
{
  • "alertingPlugin": false,
  • "anomalyDetectionPlugin": false,
  • "asynchronousSearchPlugin": false,
  • "clusterManagerNodes": [
    ],
  • "dataCentres": [
    ],
  • "dataNodes": [
    ],
  • "icuPlugin": false,
  • "indexManagementPlugin": true,
  • "knnPlugin": false,
  • "loadBalancer": false,
  • "name": "OpenSearch_Cluster_V2",
  • "notificationsPlugin": false,
  • "opensearchDashboards": [
    ],
  • "opensearchVersion": "2.7.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
application/json
{
  • "alertingPlugin": false,
  • "anomalyDetectionPlugin": false,
  • "asynchronousSearchPlugin": false,
  • "clusterManagerNodes": [
    ],
  • "dataCentres": [
    ],
  • "dataNodes": [
    ],
  • "icuPlugin": false,
  • "indexManagementPlugin": true,
  • "knnPlugin": false,
  • "loadBalancer": false,
  • "name": "OpenSearch_Cluster_V2",
  • "notificationsPlugin": false,
  • "opensearchDashboards": [
    ],
  • "opensearchVersion": "2.7.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
required
Array of objects (OpenSearchDataNodeV2) <= 1 items

Data nodes settings.

Array of objects (OpenSearchIngestNodeV2) <= 1 items

Ingest nodes settings.

Array of objects (OpenSearchClusterManagerNodeV2) <= 1 items

Cluster Manager nodes settings.

description
string

A description of the cluster

Array of objects (TwoFactorDeleteSettingsV2) <= 1 items
Array of objects (ResizeSettingsV2) <= 1 items

Settings to determine how resize requests will be performed for the cluster.

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": [
    ],
  • "ingestNodes": [
    ],
  • "clusterManagerNodes": [
    ],
  • "description": "Cluster managed by the integration team.",
  • "twoFactorDelete": [
    ],
  • "resizeSettings": [
    ],
  • "opensearchDashboards": [
    ]
}
Response samples
application/json
{
  • "alertingPlugin": false,
  • "anomalyDetectionPlugin": false,
  • "asynchronousSearchPlugin": false,
  • "clusterManagerNodes": [
    ],
  • "dataCentres": [
    ],
  • "dataNodes": [
    ],
  • "icuPlugin": false,
  • "indexManagementPlugin": true,
  • "knnPlugin": false,
  • "loadBalancer": false,
  • "name": "OpenSearch_Cluster_V2",
  • "notificationsPlugin": false,
  • "opensearchDashboards": [
    ],
  • "opensearchVersion": "2.7.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