OpenAPI Specification
openapi: 3.1.0
info:
title: Upstash APIs Kafka Vector API
version: 2.0.0
summary: Developer (management) API and Redis REST API for Upstash.
description: "Upstash exposes two distinct HTTP API surfaces:\n\n1. The Developer (Management) API at https://api.upstash.com/v2 — used\n to programmatically create and administer Upstash Redis, Kafka, and\n Vector databases, teams, and account-level resources. Authentication\n is HTTP Basic using account email + API key.\n\n2. The per-database Redis REST API at https://{endpoint}.upstash.io —\n used to execute Redis commands over HTTPS from edge and serverless\n runtimes. Authentication is a Bearer token scoped to the database\n (or via ?_token=... query parameter).\n\nEndpoint surface confirmed against https://upstash.com/docs/devops/developer-api\nand https://upstash.com/docs/redis/features/restapi.\n"
contact:
name: Upstash Docs
url: https://upstash.com/docs
license:
name: Proprietary
url: https://upstash.com/static/docs/terms.pdf
servers:
- url: https://api.upstash.com/v2
description: Upstash Developer (management) API
- url: https://{endpoint}.upstash.io
description: Per-database Redis REST API endpoint
variables:
endpoint:
default: example-12345
description: Database-specific endpoint hostname from the Upstash console
tags:
- name: Vector
description: Vector index management
paths:
/vector/index:
get:
tags:
- Vector
summary: List vector indexes
operationId: listVectorIndexes
security:
- basicAuth: []
servers:
- url: https://api.upstash.com/v2
responses:
'200':
description: Vector index collection
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VectorIndex'
components:
schemas:
VectorIndex:
type: object
properties:
id:
type: string
name:
type: string
region:
type: string
dimension_count:
type: integer
similarity_function:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic auth with Upstash account email and API key.
bearerAuth:
type: http
scheme: bearer
description: Database-scoped bearer token issued from the Upstash console.