You can enter multiple credit cards and set one of them as the default one. The
payments will be charged from the default credit card.
## Payment Security
Upstash does not store users' credit card information in its servers. We use
Stripe Inc payment processing company to handle payments. You can read more
about payment security in Stripe
[here](https://stripe.com/docs/security/stripe).
# Audit Logs
Source: https://upstash.com/docs/common/account/auditlogs
Audit logs give you a chronological set of activity records that have affected
your databases and Upstash account. You can see the list of all activities on a
single page. You can access your audit logs under `Account > Audit Logs` in your
console:
Here the `Source` column shows if the action has been called by the console or via
an API key. The `Entity` column gives you the name of the resource that has been
affected by the action. For example, when you delete a database, the name of the
database will be shown here. Also, you can see the IP address which performed the
action.
## Security
You can track your audit logs to detect any unusual activity on your account and
databases. When you suspect any security breach, you should delete the API key
related to suspicious activity and inform us by emailing
[support@upstash.com](mailto:support@upstash.com)
## Retention period
After the retention period, the audit logs are deleted. The retention period for free databases is 7 days, for pay-as-you-go databases, it is 30 days, and for the Pro tier, it is one year.
# AWS Marketplace
Source: https://upstash.com/docs/common/account/awsmarketplace
Once you click subscribe, you will be prompted to select which personal or team account you wish to link with your AWS Subscription.
Once your account is linked, regardless of which Upstash product you use, all of your usage will be billed to your AWS Account. You can also upgrade or downgrade your subscription through Upstash console.
# Cost Explorer
Source: https://upstash.com/docs/common/account/costexplorer
The Cost Explorer pages allow you to view your current and previous months’ costs. To access the Cost Explorer, navigate to the left menu and select Account > Cost Explorer. Below is an example report:
You can select a specific month to view the cost breakdown for that period. Here's the explanation of the fields in the report:
**Request:** This represents the total number of requests sent to the database.
**Storage:** This indicates the average size of the total storage consumed. Upstash database includes a persistence layer for data durability. For example, if you have 1 GB of data in your database throughout the entire month, this value will be 1 GB. Even if your database is empty for the first 29 days of the month and then expands to 30 GB on the last day, this value will still be 1 GB.
**Cost:** This field represents the total cost of your database in US Dollars.
> The values for the current month is updated hourly, so values can be stale up
> to 1 hour.
# Create an Account
Source: https://upstash.com/docs/common/account/createaccount
You can sign up for 
You can download receipt. If one of your payments failed, you can retry your
payment on this page.
# Teams and Users
Source: https://upstash.com/docs/common/account/teams
Team management enables collaboration with other users. You can create a team and invite people to join by using their email addresses. Team members will have access to databases created under the team based on their assigned roles.
## Create Team
You can create a team using the menu `Account > Teams`
> A user can create up to 5 teams. You can be part of even more teams but only
> be the owner of 5 teams. If you need to own more teams please email us at
> [support@upstash.com](mailto:support@upstash.com).
You can still continue using your personal account or switch to a team.
> The databases in your personal account are not shared with anyone. If you want
> your database to be accessible by other users, you need to create it under a
> team.
## Switch Team
You need to switch to the team to create databases shared with other team
members. You can switch to the team via the switch button in the team table. Or
you can click your profile pic in the top right and switch to any team listed
there.
## Add/Remove Team Member
After switching to a team, if you are the Owner or an Admin of the team, you can add team members by navigating to `Account > Teams`. Simply enter their email addresses.It's not an issue if the email addresses are not yet registered with Upstash. Once the user registers with that email, they will gain access to the team. We do not send invitations; when you add a member, they become a member directly. You can also remove members from the same page.
> Only Admins or the Owner can add/remove users.
## Roles
While adding a team member, you will need to select a role. Here are the access rights associated with each role:
* Admin: This role has full access, including the ability to add and remove members, manage databases, and payment methods.
* Dev: This role can create, manage, and delete databases but cannot manage users or payment methods.
* Finance: This role is limited to managing payment methods and cannot manage databases or users.
* Owner: The Owner role has all the access rights of an Admin and, in addition to having the ability to delete the team. This role is automatically assigned to the user who created the team, and you cannot assign it to other members.
> If you want to change a user's role, you will need to delete and re-add them with the desired access rights.
## Delete Team
Only the original creator (owner) can delete a team. Also the team should not
have any active databases, namely all databases under the team should be deleted
first. To delete your team, first you need to switch your personal account then
you can delete your team in the team list under `Account > Teams`.
### SDKs for Popular Languages
To enhance the developer experience, Upstash is developing SDKs in various popular programming languages. These SDKs simplify the process of integrating Upstash services with your applications by providing straightforward methods and functions that abstract the underlying REST API calls.
### Resources
[Redis REST API Docs](/redis/features/restapi)
[QStash REST API Docs](/qstash/api/authentication)
[Redis SDK - Typescript](https://github.com/upstash/upstash-redis)
[Redis SDK - Python](https://github.com/upstash/redis-python)
[QStash SDK - Typescript](https://github.com/upstash/sdk-qstash-ts)
# Global Replication
Source: https://upstash.com/docs/common/concepts/global-replication
Global Replication for Low Latency and High Availability
Upstash Redis automatically replicates your data to the regions you choose, so your application stays fast and responsive-no matter where your users are.
Add or remove regions from a database at any time with zero downtime. Each region acts as a replica, holding a copy of your data for low latency and high availability.
***
## Built for Modern Serverless Architectures
In serverless computing, performance isn't just about fast code—it's also about fast, reliable data access from anywhere in the world. Whether you're using Vercel Functions, Cloudflare Workers, Fastly Compute, or Deno Deploy, your data layer needs to be as distributed and flexible as your compute for best performance.
Upstash Global replicates your Redis data across multiple regions to:
* Minimize round-trip latency
* Guarantee high availability at scale
...even under heavy or dynamic workloads. Our HTTP-based Redis® client is optimized for serverless environments and delivers consistent performance under high concurrency or variable workloads.
As serverless platforms evolve with features like in-function concurrency (e.g. [Vercel's Fluid Compute](https://vercel.com/fluid)), you need a data layer that can keep up. Upstash Redis is a globally distributed, low-latency database that scales with your compute, wherever it runs.
***
## How Global Replication Works
To minimize latency for read operations, we use a replica model. Our tests show sub-millisecond latency for read commands in the same AWS region as the Upstash Redis® instance.
**Read commands are automatically served from the geographically closest replica**:
**Write commands go to the primary database** for consistency. After a successful write, they are replicated to all read replicas:
***
## Available Regions
To create a globally distributed database, select a primary region and the number of read regions:
* Select a primary region for most write operations for best performance.
* Select read regions close to your users for optimized read speeds.
Each request is then automatically served by the closest read replica for maximum performance and minimum latency:
**You can create read replicas in the following regions:**
* AWS US-East-1 (North Virginia)
* AWS US-East-2 (Ohio)
* AWS US-West-1 (North California)
* AWS US-West-2 (Oregon)
* AWS EU-West-1 (Ireland)
* AWS EU-West-2 (London)
* AWS EU-Central-1 (Frankfurt)
* AWS AP-South-1 (Mumbai)
* AWS AP-Northeast-1 (Tokyo)
* AWS AP-Southeast-1 (Singapore)
* AWS AP-Southeast-2 (Sydney)
* AWS SA-East-1 (São Paulo)
Check out [our blog post](https://upstash.com/blog/global-database) to learn more about our global replication philosophy. You can also explore our [live benchmark](https://latency.upstash.com/) to see Upstash Redis latency from different locations around the world.
# Scale to Zero
Source: https://upstash.com/docs/common/concepts/scale-to-zero
Only pay for what you really use.
Traditionally, cloud services required users to predict their resource needs and provision servers or instances based on those predictions. This often led to over-provisioning to handle potential peak loads, resulting in paying for unused resources during periods of low demand.
By *scaling to zero*, our pricing model aligns more closely with actual usage.
## Pay for usage
You're only charged for the resources you actively use. When your application experiences low activity or no incoming requests, the system automatically scales down resources to a minimal level. This means you're no longer paying for idle capacity, resulting in cost savings.
## Flexibility
"Scaling to zero" offers flexibility in scaling both up and down. As your application experiences traffic spikes, the system scales up resources to meet demand. Conversely, during quiet periods, resources scale down.
## Focus on Innovation
Developers can concentrate on building and improving the application without constantly worrying about resource optimization. Upstash handles the scaling, allowing developers to focus on creating features that enhance user experiences.
In essence, this aligns pricing with actual utilization, increases cost efficiency, and promotes a more sustainable approach to resource consumption. This model empowers businesses to leverage cloud resources without incurring unnecessary expenses, making cloud computing more accessible and attractive to a broader range of organizations.
# Serverless
Source: https://upstash.com/docs/common/concepts/serverless
What do we mean by serverless?
Upstash is a modern serverless data platform. But what do we mean by serverless?
## No Server Management
In a serverless setup, developers don't need to worry about configuring or managing servers. We take care of server provisioning, scaling, and maintenance.
## Automatic Scaling
As traffic or demand increases, Upstash automatically scales the required resources to handle the load. This means applications can handle sudden spikes in traffic without manual intervention.
## Granular Billing
We charge based on the actual usage of resources rather than pre-allocated capacity. This can lead to more cost-effective solutions, as users only pay for what they consume. [Read more](/common/concepts/scale-to-zero)
## Stateless Functions
In serverless architectures, functions are typically stateless. However, the traditional approach involves establishing long-lived connections to databases, which can lead to issues in serverless environments if connections aren't properly managed after use. Additionally, there are scenarios where TCP connections may not be feasible. Upstash addresses this issue by offering access via HTTP, a universally available protocol across all platforms.
## Rapid Deployment
Fast iteration is the key to success in today's competitive environment. You can create a new Upstash database in seconds, with minimal required configuration.
# Account & Teams
Source: https://upstash.com/docs/common/help/account
## Create an Account
You can sign up to 
3. Enter a name for your key. You can not use the same name for multiple keys.
You need to download or copy/save your API key. Upstash does not remember or
keep your API for security reasons. So if you forget your API key, it becomes
useless; you need to create a new one.
You can create multiple keys. It is recommended to use different keys in different applications. By default one user can create up to 37 API keys. If you need more than that, please send us an email at [support@upstash.com](mailto:support@upstash.com) ### Deleting an API key When an API key is exposed (e.g. accidentally shared in a public repository) or not being used anymore; you should delete it. You can delete the API keys in `Account > API Keys` screen. ### Roadmap **Role based access:** You will be able to create API keys with specific privileges. For example you will be able to create a key with read-only access. **Stats:** We will provide reports based on usage of your API keys. # Create Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/create_backup devops/developer-api/openapi.yml post /redis/create-backup/{id} This endpoint creates a backup for a Redis database. # Delete Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/delete_backup devops/developer-api/openapi.yml delete /redis/delete-backup/{id}/{backup_id} This endpoint deletes a backup of a Redis database. # Disable Daily Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/disable_dailybackup devops/developer-api/openapi.yml patch /redis/disable-dailybackup/{id} This endpoint disables daily backup for a Redis database. # Enable Daily Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/enable_dailybackup devops/developer-api/openapi.yml patch /redis/enable-dailybackup/{id} This endpoint enables daily backup for a Redis database. # List Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/list_backup devops/developer-api/openapi.yml get /redis/list-backup/{id} This endpoint lists all backups for a Redis database. # Restore Backup Source: https://upstash.com/docs/devops/developer-api/redis/backup/restore_backup devops/developer-api/openapi.yml post /redis/restore-backup/{id} This endpoint restores data from an existing backup. # Change Database Plan Source: https://upstash.com/docs/devops/developer-api/redis/change_plan devops/developer-api/openapi.yml post /redis/change-plan/{id} This endpoint changes the plan of a Redis database. # Create Redis Database Source: https://upstash.com/docs/devops/developer-api/redis/create_database_global devops/developer-api/openapi.yml post /redis/database This endpoint creates a new Redis database. # Delete Database Source: https://upstash.com/docs/devops/developer-api/redis/delete_database devops/developer-api/openapi.yml delete /redis/database/{id} This endpoint deletes a database. # Disable Auto Upgrade Source: https://upstash.com/docs/devops/developer-api/redis/disable_autoscaling devops/developer-api/openapi.yml post /redis/disable-autoupgrade/{id} This endpoint disables Auto Upgrade for given database. # Disable Eviction Source: https://upstash.com/docs/devops/developer-api/redis/disable_eviction devops/developer-api/openapi.yml post /redis/disable-eviction/{id} This endpoint disables eviction for given database. # Enable Auto Upgrade Source: https://upstash.com/docs/devops/developer-api/redis/enable_autoscaling devops/developer-api/openapi.yml post /redis/enable-autoupgrade/{id} This endpoint enables Auto Upgrade for given database. # Enable Eviction Source: https://upstash.com/docs/devops/developer-api/redis/enable_eviction devops/developer-api/openapi.yml post /redis/enable-eviction/{id} This endpoint enables eviction for given database. # Enable TLS Source: https://upstash.com/docs/devops/developer-api/redis/enable_tls devops/developer-api/openapi.yml post /redis/enable-tls/{id} This endpoint enables tls on a database. # Get Database Source: https://upstash.com/docs/devops/developer-api/redis/get_database devops/developer-api/openapi.yml get /redis/database/{id} This endpoint gets details of a database. # Get Database Stats Source: https://upstash.com/docs/devops/developer-api/redis/get_database_stats devops/developer-api/openapi.yml get /redis/stats/{id} This endpoint gets detailed stats of a database. # List Databases Source: https://upstash.com/docs/devops/developer-api/redis/list_databases devops/developer-api/openapi.yml get /redis/databases This endpoint list all databases of user. # Move To Team Source: https://upstash.com/docs/devops/developer-api/redis/moveto_team devops/developer-api/openapi.yml post /redis/move-to-team This endpoint moves database under a target team # Rename Database Source: https://upstash.com/docs/devops/developer-api/redis/rename_database devops/developer-api/openapi.yml post /redis/rename/{id} This endpoint renames a database. # Reset Password Source: https://upstash.com/docs/devops/developer-api/redis/reset_password devops/developer-api/openapi.yml post /redis/reset-password/{id} This endpoint updates the password of a database. # Update Database Budget Source: https://upstash.com/docs/devops/developer-api/redis/update_budget devops/developer-api/openapi.yml patch /redis/update-budget/{id} This endpoint updates the monthly budget of a Redis database. # Update Regions Source: https://upstash.com/docs/devops/developer-api/redis/update_regions devops/developer-api/openapi.yml post /redis/update-regions/{id} Update the regions of a database # Add Team Member Source: https://upstash.com/docs/devops/developer-api/teams/add_team_member devops/developer-api/openapi.yml post /teams/member This endpoint adds a new team member to the specified team. # Create Team Source: https://upstash.com/docs/devops/developer-api/teams/create_team devops/developer-api/openapi.yml post /team This endpoint creates a new team. # Delete Team Source: https://upstash.com/docs/devops/developer-api/teams/delete_team devops/developer-api/openapi.yml delete /team/{id} This endpoint deletes a team. # Delete Team Member Source: https://upstash.com/docs/devops/developer-api/teams/delete_team_member devops/developer-api/openapi.yml delete /teams/member This endpoint deletes a team member from the specified team. # Get Team Members Source: https://upstash.com/docs/devops/developer-api/teams/get_team_members devops/developer-api/openapi.yml get /teams/{team_id} This endpoint list all members of a team. # List Teams Source: https://upstash.com/docs/devops/developer-api/teams/list_teams devops/developer-api/openapi.yml get /teams This endpoint lists all teams of user. # Create Index Source: https://upstash.com/docs/devops/developer-api/vector/create_index devops/developer-api/openapi.yml post /vector/index This endpoint creates an index. # Delete Index Source: https://upstash.com/docs/devops/developer-api/vector/delete_index devops/developer-api/openapi.yml delete /vector/index/{id} This endpoint deletes an index. # Get Index Source: https://upstash.com/docs/devops/developer-api/vector/get_index devops/developer-api/openapi.yml get /vector/index/{id} This endpoint returns the data associated to a index. # List Indices Source: https://upstash.com/docs/devops/developer-api/vector/list_indices devops/developer-api/openapi.yml get /vector/index This endpoint returns the data related to all indices of an account as a list. # Rename Index Source: https://upstash.com/docs/devops/developer-api/vector/rename_index devops/developer-api/openapi.yml post /vector/index/{id}/rename This endpoint is used to change the name of an index. # Reset Index Passwords Source: https://upstash.com/docs/devops/developer-api/vector/reset_index_passwords devops/developer-api/openapi.yml post /vector/index/{id}/reset-password This endpoint is used to reset regular and readonly tokens of an index. # Set Index Plan Source: https://upstash.com/docs/devops/developer-api/vector/set_index_plan devops/developer-api/openapi.yml post /vector/index/{id}/setplan This endpoint is used to change the plan of an index. # Transfer Index Source: https://upstash.com/docs/devops/developer-api/vector/transfer_index devops/developer-api/openapi.yml post /vector/index/{id}/transfer This endpoint is used to transfer an index to another team. Transferring to a personal account is not supported. However, transferring an index from a personal account to a team is allowed. # Overview Source: https://upstash.com/docs/devops/pulumi/overview The Upstash Pulumi Provider lets you manage [Upstash](https://upstash.com) Redis resources programmatically. You can find the Github Repository [here](https://github.com/upstash/pulumi-upstash). ## Installing This package is available for several languages/platforms: ### Node.js (JavaScript/TypeScript) To use from JavaScript or TypeScript in Node.js, install using either `npm`: ```bash theme={"system"} npm install @upstash/pulumi ``` or `yarn`: ```bash theme={"system"} yarn add @upstash/pulumi ``` ### Python To use from Python, install using `pip`: ```bash theme={"system"} pip install upstash_pulumi ``` ### Go To use from Go, use `go get` to grab the latest version of the library: ```bash theme={"system"} go get github.com/upstash/pulumi-upstash/sdk/go/... ``` ## Configuration The following configuration points are available for the `upstash` provider: * `upstash:apiKey` (environment: `UPSTASH_API_KEY`) - the API key for `upstash`. Can be obtained from the [console](https://console.upstash.com). * `upstash:email` (environment: `UPSTASH_EMAIL`) - owner email of the resources ## Some Examples ### TypeScript: ```typescript theme={"system"} import * as pulumi from "@pulumi/pulumi"; import * as upstash from "@upstash/pulumi"; // multiple redis databases in a single for loop for (let i = 0; i < 5; i++) { new upstash.RedisDatabase("mydb" + i, { databaseName: "pulumi-ts-db" + i, region: "eu-west-1", tls: true, }); } ``` ### Go: ```go theme={"system"} package main import ( "github.com/pulumi/pulumi/sdk/v3/go/pulumi" "github.com/upstash/pulumi-upstash/sdk/go/upstash" ) func main() { pulumi.Run(func(ctx *pulumi.Context) error { createdTeam, err := upstash.NewTeam(ctx, "exampleTeam", &upstash.TeamArgs{ TeamName: pulumi.String("pulumi go team"), CopyCc: pulumi.Bool(false), TeamMembers: pulumi.StringMap{ "
To view a more detailed Next.js quick start guide for setting up QStash, refer to the [quick start](/qstash/quickstarts/vercel-nextjs) guide.
It's also possible to schedule a background job to run at a later time using [schedules](/qstash/features/schedules).
If you'd like to invoke another endpoint when the background job is complete, you can use [callbacks](/qstash/features/callbacks).
# Batching
Source: https://upstash.com/docs/qstash/features/batch
[Publishing](/qstash/howto/publishing) is great for sending one message
at a time, but sometimes you want to send a batch of messages at once.
This can be useful to send messages to a single or multiple destinations.
QStash provides the `batch` endpoint to help
you with this.
If the format of the messages are valid, the response will be an array of
responses for each message in the batch. When batching URL Groups, the response
will be an array of responses for each destination in the URL Group. If one
message fails to be sent, that message will have an error response, but the
other messages will still be sent.
1. You publish a message to QStash using the `/v2/publish` endpoint
2. QStash will enqueue the message and deliver it to the destination
3. QStash waits for the response from the destination
4. When the response is ready, QStash calls your callback URL with the response
Callbacks publish a new message with the response to the callback URL. Messages
created by callbacks are charged as any other message.
## How do I use Callbacks?
You can add a callback url in the `Upstash-Callback` header when publishing a
message. The value must be a valid URL.
1. **Retry** - Republish the message and remove it from the dead letter queue. Republished messages are just like any other message and will be retried automatically if they fail.
2. **Delete** - Delete the message from the dead letter queue.
## Limitations
Dead letter queues are subject only to a retention period that depends on your plan. Messages are deleted when their retention period expires. See the “Max DLQ Retention” row on the [QStash Pricing](https://upstash.com/pricing/qstash) page.
# Flow Control
Source: https://upstash.com/docs/qstash/features/flowcontrol
FlowControl enables you to limit the number of messages sent to your endpoint via delaying the delivery.
There are two limits that you can set with the FlowControl feature: [Rate](#rate-limit) and [Parallelism](#parallelism-limit).
And if needed both parameters can be [combined](#rate-and-parallelism-together).
For the `FlowControl`, you need to choose a key first. This key is used to count the number of calls made to your endpoint.
There are not limits to number of keys you can use.
Also you can get the same info using the REST API.
* [List All Flow Control Keys](/qstash/api/flow-control/list).
* [Single Flow Control Key](/qstash/api/flow-control/get).
# Queues
Source: https://upstash.com/docs/qstash/features/queues
The queue concept in QStash allows ordered delivery (FIFO).
See the [API doc](/qstash/api/queues/upsert) for the full list of related Rest APIs.
Here we list common use cases for Queue and how to use them.
## Ordered Delivery
With Queues, the ordered delivery is guaranteed by default.
This means:
* Your messages will be queued without blocking the REST API and sent one by one in FIFO order. Queued means [CREATED](/qstash/howto/debug-logs) event will be logged.
* The next message will wait for retries of the current one if it can not be delivered because your endpoint returns non-2xx code.
In other words, the next message will be [ACTIVE](/qstash/howto/debug-logs) only after the last message is either [DELIVERED](/qstash/howto/debug-logs) or
[FAILED](/qstash/howto/debug-logs).
* Next message will wait for [callbacks](/qstash/features/callbacks#what-is-a-callback) or [failure callbacks](/qstash/features/callbacks#what-is-a-failure-callback) to finish.
Send this token along with every request made to `QStash` inside the
`Authorization` header like this:
```
"Authorization": "Bearer 
Either you or a previously setup schedule will create a message.
When a message is ready for execution, it will be become `ACTIVE` and a delivery to
your API is attempted.
If you API responds with a status code between `200 - 299`, the task is
considered successful and will be marked as `DELIVERED`.
Otherwise the message is being retried if there are any retries left and moves to `RETRY`. If all retries are exhausted, the task has `FAILED` and the message will be moved to the DLQ.
During all this a message can be cancelled via [DELETE /v2/messages/:messageId](https://docs.upstash.com/qstash/api/messages/cancel). When the request is received, `CANCEL_REQUESTED` will be logged first.
If retries are not exhausted yet, in the next deliver time, the message will be marked as `CANCELLED` and will be completely removed from the system.
## Console
Head over to the [Upstash Console](https://console.upstash.com/qstash) and go to
the `Logs` tab, where you can see the latest status of your messages.
# Delete Schedules
Source: https://upstash.com/docs/qstash/howto/delete-schedule
Deleting schedules can be done using the [schedules api](/qstash/api/schedules/remove).
# Local Development
Source: https://upstash.com/docs/qstash/howto/local-development
QStash requires a publicly available API to send messages to.
During development when applications are not yet deployed, developers typically need to expose their local API by creating a public tunnel.
While local tunneling works seamlessly, it requires code changes between development and production environments and increase friction for developers.
To simplify the development process, Upstash provides QStash CLI, which allows you to run a development server locally for testing and development.
## Docker
QStash CLI is available as a Docker image through our public AWS ECR repository:
```javascript theme={"system"}
// Pull the image
docker pull public.ecr.aws/upstash/qstash:latest
// Run the image
docker run -p 8080:8080 public.ecr.aws/upstash/qstash:latest qstash dev
```
## Artifact Repository
You can download the binary directly from our artifact repository without using a package manager:
[https://artifacts.upstash.com/#qstash/versions/](https://artifacts.upstash.com/#qstash/versions/)
Select the appropriate version, architecture, and operating system for your platform.
After extracting the archive file, run the executable:
```
$ ./qstash dev
```
## QStash CLI
Currently, the only available command for QStash CLI is `dev`, which starts a development server instance.
```
$ ./qstash dev --help
Usage of dev:
-port int
The port to start HTTP server at [env QSTASH_DEV_PORT] (default 8080)
-quota string
The quota of users [env QSTASH_DEV_QUOTA] (default "payg")
```
There are predefined test users available. You can configure the quota type of users using the `-quota` option, with available options being `payg` and `pro`.
These quotas don't affect performance but allow you to simulate different server limits based on the subscription tier.
After starting the development server using any of the methods above, it will display the necessary environment variables.
Select and copy the credentials from one of the following test users:
Afterwards you should immediately update your token in all your applications.
# Roll Your Signing Keys
Source: https://upstash.com/docs/qstash/howto/roll-signing-keys
Because your API needs to be publicly accessible from the internet, you should
make sure to verify the authenticity of each request.
Upstash provides a JWT with each request. This JWT is signed by your individual
secret signing keys. [Read more](/qstash/howto/signature).
We are using 2 signing keys:
* current: This is the key used to sign the JWT.
* next: This key will be used to sign after you have rolled your keys.
If we were using only a single key, there would be some time between when you
rolled your keys and when you can edit the key in your applications. In order to
minimize downtime, we use 2 keys and you should always try to verify with both
keys.
## What happens when I roll my keys?
When you roll your keys, the current key will be replaced with the next key and
a new next key will be generated.
```
currentKey = nextKey
nextKey = generateNewKey()
```
# Verify Signatures
Source: https://upstash.com/docs/qstash/howto/signature
We send a JWT with each request. This JWT is signed by your individual secret
signing key and sent in the `Upstash-Signature` HTTP header.
You can use this signature to verify the request is coming from QStash.
After creating the URL Group, you can add endpoints to it:
## API
You can create a URL Group and endpoint using the [console](https://console.upstash.com/qstash) or [REST API](/qstash/api/url-groups/add-endpoint).
Click "Install" to add Upstash to your Datadog account.
## **Step 3: Connect Accounts**
After installing Upstash, click "Connect Accounts". Datadog will redirect you to Upstash to complete account linking.
## **Step 4: Select Account to Integrate**
1. On Upstash, select the Datadog account to integrate.
2. Personal and team accounts are supported.
**Caveats**
* The integration can be established once at a time. To change the account scope (e.g., add/remove teams), re-establish the integration from scratch.
## **Step 5: Wait for Metrics Availability**
Once the integration is completed, metrics from QStash (publish counts, success/error rates, retries, DLQ, schedule executions) will start appearing in Datadog dashboards shortly.
## **Step 6: Datadog Integration Removal Process**
From Datadog → Integrations → Upstash, press "Remove" to break the connection.
### Confirm Removal
Upstash will stop publishing metrics after removal. Ensure any Datadog API keys/configurations for this integration are also removed on the Datadog side.
## **Conclusion**
You’ve connected Datadog with Upstash QStash. Explore Datadog dashboards to monitor message delivery performance and reliability.
If you need help, contact support.
# LLM - OpenAI
Source: https://upstash.com/docs/qstash/integrations/llm
QStash has built-in support for calling LLM APIs. This allows you to take advantage of QStash features such as retries, callbacks, and batching while using LLM APIs.
QStash is especially useful for LLM processing because LLM response times are often highly variable. When accessing LLM APIs from serverless runtimes, invocation timeouts are a common issue. QStash offers an HTTP timeout of 2 hours, which is sufficient for most LLM use cases. By using callbacks and the workflows, you can easily manage the asynchronous nature of LLM APIs.
## QStash LLM API
You can publish (or enqueue) single LLM request or batch LLM requests using all existing QStash features natively. To do this, specify the destination `api` as `llm` with a valid provider. The body of the published or enqueued message should contain a valid chat completion request. For these integrations, you must specify the `Upstash-Callback` header so that you can process the response asynchronously. Note that streaming chat completions cannot be used with them. Use [the chat API](#chat-api) for streaming completions.
All the examples below can be used with **OpenAI-compatible LLM providers**.
### Publishing a Chat Completion Request
***
### Step 2: Import QStash Configurations to HTTP Node
1. Go to Upstash Console and open QStash Request Builder Tab.
2. Fill out the fields to create an QStash Request. (Publish, Enqueue, Schedule)
3. Copy the cURL snippet created for you, representing your request.
4. Back to the n8n, in HTTP Request Parameters tab, use import cURL.
5. Paste the cURL snippet that you copied in the console, and let n8n to fill out the form for you.
***
### Step 3: Test the Workflow
1. Execute workflow.
2. Visit the Webhook URL.
3. That's it! You can check the logs in the Qstash Console to confirm your QStash Request is working.
# Pipedream
Source: https://upstash.com/docs/qstash/integrations/pipedream
Build and run workflows with 1000s of open source triggers and actions across 900+ apps.
[Pipedream](https://pipedream.com) allows you to build and run workflows with
1000s of open source triggers and actions across 900+ apps.
Check out the [official integration](https://pipedream.com/apps/qstash).
## Trigger a Pipedream workflow from a QStash topic message
This is a step by step guide on how to trigger a Pipedream workflow from a
QStash topic message.
Alternatively [click here](https://pipedream.com/new?h=tch_3egfAX) to create a
new workflow with this QStash topic trigger added.
### 1. Create a Topic in QStash
If you haven't yet already, create a **Topic** in the
[QStash dashboard](https://console.upstash.com/qstash?tab=topics).
### 2. Create a new Pipedream workflow
Sign into [Pipedream](https://pipedream.com) and create a new workflow.
### 3. Add QStash Topic Message as a trigger
In the workflow **Trigger** search for QStash and select the **Create Topic
Endpoint** trigger.
Then, connect your QStash account by clicking the QStash prop and retrieving
your token from the
[QStash dashboard](https://console.upstash.com/qstash?tab=details).
After connecting your QStash account, click the **Topic** prop, a dropdown will
appear containing the QStash topics on your account.
Then *click* on a specific topic to listen for new messages on.
Finally, *click* **Continue**. Pipedream will create a unique HTTP endpoint and
add it to your QStash topic.
### 4. Test with a sample message
Use the *Request Builder* in the
[QStash dashboard](https://console.upstash.com/qstash?tab=details) to publish a
test message to your topic.
Alternatively, you can use the **Create topic message** action in a Pipedream
workflow to send a message to your topic.
*Don't forget* to use this action in a separate workflow, otherwise you might
cause an infinite loop of messages between QStash and Pipedream.
### 5. Add additional steps
Add additional steps to the workflow by clicking the plus icon beneath the
Trigger step.
Build a workflow with the 1,000+ pre-built components available in Pipedream,
including [Airtable](https://pipedream.com/apps/airtable),
[Google Sheets](https://pipedream.com/apps/google-sheets),
[Slack](https://pipedream.com/apps/slack) and many more.
Alternatively, use [Node.js](https://pipedream.com/docs/code/nodejs) or
[Python](https://pipedream.com/docs/code/python) code steps to retrieve,
transform, or send data to other services.
### 6. Deploy your Pipedream workflow
After you're satisfied with your changes, click the **Deploy** button in the
top right of your Pipedream workflow. Your deployed workflow will not
automatically process new messages to your QStash topic. Collapse
quickstart-trigger-pipedream-workflow-from-topic.md 3 KB
### Video tutorial
If you prefer video, you can check out this tutorial by
[pipedream](https://pipedream.com).
[](https://www.youtube.com/watch?v=-oXlWuxNG5A)
## Trigger a Pipedream workflow from a QStash topic message
This is a step by step guide on how to trigger a Pipedream workflow from a
QStash endpoint message.
Alternatively [click here](https://pipedream.com/new?h=tch_m5ofX6) to create a
pre-configured workflow with the HTTP trigger and QStash webhook verification
step already added.
### 1. Create a new Pipedream workflow
Sign into [Pipedream](https://pipedream.com) and create a new workflow.
### 2. Configure the workflow with an HTTP trigger
In the workflow **Trigger** select the **New HTTP / Webhook Requests** option.
Pipedream will create a unique HTTP endpoint for your workflow.
Then configure the HTTP trigger to *return a custom response*. By default
Pipedream will always return a 200 response, which allows us to return a non-200
response to QStash to retry the workflow again if there's an error during the
execution of the QStash message.
Lastly, set the **Event Body** to be a **Raw request**. This will make sure the
QStash verify webhook action receives the data in the correct format.
### 3. Test with a sample message
Use the *Request Builder* in the
[QStash dashboard](https://console.upstash.com/qstash?tab=details) to publish a
test message to your topic.
Alternatively, you can use the **Create topic message** action in a Pipedream
workflow to send a message to your topic.
*Don't forget* to use this action in a separate workflow, otherwise you might
cause an infinite loop of messages between QStash and Pipedream.
### 4. Verify the QStash webhook
Pipedream has a pre-built QStash action that will verify the content of incoming
webhooks from QStash.
First, search for **QStash** in the step search bar, then select the QStash app.
Of the available actions, select the **Verify Webhook** action.
Then connect your QStash account and select the **HTTP request** prop. In the
dropdown, click **Enter custom expression** and then paste in
`{{ steps.trigger.event }}`.
This step will automatically verify the incoming HTTP requests and exit the
workflow early if requests are not from QStash.
### 5. Add additional steps
Add additional steps to the workflow by clicking the plus icon beneath the
Trigger step.
Build a workflow with the 1,000+ pre-built components available in Pipedream,
including [Airtable](https://pipedream.com/apps/airtable),
[Google Sheets](https://pipedream.com/apps/google-sheets),
[Slack](https://pipedream.com/apps/slack) and many more.
Alternatively, use [Node.js](https://pipedream.com/docs/code/nodejs) or
[Python](https://pipedream.com/docs/code/python) code steps to retrieve,
transform, or send data to other services.
### 6. Return a 200 response
In the final step of your workflow, return a 200 response by adding a new step
and selecting **Return an HTTP Response**.
This will generate Node.js code to return an HTTP response to QStash using the
`$.respond` helper in Pipedream.
### 7. Deploy your Pipedream workflow
After you're satisfied with your changes, click the **Deploy** button in the
top right of your Pipedream workflow. Your deployed workflow will not
automatically process new messages to your QStash topic.
### Video tutorial
If you prefer video, you can check out this tutorial by
[pipedream](https://pipedream.com).
[](https://youtu.be/uG8eO7BNok4)
# Prometheus - Upstash QStash Integration
Source: https://upstash.com/docs/qstash/integrations/prometheus
To monitor your QStash metrics in Prometheus and visualize in Grafana, follow these steps:
## **Step 2: Copy Monitoring Token**
1. After enabling, a monitoring token is generated and displayed.
2. Copy the token. It will be used to authenticate Prometheus requests.
## **Step 3: Configure Prometheus (via Grafana Data Source)**
1. In Grafana, add a Prometheus data source.
2. Set the address to `https://api.upstash.com/monitoring/prometheus`.
3. In HTTP headers, add the monitoring token.
Click Test and Save.
## **Step 4: Import Dashboard**
You can use the Upstash Grafana dashboard to visualize QStash metrics.
Open the import dialog and use: Upstash QStash Dashboard
## **Conclusion**
You’ve integrated QStash with Prometheus. Use Grafana to explore message throughput, retries, DLQ, schedules, and Upstash Workflows.
If you encounter issues, contact support.
# Email - Resend
Source: https://upstash.com/docs/qstash/integrations/resend
The `qstash-js` SDK offers an integration to easily send emails using [Resend](https://resend.com/), streamlining email delivery in your applications.
## Basic Email Sending
To send a single email, use the `publishJSON` method with the `resend` provider. Ensure your `QSTASH_TOKEN` and `RESEND_TOKEN` are set for authentication.
```typescript theme={"system"}
import { Client, resend } from "@upstash/qstash";
const client = new Client({ token: "It works!
", }, }); ``` In the `body` field, specify any parameters supported by [the Resend Send Email API](https://resend.com/docs/api-reference/emails/send-email), such as `from`, `to`, `subject`, and `html`. ## Sending Batch Emails To send multiple emails at once, use Resend’s [Batch Email API](https://resend.com/docs/api-reference/emails/send-batch-emails). Set the `batch` option to `true` to enable batch sending. Each email configuration is defined as an object within the `body` array. ```typescript theme={"system"} await client.publishJSON({ api: { name: "email", provider: resend({ token: "It works!
", }, { from: "AcmeIt works!
", }, ], }); ``` Each entry in the `body` array represents an individual email, allowing customization of `from`, `to`, `subject`, `html`, and any other Resend-supported fields. # Development Server License Agreement Source: https://upstash.com/docs/qstash/misc/license ## 1. Purpose and Scope This software is a development server implementation of QStash API ("Development Server") provided for testing and development purposes only. It is not intended for production use, commercial deployment, or as a replacement for the official QStash service. ## 2. Usage Restrictions By using this Development Server, you agree to the following restrictions: a) The Development Server may only be used for: * Local development and testing * Continuous Integration (CI) testing * Educational purposes * API integration development b) The Development Server may NOT be used for: * Production environments * Commercial service offerings * Public-facing applications * Operating as a Software-as-a-Service (SaaS) * Reselling or redistributing as a service ## 3. Restrictions on Modification and Reverse Engineering You may not: * Decompile, reverse engineer, disassemble, or attempt to derive the source code of the Development Server * Modify, adapt, translate, or create derivative works based upon the Development Server * Remove, obscure, or alter any proprietary rights notices within the Development Server * Attempt to bypass or circumvent any technical limitations or security measures in the Development Server ## 4. Technical Limitations Users acknowledge that the Development Server: * Operates entirely in-memory without persistence * Provides limited functionality compared to the official service * Offers no data backup or recovery mechanisms * Has no security guarantees * May have performance limitations * Does not implement all features of the official service ## 5. Warranty Disclaimer THE DEVELOPMENT SERVER IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. THE AUTHORS OR COPYRIGHT HOLDERS SHALL NOT BE LIABLE FOR ANY CLAIMS, DAMAGES, OR OTHER LIABILITY ARISING FROM THE USE OF THE SOFTWARE IN VIOLATION OF THIS LICENSE. ## 6. Termination Your rights under this license will terminate automatically if you fail to comply with any of its terms. Upon termination, you must cease all use of the Development Server. ## 7. Acknowledgment By using the Development Server, you acknowledge that you have read this license, understand it, and agree to be bound by its terms. # API Examples Source: https://upstash.com/docs/qstash/overall/apiexamples ### Use QStash via: * cURL * [Typescript SDK](https://github.com/upstash/sdk-qstash-ts) * [Python SDK](https://github.com/upstash/qstash-python) Below are some examples to get you started. You can also check the [how to](/qstash/howto/publishing) section for more technical details or the [API reference](/qstash/api/messages) to test the API. ### Publish a message to an endpoint Simple example to [publish](/qstash/howto/publishing) a message to an endpoint.
### Publish a message
A message can be any shape or form: json, xml, binary, anything, that can be
transmitted in the http request body. We do not impose any restrictions other
than a size limit of 1 MB (which can be customized at your request).
In addition to the request body itself, you can also send HTTP headers. Learn
more about this in the [message publishing section](/qstash/howto/publishing).
### Check Message Status
Head over to [Upstash Console](https://console.upstash.com/qstash) and go to the
`Logs` tab where you can see your message activities.
Learn more about different states [here](/qstash/howto/debug-logs).
## Features and Use Cases
The URL you use to invoke your function typically follows this format, especially if you follow the same stack configuration as shown above:
`https://
and make these two variables available to your Lambda in your function configuration:
Tada, we just deployed a live Lambda with the AWS CDK! 🎉
### Manual Deployment
1. Create a new Lambda function by going to the [AWS dashboard](https://us-east-1.console.aws.amazon.com/lambda/home?region=us-east-1#/create/function) for your desired lambda region. Give your new function a name and select `Node.js 20.x` as runtime, then create the function.
2. To make this Lambda available under a public URL, navigate to the `Configuration` tab and click `Function URL`:
3. In the following dialog, you'll be asked to select one of two authentication types. Select `NONE`, because we are handling authentication ourselves. Then, click `Save`.
You'll see the function URL on the right side of your function overview:
4. Get your current and next signing key from the
[Upstash Console](https://console.upstash.com/qstash).
5. Still under the `Configuration` tab, set the `QSTASH_CURRENT_SIGNING_KEY` and `QSTASH_NEXT_SIGNING_KEY`
environment variables:
6. Add the following script to your `package.json` file to build and zip your code:
```json package.json theme={"system"}
{
"scripts": {
"build": "rm -rf ./dist; esbuild index.ts --bundle --minify --sourcemap --platform=node --target=es2020 --outfile=dist/index.js && cd dist && zip -r index.zip index.js*"
}
}
```
7. Click the `Upload from` button for your Lambda and
deploy the code to AWS. Select `./dist/index.zip` as the upload file.
Tada, you've manually deployed a zip file to AWS Lambda! 🎉
## Testing the Integration
To make sure everything works as expected, navigate to your QStash request builder and send a request to your freshly deployed Lambda function:
Alternatively, you can also send a request via CURL:
```bash Terminal theme={"system"}
curl --request POST "https://qstash.upstash.io/v2/publish/
Afterwards we will add a public URL to this lambda by going to the
`Configuration` tab:
Select `Auth Type = NONE` because we are handling authentication ourselves.
After creating the url, you should see it on the right side of the overview of
your function:
### 5. Set Environment Variables
Get your current and next signing key from the
[Upstash Console](https://console.upstash.com/qstash)
On the same `Configuration` tab from earlier, we will now set the required
environment variables:
### 6. Deploy your Lambda function
We need to bundle our code and zip it to deploy it to AWS.
Add the following script to your `Makefile` file (or corresponding pipenv
script):
```yaml theme={"system"}
zip:
rm -rf dist
pip3 install --target ./dist pyjwt
cp lambda_function.py ./dist/lambda_function.py
cd dist && zip -r lambda.zip .
mv ./dist/lambda.zip ./
```
When calling `make zip` this will install PyJwt and zip the code.
Afterwards we can click the `Upload from` button in the lower right corner and
deploy the code to AWS. Select `lambda.zip` as upload file.
### 7. Publish a message
Open a different terminal and publish a message to QStash. Note the destination
url is the URL from step 4.
```bash theme={"system"}
curl --request POST "https://qstash.upstash.io/v2/publish/https://urzdbfn4et56vzeasu3fpcynym0zerme.lambda-url.eu-west-1.on.aws" \
-H "Authorization: Bearer 
#### Using Cloudflare Secrets Store (Account Level Secrets)
This method requires a few modifications in the worker code, see [Access to Secret on Env Object](https://developers.cloudflare.com/secrets-store/integrations/workers/#3-access-the-secret-on-the-env-object)
```ts src/index.ts theme={"system"}
import { Receiver } from "@upstash/qstash";
export interface Env {
QSTASH_CURRENT_SIGNING_KEY: SecretsStoreSecret;
QSTASH_NEXT_SIGNING_KEY: SecretsStoreSecret;
}
export default {
async fetch(request, env, ctx): Promise
* Under **Compute (Workers)** > **Workers & Pages**, find your worker and add these secrets as bindings.
### Deployment
### 4. Deploy
Simply click on `Save & Deploy` at the top of the screen.
### 5. Publish a message
Make note of the url displayed in the top right. This is the public url of your
project.
```bash theme={"system"}
curl --request POST "https://qstash.upstash.io/v2/publish/https://early-frog-33.deno.dev" \
-H "Authorization: Bearer 
Once you start the schedule, QStash will invoke the endpoint at the specified time. You can
scroll down and verify the job has been created!
You can also head over to [Upstash Console](https://console.upstash.com/qstash) and go to the
`Logs` tab where you can see your message activities.
Loading...
}
{msg && {msg}
}
We can also view the logs on Vercel and QStash
QStash
Loading...
}
{msg && {msg}
}
If you are not using a custom database, you can quickly create a new
[Redis database](https://console.upstash.com/redis). Afterwards copy the
`UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` to vercel.
In the near future we will update our
[Vercel integration](https://vercel.com/integrations/upstash) to do this for
you.
## Redeploy
To use the environment variables, you need to redeploy your app. Either with
`npx vercel --prod` or in the UI.
## Create cron trigger in QStash
The last part is to add the trigger in QStash. Go to
[QStash](https://console.upstash.com/qstash) and create a new schedule.
Now we will call your api function whenever you schedule is triggered.
## Adding frontend UI
This part is probably the least interesting and would require more dependencies
for styling etc. Check out the
[index.tsx](https://github.com/upstash/qstash-examples/blob/main/periodic-data-updates/pages/index.tsx)
file, where we load the data from the database and display it in a chart.
## Hosted example
You can find a running example of this recipe
[here](https://qstash-examples-periodic-data-updates.vercel.app/).
# DLQ
Source: https://upstash.com/docs/qstash/sdks/py/examples/dlq
Hello World
", content_type="text/html", ) ``` #### Publish a message with [content-based-deduplication](/qstash/features/deduplication) ```python theme={"system"} from qstash import QStash client = QStash("Hello World
", headers: { "Content-Type": "text/html", }, }); ``` #### Publish a message with [content-based-deduplication](/qstash/features/deduplication) ```typescript theme={"system"} import { Client } from "@upstash/qstash"; const client = new Client({ token: "Active channels: {channels.join(", ")}
Listening for events...
} ``` ## Provider OptionsStatus: {status}
Notifications {user ? "enabled" : "disabled"}
} ``` ## Multiple Events Subscribe to multiple events at once: ```tsx page.tsx theme={"system"} "use client" import { useRealtime } from "@/lib/realtime-client" export default function Page() { useRealtime({ events: ["chat.message", "chat.reaction", "user.joined"], onData({ event, data, channel }) { // 👇 data is automatically typed based on the event if (event === "chat.message") console.log("New message:", data) if (event === "chat.reaction") console.log("New reaction:", data) if (event === "user.joined") console.log("User joined:", data) }, }) returnListening to multiple events
} ``` ## Multiple Channels Subscribe to multiple channels at once: ```tsx page.tsx theme={"system"} "use client" import { useRealtime } from "@/lib/realtime-client" export default function Page() { useRealtime({ channels: ["global", "announcements", "user-123"], events: ["notification.alert"], onData({ event, data, channel }) { console.log(`Message from ${channel}:`, data) }, }) returnListening to multiple channels
} ``` ### Dynamic Channel Management Add and remove channels dynamically: ```tsx page.tsx theme={"system"} "use client" import { useState } from "react" import { useRealtime } from "@/lib/realtime-client" export default function Page() { const [channels, setChannels] = useStateActive channels: {channels.join(", ")}
Listening for notifications...
} ```
{messages.map((msg, i) => (
)
}
```
{msg.sender}: {msg.text}
))}Active Users: {metrics?.users}
Revenue: ${metrics?.revenue}