email:apikey

Upstash Documentation

General

Redis

Kafka

Vector

QStash

Open Source

DevOps

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

Developer API

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 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

Create a Redis compatible database in seconds

Getting Started

Pricing

Redis® API Compatibility

Use Cases

Compare

Pro and Enterprise Plans

What is Upstash Vector?

Features

Roadmap

This endpoint upserts (adds) a vector to given index. You can also add metadata with the vector.

Upsert Vectors

This endpoint queries a given vector over the existing vectors in the index.

Query Vectors

This endpoint returns the data related to the vectors with the provided IDs.

Fetch Vectors

This endpoint fetches a random vector. Returns null if the index is empty.

Fetch Random Vector

This endpoint returns a range of vectors starting with(including) cursor until the end of the vectors in the index or given limit.

Range Vectors

This endpoint deletes the vectors with given IDs.

Delete Vectors

This endpoint deletes all vectors and all state belonging to the index.

Reset Index

Returns some information about the index; such as `vectorCount`, `indexSize`, `dimension` and `similarityFunction`.

Index Info

Python SDK

Typescript SDK

Go SDK

Build a image similarity search using CLIP and Upstash Vector

Image Search

Image Similarity Search using CLIP

Upsy: a RAG based Slackbot

RAG Chatbot

RAG (Retrieval Augmented Generation) Chatbot with OpenAI and Upstash Vector

Learn Vector Stores

Learn How Vector Stores Work by Building a Recommendation Engine

Semantic Search with Sentence Transformers

Semantic Search using Sentence Transformers and Upstash Vector

Semantic Search with DistilBERT on HuggingFace

Semantic Search with BERT

Semantic Search with OpenAI

Semantic Search with OpenAI and Upstash Vector

Global Database

REST API

Backup/Restore

This article explains the persistence provided by Upstash databases.

Durable Storage

Replication

Eviction

Security

Consistency

Rate Limit SDK

 AWS Lambda

Vercel Functions

Next.js 13

Fly.io

 Cloudflare Workers

Google Cloud Functions

Fastly

DigitalOcean

Supabase Functions

Deno Deploy

Koyeb

Connect Your Client

Connect with TLS

Connect with upstash-redis

Upgrade Your Database

Metrics and Charts

Import/Export Data

Datadog

Datadog - Upstash Redis Integration

Vercel

Vercel - Upstash Redis Integration

EMQX

EMQX - Upstash Redis Integration

In this tutorial, we will implement a Serverless API using AWS Lambda and we will deploy it using AWS CDK.

Deploy a Serverless API with AWS CDK and AWS Lambda

Autocomplete API with Serverless Redis

This tutorial shows how to create a serverless and stateful application using AWS App Runner and Redis

Build Stateful Applications with AWS App Runner and Serverless Redis

This tutorial shows how to manage user sessions on Google Cloud Run using Serverless Redis.

Session Management on Google Cloud Run with Serverless Redis

This tutorial showcases using Redis with REST API in Cloudflare Workers.

Use Redis in Cloudflare Workers

Backendless Coin Price List with GraphQL API, Serverless Redis and Next.JS

This tutorial shows how to build a Leaderboard API At Edge using Cloudflare Workers and Redis.

Build a Leaderboard API At Edge using Cloudflare Workers and Redis

This tutorial shows how to use Upstash as the session storage of your Express application.

Express Session with Serverless Redis

Serverless Golang API with Redis

This tutorial shows how to build a histogram API with Redis.

Build a Serverless Histogram API with Redis

This tutorial shows how to use Upstash Redis for job/task processing.

Job Processing and Event Queue with Serverless Redis

This tutorial shows how to use Upstash inside your Next.js application.

Next.js with Redis

This tutorial shows how to create a Serverless Notification API for Your Web Application with Redis.

Building a Serverless Notification API for Your Web Application with Redis

This tutorial shows how to use Upstash inside your NuxtJS application.

Nuxt.js with Redis

Serverless Python API with Redis

This tutorial shows how to limit rate in AWS Lambda with Serverless Redis.

AWS Lambda Rate Limiting with Serverless Redis

This tutorial shows how to use Upstash with Redisson client.

Serverless Redisson

This is a single page application powered by upstash and next.js.

Roadmap Voting App with Serverless Redis

In this tutorial, we will build a stateful serverless API using Java and Redis on AWS Lambda. The API will simply count the page views and return it as http response.

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.

API

Terraform