Get Search Index
Retrieves detailed information about a specific search index
curl --request GET \
--url https://api.upstash.com/v2/search/{id} \
--header 'Authorization: Bearer <token>'{
"customer_id": "example@upstash.com",
"id": "99a4c327-31f0-490f-a594-043ade84085a",
"name": "mySearchIndex",
"endpoint": "glowing-baboon-15797-us1",
"type": "payg",
"region": "us-central1",
"vercel_email": "example@vercel.com",
"token": "ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==",
"read_only_token": "ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==",
"max_vector_count": 2000000,
"max_monthly_reranks": -1,
"max_daily_updates": -1,
"max_daily_queries": -1,
"max_monthly_bandwidth": -1,
"max_writes_per_second": 1000,
"max_query_per_second": 1000,
"max_reads_per_request": 100,
"max_writes_per_request": 100,
"creation_time": 1761200000,
"input_enrichment_enabled": true,
"throughput_vector": [
{
"x": "2025-10-23 20:54:00.000 +0000 UTC",
"y": 0
}
]
}Authorization
Bearer authentication header of the form Bearer <token>.
Path parameters
The unique ID of the search index to be retrieved
Response
200 — Successfully retrieved specified search index
The associated ID of the owner of the index
Unique ID of the index
Name of the search index
The REST endpoint of the index
The payment plan of the index
The region where the index is currently deployed
The email associated with Vercel integration, if any. Empty string otherwise.
The REST authentication token for the index
The REST authentication read only token for the search index
Maximum number of vectors allowed in the index
Maximum monthly rerank operations (-1 for unlimited)
Maximum daily update operations (-1 for unlimited)
Maximum daily query operations (-1 for unlimited)
Maximum monthly bandwidth in bytes (-1 for unlimited)
Maximum write operations per second (rate limit)
Maximum query operations per second (rate limit)
Maximum number of reads allowed per request
Maximum number of writes allowed per request
Unix timestamp of creation
Whether input enrichment is enabled for this index
Throughput metrics over time