List IDs

List all item IDs currently stored in the encrypted index.

Authentication

Required - API key via X-API-Key header:

X-API-Key: cyborg_your_api_key_here

Any valid credential is accepted — the root key or a per-user cdbk_ token. When RBAC is not enabled (CYBORGDB_SERVICE_ROOT_KEY unset), no header is required.

Request Body

{
  "index_name": "my_index",
  "index_key": "64_character_hex_string_representing_32_bytes"
}

Show parameters

string

required

Name of the index to list IDs from

string

32-byte encryption key as a hex string. Required for indexes created with the SDK-supplied KEK path; omit for KMS-backed indexes (the service resolves the key from the index’s stored key envelope).

Response

{
  "ids": [
    "item_1",
    "item_2",
    "item_3",
    "item_4",
    "item_5"
  ],
  "count": 5
}

Show response fields

array[string]

List of all item IDs in the index

integer

Total number of IDs in the index

Exceptions

401 Unauthorized

Authentication failed (invalid API key) or wrong index_key on SDK-supplied indexes — see error model

404 Not Found

Index not found

422 Unprocessable Entity

Invalid request parameters

500 Internal Server Error

Internal server error

Example Usage

Basic List IDs:

curl -X POST "http://localhost:8000/v1/vectors/list_ids" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "my_index",
       "index_key": "your_64_character_hex_key_here"
     }'

With jq processing:

# Get total count
count=$(curl -s -X POST "http://localhost:8000/v1/vectors/list_ids" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "my_index",
       "index_key": "your_64_character_hex_key_here"
     }' | jq '.count')

echo "Index contains $count items"

# List all IDs
curl -s -X POST "http://localhost:8000/v1/vectors/list_ids" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "my_index",
       "index_key": "your_64_character_hex_key_here"
     }' | jq -r '.ids[]'

Check if specific ID exists:

# Check if item exists
id_to_check="item_123"
exists=$(curl -s -X POST "http://localhost:8000/v1/vectors/list_ids" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "my_index",
       "index_key": "your_64_character_hex_key_here"
     }' | jq --arg id "$id_to_check" '.ids | contains([$id])')

if [ "$exists" = "true" ]; then
    echo "Item $id_to_check exists in the index"
else
    echo "Item $id_to_check not found"
fi

This endpoint is useful for auditing index contents, verifying data integrity, and implementing custom batch processing workflows.

For large indexes with many items, consider implementing pagination on the client side by processing the returned IDs in batches.

Introduction

Client

Encrypted Index

Types & Getters

Users (RBAC)

Authentication

Request Body

Response

Exceptions

Example Usage

​Authentication

​Request Body

​Response

​Exceptions

​Example Usage

Authentication

Request Body

Response

Exceptions

Example Usage