Cloud Essentials for Opensearch

scaleway.searchdb.v1alpha1.EndpointSpec[]

Volume.

Endpoints to access the deployment.

version

string

The Opensearch version to use.

Create a new Cloud Essentials for OpenSearch deployment › Responses

200

id

string

Unique identifier of the Deployment. (UUID format)

name

string

Name of the Deployment.

organization_id

string

ID of the Organization containing the Deployment. (UUID format)

project_id

string

ID of the Project containing the Deployment. (UUID format)

status

scaleway.searchdb.v1alpha1.Deployment.Status · enum

Status of the Deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the Deployment.

node_count

integer · uint32

Number of nodes allocated per deployment.

node_type

string

Node type used in deployment.

Volume type and size.

Exposed endpoints.

created_at

string | null · date-time

Creation date of the Deployment. (RFC 3339 format)

updated_at

string | null · date-time

Date when last update was done to the Deployment. (RFC 3339 format)

version

string

Opensearch version of the Deployment.

region

string

Region the Deployment is located.

srn

string · pattern: ^srn://searchdb\.[^/…

The SRN of the Deployment.

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

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "node_type": "string",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "version": "string"
  }' \
  "https://api.scaleway.com/searchdb/v1alpha1/regions/{region}/deployments"

Example Request Body

{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_count": 0,
  "node_type": "node_type",
  "user_name": "user_name",
  "password": "password",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0,
    "deployment_id": "deployment_id"
  },
  "endpoints": [
    {
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "version": "version"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0,
    "deployment_id": "deployment_id"
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "region": "region",
      "srn": "srn",
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region",
  "srn": "srn"
}

json

application/json

Retrieve a specific Cloud Essentials for OpenSearch deployment

GET

https://api.scaleway.com

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

Retrieve a specific Cloud Essentials for OpenSearch deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

Retrieve a specific Cloud Essentials for OpenSearch deployment › Responses

200

id

string

Unique identifier of the Deployment. (UUID format)

name

string

Name of the Deployment.

organization_id

string

ID of the Organization containing the Deployment. (UUID format)

project_id

string

ID of the Project containing the Deployment. (UUID format)

status

scaleway.searchdb.v1alpha1.Deployment.Status · enum

Status of the Deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the Deployment.

node_count

integer · uint32

Number of nodes allocated per deployment.

node_type

string

Node type used in deployment.

Volume type and size.

Exposed endpoints.

created_at

string | null · date-time

Creation date of the Deployment. (RFC 3339 format)

updated_at

string | null · date-time

Date when last update was done to the Deployment. (RFC 3339 format)

version

string

Opensearch version of the Deployment.

region

string

Region the Deployment is located.

srn

string · pattern: ^srn://searchdb\.[^/…

The SRN of the Deployment.

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

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0,
    "deployment_id": "deployment_id"
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "region": "region",
      "srn": "srn",
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region",
  "srn": "srn"
}

json

application/json

Update a Cloud Essentials for OpenSearch deployment

PATCH

https://api.scaleway.com

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

Update a Cloud Essentials for OpenSearch deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the deployment to update. (UUID format)

Update a Cloud Essentials for OpenSearch deployment › Request Body

name

string | null

Name of the deployment.

tags

array | null

Tags of a deployment.

Update a Cloud Essentials for OpenSearch deployment › Responses

200

id

string

Unique identifier of the Deployment. (UUID format)

name

string

Name of the Deployment.

organization_id

string

ID of the Organization containing the Deployment. (UUID format)

project_id

string

ID of the Project containing the Deployment. (UUID format)

status

scaleway.searchdb.v1alpha1.Deployment.Status · enum

Status of the Deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the Deployment.

node_count

integer · uint32

Number of nodes allocated per deployment.

node_type

string

Node type used in deployment.

Volume type and size.

Exposed endpoints.

created_at

string | null · date-time

Creation date of the Deployment. (RFC 3339 format)

updated_at

string | null · date-time

Date when last update was done to the Deployment. (RFC 3339 format)

version

string

Opensearch version of the Deployment.

region

string

Region the Deployment is located.

srn

string · pattern: ^srn://searchdb\.[^/…

The SRN of the Deployment.

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

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}"

Example Request Body

{
  "name": "name",
  "tags": []
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0,
    "deployment_id": "deployment_id"
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "region": "region",
      "srn": "srn",
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region",
  "srn": "srn"
}

json

application/json

Delete a Cloud Essentials for OpenSearch deployment

DELETE

https://api.scaleway.com

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

Delete a Cloud Essentials for OpenSearch deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

ID of the deployment.

Delete a Cloud Essentials for OpenSearch deployment › Responses

200

id

string

Unique identifier of the Deployment. (UUID format)

name

string

Name of the Deployment.

organization_id

string

ID of the Organization containing the Deployment. (UUID format)

project_id

string

ID of the Project containing the Deployment. (UUID format)

status

scaleway.searchdb.v1alpha1.Deployment.Status · enum

Status of the Deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the Deployment.

node_count

integer · uint32

Number of nodes allocated per deployment.

node_type

string

Node type used in deployment.

Volume type and size.

Exposed endpoints.

created_at

string | null · date-time

Creation date of the Deployment. (RFC 3339 format)

updated_at

string | null · date-time

Date when last update was done to the Deployment. (RFC 3339 format)

version

string

Opensearch version of the Deployment.

region

string

Region the Deployment is located.

srn

string · pattern: ^srn://searchdb\.[^/…

The SRN of the Deployment.

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

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/searchdb/v1alpha1/regions/{region}/deployments/{deployment_id}"

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "status": "unknown_status",
  "tags": [
    "string"
  ],
  "node_amount": 0,
  "node_count": 0,
  "node_type": "node_type",
  "volume": {
    "type": "unknown_type",
    "size_bytes": 0,
    "deployment_id": "deployment_id"
  },
  "endpoints": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "dns_record": "dns_record",
      "services": [
        {
          "name": "name",
          "port": 0,
          "url": "url"
        }
      ],
      "region": "region",
      "srn": "srn",
      "public": {},
      "private_network": {
        "private_network_id": "6170692e-7363-616c-6577-61792e636f6d"
      }
    }
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "version": "version",
  "region": "region",
  "srn": "srn"
}

json

application/json

Upgrade a Cloud Essentials for OpenSearch deployment

POST

https://api.scaleway.com

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

Upgrade a Cloud Essentials for OpenSearch deployment › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

deployment_id

string · required

UUID of the Deployment to upgrade. (UUID format)

Upgrade a Cloud Essentials for OpenSearch deployment › Request Body

node_count

integer | null · uint32

The target number of nodes for the upgrade.

volume_size_bytes

integer | null · uint64

Volume size upgrade target.

Upgrade a Cloud Essentials for OpenSearch deployment › Responses

200

id

string

Unique identifier of the Deployment. (UUID format)

name

string

Name of the Deployment.

organization_id

string

ID of the Organization containing the Deployment. (UUID format)

project_id

string

ID of the Project containing the Deployment. (UUID format)

status

scaleway.searchdb.v1alpha1.Deployment.Status · enum

Status of the Deployment.

Enum values:

unknown_status

ready

creating

initializing

upgrading

deleting

error

locked

Default: unknown_status

tags

string[]

Tags of the Deployment.

node_count

integer · uint32

Number of nodes allocated per deployment.

node_type

string

Node type used in deployment.

Volume type and size.