Sign inStart your trial

Upstash

Reference

37 actions for Upstash workflows.

01. Operations

Act on Upstash from a workflow

Operations are the actions a workflow can take in Upstash, grouped by category. Each lists its method, parameters, and a template you can drop it into.

Auditlogs

1 operation

Track and review security and administrative actions taken within your Upstash account. Access detailed audit logs to monitor changes, user activities, and system events for compliance and troubleshooting purposes.

GET

List audit logs

/auditlogs

Retrieve a chronological record of all account activities including who made changes, what was changed, and from where. Use this to track configuration changes, identify unauthorized access attempts, and maintain a complete audit trail for compliance.

Redis

22 operations

Manage Redis database instances, including creation, configuration, and maintenance operations. Perform tasks such as upgrading plans, enabling security features like TLS, managing backups, and optimizing performance through read regions and eviction settings.

POST★ Featured

Create a Redis database

/v2/redis/database

Create a new serverless Redis database with your preferred configuration, plan, and region. Use this to quickly spin up dedicated cache storage, session management, or rate-limiting for your applications without managing infrastructure.

8 input
PATCH★ Featured

Enable daily backups on a Redis database

/v2/redis/enable-dailybackup/{id}

Automatically schedules daily snapshots of your Redis database to create restore points for data recovery. This ensures you have a reliable backup strategy in place for protecting critical business data.

1 input · 3 path
GET★ Featured

Get Redis database stats

/v2/redis/stats/{id}

Retrieves detailed performance metrics for your Redis database including request volume, latency, bandwidth, and storage usage to monitor system health and performance.

1 input · 3 path
GET★ Featured

List Redis databases

/v2/redis/databases

Retrieve all Redis databases associated with your account along with their configuration and current status. Use this to get a complete view of your data storage resources and manage them efficiently.

POST★ Featured

Reset a Redis database password

/v2/redis/reset-password/{id}

Generate a new password for your Redis database and invalidate all existing connections, ensuring only authorized clients can reconnect with the updated credentials.

1 input · 3 path
POST★ Featured

Restore a Redis database from a backup

/v2/redis/restore-backup/{id}

Restores a Redis database to a previous state using a backup snapshot, allowing you to recover from data loss or undo problematic changes. This overwrites current data, so use it when you need to quickly recover to a known good state.

2 input · 3 path
POST

Change a Redis database plan

/v2/redis/{id}/change-plan

Upgrade or downgrade your Redis database to a different plan tier, adjusting its capacity, throughput, and monthly cost based on your current needs.

5 input · 3 path
POST

Create a Redis database backup

/v2/redis/create-backup/{id}

Create an immediate backup of your Redis database to protect your data before making significant changes or to establish restore points outside of automatic daily backups.

2 input · 3 path
DELETE

Delete a Redis database

/v2/redis/database/{id}

Permanently removes a Redis database and all its stored data from your Upstash account. This irreversible action is useful when you no longer need a database or want to clean up unused resources.

1 input · 3 path
DELETE

Delete a Redis database backup

/v2/redis/delete-backup/{id}/{backup_id}

Remove a specific backup snapshot from your Redis database to free up storage and reduce costs. This helps you manage backup storage efficiently by deleting outdated or unnecessary backup copies.

2 input · 3 path
POST

Disable auto upgrade on a Redis database

/v2/redis/disable-autoupgrade/{id}

Disable automatic plan upgrades for a Redis database to prevent unexpected cost increases when usage thresholds are exceeded. This keeps your database on a fixed tier so you can monitor and control scaling decisions manually.

1 input · 3 path
PATCH

Disable daily backups on a Redis database

/v2/redis/disable-dailybackup/{id}

Turns off automatic daily backups for a Redis database to reduce storage costs when backup data isn't essential for your use case.

1 input · 3 path
POST

Disable eviction on a Redis database

/v2/redis/disable-eviction/{id}

Prevent your Redis database from automatically deleting data when it reaches capacity, instead rejecting new writes to ensure no data loss occurs.

1 input · 3 path
POST

Enable auto upgrade on a Redis database

/v2/redis/enable-autoupgrade/{id}

Automatically upgrades your Redis database to a larger plan when usage exceeds current limits, ensuring your application stays responsive without manual intervention.

1 input · 3 path
POST

Enable eviction on a Redis database

/v2/redis/enable-eviction/{id}

Automatically removes old or least-used keys when your Redis database reaches its memory limit, preventing write rejections and keeping your application running smoothly.

1 input · 3 path
POST

Enable TLS on a Redis database

/v2/redis/enable-tls/{id}

Enable mandatory TLS encryption for all connections to your Redis database to protect sensitive data in transit. This is a permanent setting designed for databases handling confidential information or subject to compliance requirements.

1 input · 3 path
GET

Get a Redis database

/v2/redis/database/{id}

Retrieve the complete configuration and connection details for a specific Redis database, including endpoint, port, and enabled features. Use this to verify your database settings and surface connection information to your application or dashboard.

2 input · 3 path · 3 query
GET

List backups for a Redis database

/v2/redis/list-backup/{id}

Retrieve all available backup snapshots for your Redis database, including manually created and automatically scheduled backups. This helps you find the right restore point if data needs recovery or verify your backup protection.

1 input · 3 path
POST

Move a Redis database to a team

/v2/redis/move-to-team

Transfer ownership of a Redis database from your personal account to a team account, enabling shared access and centralized billing for collaborative projects.

2 input
POST

Rename a Redis database

/v2/redis/rename/{id}

Change the display name of a Redis database to keep your database list organized, without affecting any client connections or configurations.

2 input · 3 path
PATCH

Update a Redis database monthly budget

/v2/redis/update-budget/{id}

Set or change the monthly spending limit for a Redis database to control costs and receive alerts when approaching your budget threshold.

2 input · 3 path
POST

Update Redis database read regions

/v2/redis/update-regions/{id}

Add or remove read replica regions from your Redis database to optimize performance in different geographic locations and control infrastructure costs.

2 input · 3 path

Teams

6 operations

Organize users and resources by creating and managing teams within your Upstash workspace. Control team membership, assign members to teams, and manage team-level access to coordinate collaboration across your organization.

POST

Add a team member

/v2/teams/member

Invite a user to join your team and assign them a specific role like admin or member. This streamlines onboarding new teammates and keeps your team structure organized.

3 input
POST

Create a team

/v2/team

Create a new team to share Upstash resources like databases and message queues across multiple team members with unified billing and management.

2 input
DELETE

Delete a team

/v2/team/{id}

Permanently remove a team from your Upstash account and revoke all member access. This operation requires that all databases and indexes are transferred or deleted beforehand to ensure no data is left orphaned.

1 input · 3 path
GET

List members of a team

/v2/teams/{team_id}

Retrieve all members of a team along with their email addresses and roles to manage access and keep your user directory synchronized. Use this to verify who has access to your Upstash resources and identify any membership changes.

1 input · 3 path
GET

List teams

/v2/teams

Retrieve all teams associated with your account along with their billing details. This helps you organize resources across multiple teams and understand your billing structure.

DELETE

Remove a team member

/v2/teams/member

Revoke a team member's access to all team resources including databases, vector indexes, and billing when they leave your organization or change roles.

2 input

Vector

8 operations

Create and manage vector indexes for similarity search and AI applications on Upstash. Configure index plans, transfer indexes between teams, manage authentication tokens, and maintain vector database infrastructure.

POST

Change a vector index plan

/v2/vector/index/{id}/setplan

Scale your vector search capacity up or down by changing your index to a different plan tier, adjusting your storage, throughput, and costs based on your current needs.

2 input · 3 path
POST

Create a vector index

/v2/vector/index

Create a new vector index to enable similarity search across your data using embeddings. This sets up the foundation for intelligent search and recommendation features in your applications.

8 input
DELETE

Delete a vector index

/v2/vector/index/{id}

Permanently removes a vector index and all its stored vectors from your Upstash account. Use this when you no longer need a specific index to free up resources and clean up your vector storage.

1 input · 3 path
GET

Get a vector index

/v2/vector/index/{id}

Retrieves the complete configuration details of a vector index, including its endpoint, authentication tokens, plan limits, and embedding model settings. Use this to verify your index setup and get the connection information needed to integrate it with your applications.

1 input · 3 path
GET

List vector indexes

/v2/vector/index

Retrieve all vector indexes in your account with their configurations, regions, and usage details. Use this to manage your vector database resources and monitor their status.

POST

Rename a vector index

/v2/vector/index/{id}/rename

Change the display name of a vector index while keeping all existing configuration and client connections intact. This allows you to organize and relabel your vector indexes for better clarity without disrupting any running systems.

2 input · 3 path
POST

Reset vector index tokens

/v2/vector/index/{id}/reset-password

Rotate and replace the authentication tokens for your vector index to maintain security and prevent unauthorized access. This is essential for protecting sensitive data and ensuring only authorized applications can connect to your index.

1 input · 3 path
POST

Transfer a vector index to a team

/v2/vector/index/{id}/transfer

Move ownership of a vector index from your personal account to a team for shared management and consolidated billing. Use this when you're ready to transition a project from solo development to team collaboration.

2 input · 3 path
What now

Use Upstash in a workflow

Drop a trigger and an action into a template; approve from your phone; the workflow runs.