Cloud Essentials for Opensearch API

v1alpha1

Introduction

Cloud Essential for Opensearch is Scaleway's product to provide a managed infrastructure for your OpenSearch.

The product is currently in Public Beta.

Quickstart

Create a deployment: Run the following command to create a deployment of 3 nodes with 5GB of storage per node and a public endpoint.

    curl -X POST \
      -H "X-Auth-Token: $SCW_SECRET_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "project_id": $SCW_PROJECT_ID,
        "name":"deployment-1",
        "tags":[],
        "node_amount":1,
        "node_type":"SEARCHDB-DEDICATED-2C-8G",
        "user_name":"awesomeUser",
        "password":"MyAwesomeSecureP@ssword1",
        "volume":{
            "type":"sbs_5k",
            "size_bytes":5000000000
        },
        "endpoints": [{"public": {}}],
        "version":"2.0"
        }' \
      "https://api.scaleway.com/searchdb/v1alpha1/regions/fr-par/deployments"

Get a list of your deployments: Run the following command to get a list of all the clusters in your account, with their details:

    curl -X GET \
      -H "Content-Type: application/json" \
      -H "X-Auth-Token: $SCW_SECRET_KEY" \
      "https://api.scaleway.com/searchdb/v1alpha1/regions/fr-par/deployments"

Delete your deployment: Run the following command to delete a cluster. Ensure that you replace {resource-id} in the URLwith the ID of the cluster you want to delete.

    curl -X DELETE \
      -H "Content-Type: application/json" \
      -H "X-Auth-Token: $SCW_SECRET_KEY" \
      "https://api.scaleway.com/searchdb/v1alpha1/regions/fr-par/deployments/{resource-id}"

Technical information

Regions

Scaleway's infrastructure spans different regions and Availability Zones.

Opensaerchis currently available in the Paris region, which is represented by the following path parameter:

fr-par

Going further

For more information about Opensaerch, you can check out the following pages:

Cloud Essentials for Opensearch

Manage your Opensearch engine

GET/searchdb/v1alpha1/regions/{region}/deployments

POST/searchdb/v1alpha1/regions/{region}/deployments

GET/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}

PATCH/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}

DELETE/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}

POST/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}/upgrade

GET/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}/users

POST/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}/users

PATCH/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}/users/{username}

DELETE/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}/users/{username}

POST/searchdb/v1alpha1/regions/{region}/endpoints

DELETE/searchdb/v1alpha1/regions/{region}/endpoints/{endpoint_id}

GET/searchdb/v1alpha1/regions/{region}/node-types

GET/searchdb/v1alpha1/regions/{region}/versions