Skip to main content
GET
/
search
/
{id}
Get Search Index
curl --request GET \
  --url https://api.upstash.com/v2/search/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The unique ID of the search index to be retrieved

Response

200 - application/json

Successfully retrieved specified search index

​
customer_id
string

The associated ID of the owner of the index

Example:

"example@upstash.com"

​
id
string<uuid>

Unique ID of the index

Example:

"99a4c327-31f0-490f-a594-043ade84085a"

​
name
string

Name of the search index

Example:

"mySearchIndex"

​
endpoint
string

The REST endpoint of the index

Example:

"glowing-baboon-15797-us1"

​
type
enum<string>

The payment plan of the index

Available options:
free,
payg,
fixed
Example:

"payg"

​
region
enum<string>

The region where the index is currently deployed

Available options:
eu-west-1,
us-central1
Example:

"us-central1"

​
vercel_email
string

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

Example:

"example@vercel.com"

​
token
string

The REST authentication token for the index

Example:

"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

​
read_only_token
string

The REST authentication read only token for the search index

Example:

"ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg=="

​
max_vector_count
integer

Maximum number of vectors allowed in the index

Example:

2000000

​
max_monthly_reranks
integer

Maximum monthly rerank operations (-1 for unlimited)

Example:

-1

​
max_daily_updates
integer

Maximum daily update operations (-1 for unlimited)

Example:

-1

​
max_daily_queries
integer

Maximum daily query operations (-1 for unlimited)

Example:

-1

​
max_monthly_bandwidth
integer

Maximum monthly bandwidth in bytes (-1 for unlimited)

Example:

-1

​
max_writes_per_second
integer

Maximum write operations per second (rate limit)

Example:

1000

​
max_query_per_second
integer

Maximum query operations per second (rate limit)

Example:

1000

​
max_reads_per_request
integer

Maximum number of reads allowed per request

Example:

100

​
max_writes_per_request
integer

Maximum number of writes allowed per request

Example:

100

​
creation_time
integer

Unix timestamp of creation

Example:

1761200000

​
input_enrichment_enabled
boolean

Whether input enrichment is enabled for this index

Example:

true

​
throughput_vector
object[]

Throughput metrics over time

Example:
[
  {
    "x": "2025-10-23 20:54:00.000 +0000 UTC",
    "y": 0
  }
]