Retrieve a list of Cloud Essentials for OpenSearch deployments
path Parameters
regionThe region you want to target
query Parameters
organization_idID of the Organization containing the deployments.
project_idID of the Project containing the deployments.
order_byDefine the order of the returned deployments.
pageThe page number to return, from the paginated results.
page_sizeNumber of deployments to return.
tagsFilter by tag, only deployments with one or more matching tags will be returned.
nameDeployment name to filter for.
Retrieve a list of Cloud Essentials for OpenSearch deployments › Responses
List of deployments available.
total_countTotal number of objects.
Create a new Cloud Essentials for OpenSearch deployment
path Parameters
regionThe region you want to target
Create a new Cloud Essentials for OpenSearch deployment › Request Body
project_idProject ID in which to create the deployment. (UUID format)
nameName of the deployment.
tagsTags.
node_countNumber of nodes.
node_typeNode type.
user_nameUsername for the deployment user.
passwordPassword for the deployment user.
Volume.
Endpoints to access the deployment.
versionThe Opensearch version to use.
node_amountDEPRECATED: Use node_count instead. Number of nodes.
Create a new Cloud Essentials for OpenSearch deployment › Responses
idUnique identifier of the Deployment. (UUID format)
nameName of the Deployment.
organization_idID of the Organization containing the Deployment. (UUID format)
project_idID of the Project containing the Deployment. (UUID format)
statusStatus of the Deployment.
tagsTags of the Deployment.
node_countNumber of nodes allocated per deployment.
node_typeNode type used in deployment.
Volume type and size.
Exposed endpoints.
created_atCreation date of the Deployment. (RFC 3339 format)
updated_atDate when last update was done to the Deployment. (RFC 3339 format)
versionOpensearch version of the Deployment.
regionRegion the Deployment is located.
node_amountDEPRECATED: Use node_count instead. Number of nodes allocated per deployment.
Retrieve a specific Cloud Essentials for OpenSearch deployment
path Parameters
regionThe region you want to target
deployment_idID of the deployment.
Retrieve a specific Cloud Essentials for OpenSearch deployment › Responses
idUnique identifier of the Deployment. (UUID format)
nameName of the Deployment.
organization_idID of the Organization containing the Deployment. (UUID format)
project_idID of the Project containing the Deployment. (UUID format)
statusStatus of the Deployment.
tagsTags of the Deployment.
node_countNumber of nodes allocated per deployment.
node_typeNode type used in deployment.
Volume type and size.
Exposed endpoints.
created_atCreation date of the Deployment. (RFC 3339 format)
updated_atDate when last update was done to the Deployment. (RFC 3339 format)
versionOpensearch version of the Deployment.
regionRegion the Deployment is located.
node_amountDEPRECATED: Use node_count instead. Number of nodes allocated per deployment.
Delete a Cloud Essentials for OpenSearch deployment
path Parameters
regionThe region you want to target
deployment_idID of the deployment.
Delete a Cloud Essentials for OpenSearch deployment › Responses
idUnique identifier of the Deployment. (UUID format)
nameName of the Deployment.
organization_idID of the Organization containing the Deployment. (UUID format)
project_idID of the Project containing the Deployment. (UUID format)
statusStatus of the Deployment.
tagsTags of the Deployment.
node_countNumber of nodes allocated per deployment.
node_typeNode type used in deployment.
Volume type and size.
Exposed endpoints.
created_atCreation date of the Deployment. (RFC 3339 format)
updated_atDate when last update was done to the Deployment. (RFC 3339 format)
versionOpensearch version of the Deployment.
regionRegion the Deployment is located.
node_amountDEPRECATED: Use node_count instead. Number of nodes allocated per deployment.
Update a Cloud Essentials for OpenSearch deployment
path Parameters
regionThe region you want to target
deployment_idUUID of the deployment to update. (UUID format)
Update a Cloud Essentials for OpenSearch deployment › Request Body
nameName of the deployment.
tagsTags of a deployment.
Update a Cloud Essentials for OpenSearch deployment › Responses
idUnique identifier of the Deployment. (UUID format)
nameName of the Deployment.
organization_idID of the Organization containing the Deployment. (UUID format)
project_idID of the Project containing the Deployment. (UUID format)
statusStatus of the Deployment.
tagsTags of the Deployment.
node_countNumber of nodes allocated per deployment.
node_typeNode type used in deployment.
Volume type and size.
Exposed endpoints.
created_atCreation date of the Deployment. (RFC 3339 format)
updated_atDate when last update was done to the Deployment. (RFC 3339 format)
versionOpensearch version of the Deployment.
regionRegion the Deployment is located.
node_amountDEPRECATED: Use node_count instead. Number of nodes allocated per deployment.
Upgrade a Cloud Essentials for OpenSearch deployment
path Parameters
regionThe region you want to target
deployment_idUUID of the Deployment to upgrade. (UUID format)
Upgrade a Cloud Essentials for OpenSearch deployment › Request Body
node_countThe target number of nodes for the upgrade.
volume_size_bytesVolume size upgrade target.
node_amountDEPRECATED: Use node_count instead. Amount of node upgrade target.
Upgrade a Cloud Essentials for OpenSearch deployment › Responses
idUnique identifier of the Deployment. (UUID format)
nameName of the Deployment.
organization_idID of the Organization containing the Deployment. (UUID format)
project_idID of the Project containing the Deployment. (UUID format)
statusStatus of the Deployment.
tagsTags of the Deployment.
node_countNumber of nodes allocated per deployment.
node_typeNode type used in deployment.
Volume type and size.
Exposed endpoints.
created_atCreation date of the Deployment. (RFC 3339 format)
updated_atDate when last update was done to the Deployment. (RFC 3339 format)
versionOpensearch version of the Deployment.
regionRegion the Deployment is located.
node_amountDEPRECATED: Use node_count instead. Number of nodes allocated per deployment.
Retrieve a list of deployment users
path Parameters
regionThe region you want to target
deployment_idquery Parameters
pagepage_sizeorder_bynameRetrieve a list of deployment users › Responses
total_countCreate a new user
path Parameters
regionThe region you want to target
deployment_idID of the deployment in which to create the user.
Create a new user › Request Body
usernameUsername of the deployment user.
passwordPassword of the deployment user.
Create a new user › Responses
usernameDelete an existing user
path Parameters
regionThe region you want to target
deployment_idID of the deployment in which to create the user.
usernameUsername of the deployment user.
Delete an existing user › Responses
Update an existing user
path Parameters
regionThe region you want to target
deployment_idID of the deployment in which to create the user.
usernameUsername of the deployment user.
Update an existing user › Responses
usernameCreate a new endpoint on a deployment
path Parameters
regionThe region you want to target
Create a new endpoint on a deployment › Request Body
deployment_idID of the deployment for which to create an endpoint. (UUID format)
Specification of the endpoint you want to create.
Create a new endpoint on a deployment › Responses
idUnique identifier of the Endpoint. (UUID format)
List of available services, their ports and URLs.
publicdns_recordDNS entry to access to the service. Now deprecated. Use the url field from services field instead.
Retrieve a list of available node types
path Parameters
regionThe region you want to target
query Parameters
order_bySort order of nodes in the response (name, vcpus or memory).
pagePage number to return, from the paginated results.
page_sizeNumber of node types to return.
Retrieve a list of available node types › Responses
Node types compatible with the cluster.
total_countNumber of available node types to return.
List available Cloud Essentials for OpenSearch versions
path Parameters
regionThe region you want to target
query Parameters
order_byDefine the order of the returned version.
pageThe page number to return, form the paginated results.
page_sizeNumber of version to return.
versionFilter by version.
List available Cloud Essentials for OpenSearch versions › Responses
List of versions.
total_countNumber of versions in the list.