UPupstash
search

Get Search Index

Retrieves detailed information about a specific search index

get/search/{id}

Request

Path parameters

idstring required

The unique ID of the search index to be retrieved

Response

Successfully retrieved specified search index

customer_idstring

The associated ID of the owner of the index

idstring uuid

Unique ID of the index

namestring

Name of the search index

endpointstring

The REST endpoint of the index

type'free' | 'payg' | 'fixed'

The payment plan of the index

region'eu-west-1' | 'us-central1'

The region where the index is currently deployed

vercel_emailstring

The email associated with Vercel integration, if any. Empty string otherwise.

tokenstring

The REST authentication token for the index

read_only_tokenstring

The REST authentication read only token for the search index

max_vector_countinteger

Maximum number of vectors allowed in the index

max_monthly_reranksinteger

Maximum monthly rerank operations (-1 for unlimited)

max_daily_updatesinteger

Maximum daily update operations (-1 for unlimited)

max_daily_queriesinteger

Maximum daily query operations (-1 for unlimited)

max_monthly_bandwidthinteger

Maximum monthly bandwidth in bytes (-1 for unlimited)

max_writes_per_secondinteger

Maximum write operations per second (rate limit)

max_query_per_secondinteger

Maximum query operations per second (rate limit)

max_reads_per_requestinteger

Maximum number of reads allowed per request

max_writes_per_requestinteger

Maximum number of writes allowed per request

creation_timeinteger

Unix timestamp of creation

input_enrichment_enabledboolean

Whether input enrichment is enabled for this index

Example response

{
  "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
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.