List Indices
This endpoint returns the data related to all indices of an account as a list.
curl -X GET \
https://api.upstash.com/v2/vector/index \
-u 'EMAIL:API_KEY' \
[
{
"customer_id": "test@upstash.com",
"id": "0639864f-ece6-429c-8118-86a287b0e808",
"name": "myindex",
"similarity_function": "COSINE",
"dimension_count": 5,
"endpoint": "test-index-3814-eu1-vector.upstash.io",
"token": "QkZGMk5heGltdW0tdXBkYXRlZC0zNzM1LWV1MkFkbWlOeGZGZ1J5Wm1GdE5tTXhNQzB1TmpsbExUb3hOekF0TVRJbFpqMTJORFUxTm1GZw==",
"read_only_token": "QkZGRk1heGltdW0tdXBkYXRlZC0zNzM1LWV1MnJlYWRvbmx5TmtaZ05qS3JNWVV0Wm1aZ01pMDBOV1poTHRob05qY3RNR0U0TkRjejNqazJU"
"type": "paid",
"region": "eu-west-1",
"max_vector_count": 400000000,
"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": 1000,
"max_writes_per_request": 1000,
"max_total_metadata_size": 53687091200,
"creation_time": 1707313165
}
]
Request Parameters
This endpoint doesn’t require any additional data.
Response Parameters
The associated ID of the owner of the index
Unique ID of the index
The name of the index.
Similarity function that’s used to calculate the distance between two vectors
The amount of values in a single vector
The REST endpoint of the index
The payment plan of the index
The region where the index is currently deployed.
The number of maximum that your index can contain.
The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
The number of maximum query operations you can perform in a day. Only query operations are included in query count.
The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
The number of maximum query operations you can perform per second. Only query operations are included in query count.
The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
The amount of maximum size for the total metadata sizes in your index.
Monthly pricing of your index. Only available for fixed and pro plans.
The creation time of the vector index in UTC as unix timestamp.
curl -X GET \
https://api.upstash.com/v2/vector/index \
-u 'EMAIL:API_KEY' \
[
{
"customer_id": "test@upstash.com",
"id": "0639864f-ece6-429c-8118-86a287b0e808",
"name": "myindex",
"similarity_function": "COSINE",
"dimension_count": 5,
"endpoint": "test-index-3814-eu1-vector.upstash.io",
"token": "QkZGMk5heGltdW0tdXBkYXRlZC0zNzM1LWV1MkFkbWlOeGZGZ1J5Wm1GdE5tTXhNQzB1TmpsbExUb3hOekF0TVRJbFpqMTJORFUxTm1GZw==",
"read_only_token": "QkZGRk1heGltdW0tdXBkYXRlZC0zNzM1LWV1MnJlYWRvbmx5TmtaZ05qS3JNWVV0Wm1aZ01pMDBOV1poTHRob05qY3RNR0U0TkRjejNqazJU"
"type": "paid",
"region": "eu-west-1",
"max_vector_count": 400000000,
"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": 1000,
"max_writes_per_request": 1000,
"max_total_metadata_size": 53687091200,
"creation_time": 1707313165
}
]
Was this page helpful?
curl -X GET \
https://api.upstash.com/v2/vector/index \
-u 'EMAIL:API_KEY' \
[
{
"customer_id": "test@upstash.com",
"id": "0639864f-ece6-429c-8118-86a287b0e808",
"name": "myindex",
"similarity_function": "COSINE",
"dimension_count": 5,
"endpoint": "test-index-3814-eu1-vector.upstash.io",
"token": "QkZGMk5heGltdW0tdXBkYXRlZC0zNzM1LWV1MkFkbWlOeGZGZ1J5Wm1GdE5tTXhNQzB1TmpsbExUb3hOekF0TVRJbFpqMTJORFUxTm1GZw==",
"read_only_token": "QkZGRk1heGltdW0tdXBkYXRlZC0zNzM1LWV1MnJlYWRvbmx5TmtaZ05qS3JNWVV0Wm1aZ01pMDBOV1poTHRob05qY3RNR0U0TkRjejNqazJU"
"type": "paid",
"region": "eu-west-1",
"max_vector_count": 400000000,
"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": 1000,
"max_writes_per_request": 1000,
"max_total_metadata_size": 53687091200,
"creation_time": 1707313165
}
]