Skip to main content
GET
/
v1
/
indexes
/
list
Retrieve a list of all available encrypted indexes.

​
Parameters

None

​
Authentication

Required - API key via X-API-Key header: 
X-API-Key: cyborg_your_api_key_here
You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.

​
Response

{
  "indexes": ["my_index", "another_index", "demo_index"]
}
FieldTypeDescription
indexesarray[string]List of available index names

​
Exceptions

  • 401: Authentication failed (invalid API key)
  • 500: Internal server error

​
Example Usage

curl -X GET "http://localhost:8000/v1/indexes/list" \
     -H "X-API-Key: cyborg_your_api_key_here"

# Or with HTTPS
curl -X GET "https://your-domain.com:8000/v1/indexes/list" \
     -H "X-API-Key: cyborg_your_api_key_here"

​
Use Cases

  • Index discovery: Find all available indexes in your deployment
  • Administrative tasks: List indexes for management operations
  • Application initialization: Verify required indexes exist
  • Monitoring: Track index inventory across environments