# Documentation for `scw searchdb`


:::note{title="The CLI documentation pages are currently under construction"}
The content is up to date. We're making improvements to the site over the next few weeks for a better experience.
:::

<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
Cloud Essentials for Opensearch API.

- [](#)
  - [Create a new Cloud Essentials for OpenSearch deployment](#create-a-new-cloud-essentials-for-opensearch-deployment)
  - [Delete a Cloud Essentials for OpenSearch deployment](#delete-a-cloud-essentials-for-opensearch-deployment)
  - [Retrieve a specific Cloud Essentials for OpenSearch deployment](#retrieve-a-specific-cloud-essentials-for-opensearch-deployment)
  - [Retrieve a list of Cloud Essentials for OpenSearch deployments](#retrieve-a-list-of-cloud-essentials-for-opensearch-deployments)
  - [Update a Cloud Essentials for OpenSearch deployment](#update-a-cloud-essentials-for-opensearch-deployment)
  - [Upgrade a Cloud Essentials for OpenSearch deployment](#upgrade-a-cloud-essentials-for-opensearch-deployment)
- [](#)
  - [Create a new endpoint on a deployment](#create-a-new-endpoint-on-a-deployment)
  - [Delete an existing endpoint](#delete-an-existing-endpoint)
- [](#)
  - [Retrieve a list of available node types](#retrieve-a-list-of-available-node-types)
- [](#)
  - [Create a new user](#create-a-new-user)
  - [Delete an existing user](#delete-an-existing-user)
  - [Retrieve a list of deployment users](#retrieve-a-list-of-deployment-users)
  - [Update an existing user](#update-an-existing-user)
- [](#)
  - [List available Cloud Essentials for OpenSearch versions](#list-available-cloud-essentials-for-opensearch-versions)


## 

Manage your Cloud Essentials for OpenSearch deployment.


### Create a new Cloud Essentials for OpenSearch deployment

Create a new Cloud Essentials for OpenSearch deployment.

**Usage:**

```shell
scw searchdb deployment create [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| project-id |  | Project ID to use. If none is passed the default project ID will be used |
| name |  | Name of the deployment |
| tags.{index} |  | Tags |
| ~~node-amount~~ | Deprecated | DEPRECATED: Use node_count instead. Number of nodes |
| node-count |  | Number of nodes. |
| node-type |  | Node type |
| user-name |  | Username for the deployment user |
| password |  | Password for the deployment user |
| volume.type | One of: `unknown_type`, `sbs_5k`, `sbs_15k` | Define the type of the Volume |
| volume.size-bytes |  | Define the size of the Volume |
| endpoints.{index}.private-network.private-network-id |  |  |
| version |  | The Opensearch version to use |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Delete a Cloud Essentials for OpenSearch deployment

Delete a Cloud Essentials for OpenSearch deployment.

**Usage:**

```shell
scw searchdb deployment delete [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | ID of the deployment |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Retrieve a specific Cloud Essentials for OpenSearch deployment

Retrieve a specific Cloud Essentials for OpenSearch deployment.

**Usage:**

```shell
scw searchdb deployment get [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | ID of the deployment |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Retrieve a list of Cloud Essentials for OpenSearch deployments

Retrieve a list of Cloud Essentials for OpenSearch deployments.

**Usage:**

```shell
scw searchdb deployment list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| project-id |  | ID of the Project containing the deployments |
| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `updated_at_asc`, `updated_at_desc` | Define the order of the returned deployments |
| tags.{index} |  | Filter by tag, only deployments with one or more matching tags will be returned |
| name |  | Deployment name to filter for |
| organization-id |  | ID of the Organization containing the deployments |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |



### Update a Cloud Essentials for OpenSearch deployment

Update a Cloud Essentials for OpenSearch deployment.

**Usage:**

```shell
scw searchdb deployment update [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | UUID of the deployment to update |
| name |  | Name of the deployment |
| tags.{index} |  | Tags of a deployment |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Upgrade a Cloud Essentials for OpenSearch deployment

Upgrade a Cloud Essentials for OpenSearch deployment.

**Usage:**

```shell
scw searchdb deployment upgrade [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | UUID of the Deployment to upgrade |
| ~~node-amount~~ | Deprecated | DEPRECATED: Use node_count instead. Amount of node upgrade target |
| node-count |  | The target number of nodes for the upgrade. |
| volume-size-bytes |  | Volume size upgrade target |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



## 

Manage your Cloud Essentials for OpenSearch deployment endpoint.


### Create a new endpoint on a deployment

Create a new endpoint on a deployment.

**Usage:**

```shell
scw searchdb endpoint create [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id |  | ID of the deployment for which to create an endpoint |
| endpoint-spec.private-network.private-network-id |  |  |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Delete an existing endpoint

Delete an existing endpoint.

**Usage:**

```shell
scw searchdb endpoint delete [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| endpoint-id | Required | ID of the endpoint to delete |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



## 

List available node types.


### Retrieve a list of available node types

Retrieve a list of available node types.

**Usage:**

```shell
scw searchdb node-types list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc`, `vcpus_asc`, `vcpus_desc`, `memory_asc`, `memory_desc` | Sort order of nodes in the response (name, vcpus or memory) |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |



## 

Manage your Cloud Essentials for OpenSearch deployment users.


### Create a new user

Create a new user.

**Usage:**

```shell
scw searchdb user create [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | ID of the deployment in which to create the user |
| username |  | Username of the deployment user |
| password |  | Password of the deployment user |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Delete an existing user

Delete an existing user.

**Usage:**

```shell
scw searchdb user delete [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | ID of the deployment in which to create the user |
| username | Required | Username of the deployment user |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



### Retrieve a list of deployment users

Retrieve a list of deployment users.

**Usage:**

```shell
scw searchdb user list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `name_asc`, `name_desc` |  |
| name |  |  |
| deployment-id | Required |  |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |



### Update an existing user

Update an existing user.

**Usage:**

```shell
scw searchdb user update [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| deployment-id | Required | ID of the deployment in which to create the user |
| username | Required | Username of the deployment user |
| password |  | Password of the deployment user |
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |



## 

List your Cloud Essentials for OpenSearch versions.


### List available Cloud Essentials for OpenSearch versions

List available Cloud Essentials for OpenSearch versions.

**Usage:**

```shell
scw searchdb versions list [arg=value ...]
```


**Args:**

| Name |   | Description |
|------|---|-------------|
| order-by | One of: `version_asc`, `version_desc` | Define the order of the returned version |
| version |  | Filter by version |
| region | Default: `fr-par`<br />One of: `fr-par`, `all` | Region to target. If none is passed will use default region from the config |