Vector Search Deployments¶

1. Go to cloud.scylladb.com and log in to your account, or sign up to create a new user account.

2. Click New Cluster to create a cluster.

3. Configure the required options:

   • Cluster name

   • Cloud provider: AWS or GCP

   • Cluster type: Standard

4. Enable the Vector Search option.

   

   ScyllaDB Cloud will display available instance types with their pricing and the billing summary.

5. Choose the instance type.

6. Click Next.

7. Review the Billing Options page for your cluster. The page displays the number of Vector Search nodes and the associated costs.

   Vector Search UI supports only on-demand billing. If you want to use your existing contract, please contact ScyllaDB Support.

8. Click Next to configure cluster properties.

9. Click Launch Cluster. It will take a few minutes for your cluster to launch.

10. When your cluster is deployed, go to the Connect tab. It displays instructions on how to connect to your cluster.

11. Choose Cqlsh from the left menu and follow the instructions.

To use the ScyllaDB Cloud API, you need to generate a personal API token for authenticating requests to the API endpoints. See Create a Personal Token for Authentication for details.

1. Get your account ID (ACCOUNT_ID):

   curl -X GET "https://api.cloud.scylladb.com/account/default" \
      -H "Authorization: Bearer YOUR_API_TOKEN"
   

   Response looks like:

   {
     "error": "",
     "data": {
        "accountId": 12345,
        "name": "my-account",
        "userId": "12345"
     }
   }
   

   Here 12345 is your ACCOUNT_ID.

2. Create a new cluster that includes the ``vectorSearch`` field in the API request body. Make sure to replace ACCOUNT_ID and YOUR_API_TOKEN with actual values in the example below.

   curl -X POST "https://api.cloud.scylladb.com/account/{ACCOUNT_ID}/cluster" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "clusterName": "my-vector-cluster",
       "cloudProviderId": 1,
       "regionId": 1,
       "scyllaVersion":"2025.4.0~rc0-0.20251001.6969918d3151",
       "numberOfNodes": 3,
       "instanceId": 62,
       "replicationFactor": 3,
       "vectorSearch": {
         "defaultNodes": 1,
         "defaultInstanceTypeId": 176
       }
     }'
   

   This will deploy dedicated vector search nodes in the cluster.

3. Connect to the cluster with cqlsh.

   1. Go to https://cloud.scylladb.com/, choose your cluster and go to the Connect tab.

   2. Choose Cqlsh from the left menu and follow the instructions.

1. Select the cluster where you want to enable Vector Search to open the cluster details page.

2. Check the ScyllaDB Version. Vector Search is supported in ScyllaDB 2025.4 and later.

3. Choose Enable Vector Search from the three-dot menu in the datacenter overview section.

   

   ScyllaDB Cloud will display available instance types with pricing.

4. Choose the Vector Search instance types you want to add to your cluster and click Add Vector Search Instances.

To use the ScyllaDB Cloud API, you need to generate a personal API token for authenticating requests to the API endpoints. See Create a Personal Token for Authentication for details.

Before you deploy new Vector Search nodes, you need to retrieve your account ID, cluster ID, and datacenter (DC) ID.

In the examples below, make sure to replace YOUR_API_TOKEN with your actual access token value.

1. Get your account ID (ACCOUNT_ID):

   curl -X GET "https://api.cloud.scylladb.com/account/default" \
      -H "Authorization: Bearer YOUR_API_TOKEN"
   

   Response looks like:

   {
     "error": "",
     "data": {
        "accountId": 12345,
        "name": "my-account",
        "userId": "12345"
     }
   }
   

   Here 12345 is your ACCOUNT_ID.

2. List your clusters to get your cluster ID:

   curl -X GET "https://api.cloud.scylladb.com/account/{ACCOUNT_ID}/clusters" \
      -H "Authorization: Bearer YOUR_API_TOKEN"
   

   Response looks like:

   {
     "data": {
       "clusters": [
          {
            "id": 6789,
            "name": "my-vector-cluster",
            "status": "ACTIVE"
          }
       ]
     }
    }
   

   Here 6789 is your clusterId.

3. List the datacenters (DCs) for your cluster to get the DC ID.

   curl -X GET "https://api.cloud.scylladb.com/account/{ACCOUNT_ID}/cluster/{CLUSTER_ID}/dcs" \
      -H "Authorization: Bearer YOUR_API_TOKEN"
   

   Response looks like:

   {
     "data": {
       "dataCenters": [
          {
            "id": 222,
            "name": "us-east-1a",
            "status": "ACTIVE"
          }
       ]
     }
   }
   

   Here 222 is the dcId you need for vector store operations.

4. Deploy Vector Search nodes.

   curl -X POST "https://api.cloud.scylladb.com/account/{ACCOUNT_ID}/cluster/{CLUSTER_ID}/dc/{DC_ID}/vector-search" \
     -H "Authorization: Bearer YOUR_API_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
        "defaultNodes": 1,
        "defaultInstanceTypeId": 176
     }'
   

5. Connect to the cluster with cqlsh.

   1. Go to https://cloud.scylladb.com/, choose your cluster and go to the Connect tab.

   2. Choose Cqlsh from the left menu and follow the instructions.

Choose Remove Vector Search from the three-dot menu in the datacenter overview section to disable Vector Search on your cluster.

Disabling Vector Search removes all the Vector Search nodes from your cluster.

Remove Vector Search nodes one by one from the cluster.

To remove all Vector Search nodes from a specific datacenter, send a DELETE request to the Vector Search endpoint. This operation is asynchronous and returns a ClusterRequest object that you can monitor for progress.

curl -X DELETE "https://api.cloud.scylladb.com/account/{ACCOUNT_ID}/cluster/{CLUSTER_ID}/dc/{DC_ID}/vector-search"
   -H "Authorization: Bearer YOUR_API_TOKEN"

The request schedules the removal of all Vector Search nodes from the specified datacenter. A successful response returns HTTP 202 (Accepted) along with a ClusterRequest object that describes the operation.