email:apikey

Upstash Documentation

General

Redis

Kafka

Vector

QStash

SDKs

Developer API

Console

Discord

Blog

The Upstash API uses the following HTTP Status codes:

HTTP Status Codes

Get Started

Serverless

Scale to Zero

Global Replication

Access Anywhere

Authentication for the Upstash Developer API

Authentication

This endpoint creates a new Redis database.

Create a Redis Database

Create a Redis Database (Global)

Delete Database

This endpoint list all databases of user.

List Databases

This endpoint gets details of a database.

Get Database

This endpoint gets detailed stats of a database.

Get Database Stats

Update Regions (Global)

This endpoint updates the password of a database.

Reset Password

Rename Database

Enable TLS

This endpoint enables eviction for given database.

Enable Eviction

This endpoint disables eviction for given database.

Disable Eviction

This endpoint enables Auto Upgrade for given database.

Enable Auto Upgrade

This endpoint disables Auto Upgrade for given database.

Disable Auto Upgrade

This endpoint moves database under a target team

Move To Team

Create Index

Delete Index

This endpoint returns the data related to all indices of an account as a list.

List Indices

This endpoint returns the data associated to a index.

Get Index

This endpoint is used to transfer an index to another team.

Transfer Index

This endpoint is used to change the name of an index.

Rename Index

This endpoint is used to reset regular and readonly tokens of an index.

Reset Index Passwords

This endpoint is used to change the plan of an index.

Set Index Plan

Create Team

Delete Team

List Teams

This endpoint adds a new team member to the specified team.

Add Team Member

This endpoint deletes a team member from the specified team.

Delete Team Member

This endpoint list all members of a team.

Get Team Members

Getting Started

What is Upstash Vector?

Pricing

Algorithm

Similarity Functions

Vector Similarity Functions

Metadata

Metadata Filtering

Embedding Models

Namespaces

Roadmap

Python SDK

Typescript SDK

Go SDK

Examples Index

Examples

Create a Redis compatible database in seconds

Redis® API Compatibility

Use Cases

Compare

Pro and Enterprise Plans

 AWS Lambda

Vercel Functions

Next.js 13

Tutorial on Using Upstash Redis In Your Phoenix App and Deploying it on Fly.

Elixir

Fly.io

 Cloudflare Workers

Google Cloud Functions

Fastly

DigitalOcean

Supabase Functions

Deno Deploy

Koyeb

Global Database

REST API

Backup/Restore

This article explains the persistence provided by Upstash databases.

Durable Storage

Replication

Eviction

Security

Consistency

Connect Your Client

Connect with TLS

Connect with upstash-redis

Upgrade Your Database

Metrics and Charts

Monitor your usage

Import/Export Data

Listen Keyspace Notifications

Datadog

Datadog - Upstash Redis Integration

Vercel

Vercel - Upstash Redis Integration

EMQX

EMQX - Upstash Redis Integration

NOAUTH Authentication Required

WRONGPASS invalid or missing auth token

Error read ECONNRESET

ERR max concurrent connections exceeded

ERR max request size exceeded

ERR max single record size exceeded

ERR max key size exceeded

ERR max field size exceeded

ERR max member size exceeded

ERR DB capacity quota exceeded

ERR max daily request limit exceeded

ERR XReadGroup is cancelled

Frequently Asked Questions

Create an Account

Teams and Users

Add a Payment Method

Cost Explorer

Payment History

Audit Logs

Account and Billing FAQ

Support & Contact Us

Professional Support

Uptime Monitor

Legal

Compliance

Integration with Third Parties & Partnerships

Kafka API

Credentials

Connect Using Kafka Clients

Connect with upstash-kafka

Produce Messages Using REST API

Fetch Messages Using REST API

Consume Messages Using REST API

Use Serverless Kafka as an Event Source For AWS Lambda

Use Serverless Kafka to Produce Events in AWS Lambda

Use Serverless Kafka to Produce Events in Cloudflare Workers

Connect Using kcat CLI

Connect Using kaf CLI

Introduction

Producer API

Consumer APIs

Metadata API

Webhook API for Kafka

Kafka SDK

How to

Compatibility

Rest API

Deprecation Notice

Supported Connect Plugins

Troubleshooting

MongoDB Source Connector

MongoDB Sink Connector

Debezium MongoDB Source Connector

Debezium Mysql Source Connector

Debezium PostgreSQL Source Connector

Aiven JDBC Source Connector

Aiven JDBC Sink Connector

Google BigQuery Sink Connector

Aiven Amazon S3 Sink Connector

Aiven OpenSearch Sink Connector

Aiven Http Sink Connector

Snowflake Sink Connector

This tutorial shows how to integrate Upstash Kafka with Apache Spark

Apache Spark

This tutorial shows how to integrate Upstash Kafka with Apache Flink

Apache Flink

This tutorial shows how to integrate Upstash Kafka with EMQX Cloud

EMQX Cloud

This tutorial shows how to integrate Upstash Kafka with Apache Pinot

Apache Pinot

This tutorial shows how to set up a pipeline to stream traffic events to Upstash Kafka and analyse with Clickhouse

Code	Description
200	OK	Indicates that a request completed successfully and the response contains data.
400	Bad Request	Your request is invalid.
401	Unauthorized	Your API key is wrong.
403	Forbidden	The kitten requested is hidden for administrators only.
404	Not Found	The specified kitten could not be found.
405	Method Not Allowed	You tried to access a kitten with an invalid method.
406	Not Acceptable	You requested a format that isn’t JSON.
429	Too Many Requests	You’re requesting too many kittens! Slow down!
500	Internal Server Error	We had a problem with our server. Try again later.
503	Service Unavailable	We’re temporarily offline for maintenance. Please try again later.