← Upstash RedisCONTENT HISTORY

Update to Upstash Redis

Snapshot Sep 30, 2026 · 23:07 UTC · version 1.2.1

Collection source: not recorded for this historical snapshot.

WHAT CHANGED · RULE-BASED ANALYSIS

First saved snapshot

No earlier snapshot is available to establish a change.

Compare saved observations

Download comparison JSON
Full technical diff · 0 changed fields
Full snapshot data
{
  "name": "upstash-cli",
  "description": "Run the Upstash CLI (`upstash`) against the Upstash Developer API for Redis, Vector, Search, QStash, Blob, and teams, with non-interactive commands and JSON output for scripts, CI, and agents. Use when creating, listing, renaming, or deleting Redis databases, changing plans, regions, TLS, eviction, auto-upgrade, or budgets, managing backups, running Redis commands with `upstash redis exec`, creating or inspecting Vector and Search indexes, managing QStash instances and tokens, creating Blob buckets or minting temporary S3 credentials for one, managing team members, reading usage stats, or automating any Upstash account operation from the terminal. Also use when the user asks how to provision or manage Upstash resources without the console. Prefer the Upstash MCP server when its tools are available in the session, and use this skill for terminal, CI, and scripting work.",
  "included_files": [],
  "skill_md_contents": "---\nname: upstash-cli\ndescription: Run the Upstash CLI (`upstash`) against the Upstash Developer API for Redis, Vector, Search, QStash, Blob, and teams, with non-interactive commands and JSON output for scripts, CI, and agents. Use when creating, listing, renaming, or deleting Redis databases, changing plans, regions, TLS, eviction, auto-upgrade, or budgets, managing backups, running Redis commands with `upstash redis exec`, creating or inspecting Vector and Search indexes, managing QStash instances and tokens, creating Blob buckets or minting temporary S3 credentials for one, managing team members, reading usage stats, or automating any Upstash account operation from the terminal. Also use when the user asks how to provision or manage Upstash resources without the console. Prefer the Upstash MCP server when its tools are available in the session, and use this skill for terminal, CI, and scripting work.\nlicense: MIT\nmetadata:\n  author: Upstash\n  homepage: https://upstash.com\n---\n\n## Prefer the MCP server when it is available\n\nIf Upstash MCP tools are in the session, call them instead of shelling out to the CLI. They are\nalready authenticated and cover the same ground — creating and inspecting Redis databases, running\nRedis commands, usage stats, backups, Vector and Search indexes, Blob buckets, QStash schedules and\nmessages, the DLQ, and logs. Installing the Upstash plugin registers the hosted server at\n`https://mcp.upstash.com/mcp`.\n\nUse the CLI when there is no MCP in the session, or when the work is inherently shell work — a CI\nstep, a provisioning script, or piping JSON into other commands.\n\nThe Upstash CLI (`upstash`) manages Upstash services via the Upstash Developer API. All commands are non-interactive and emit JSON on stdout. Errors go to stderr as `{ \"error\": \"...\" }` with exit code `1`.\n\n## Install\n\n```bash\nnpm i -g @upstash/cli\n```\n\n## Authentication\n\nRecommended: run `upstash login` once per machine. Prompts for email and a Developer API key (create one at https://console.upstash.com/account/api), verifies them, and saves to `~/.config/upstash/config.json`.\n\n```bash\nupstash login\n```\n\nAlternatives — env vars (also auto-loaded from a `.env` in cwd), or `--email` / `--api-key` inline, or `--env-path <path>` to point at a specific `.env`:\n\n```bash\nexport UPSTASH_EMAIL=you@example.com\nexport UPSTASH_API_KEY=your_api_key\n```\n\nPrecedence: flags > env vars > `.env` > saved config. Prefer a **read-only** API key for agents when possible — mutations fail at the API, the same way they would in the console.\n\n## Resource ID flags\n\n| Flag | Products |\n|------|----------|\n| `--db-id <id>` | Redis |\n| `--index-id <id>` | Vector, Search |\n| `--qstash-id <id>` | QStash |\n| `--bucket-id <id>` | Blob |\n| `--team-id <id>` | Team |\n\n## Redis\n\n```bash\nupstash redis list\nupstash redis get --db-id <id> [--hide-credentials]\nupstash redis create --name <name> --region <region> [--read-regions <r1> <r2>]\nupstash redis delete --db-id <id> [--dry-run]\nupstash redis rename --db-id <id> --name <new-name>\nupstash redis reset-password --db-id <id>\nupstash redis stats --db-id <id>\n\nupstash redis enable-tls --db-id <id>\nupstash redis {enable,disable}-eviction --db-id <id>\nupstash redis {enable,disable}-autoupgrade --db-id <id>\nupstash redis change-plan --db-id <id> --plan <free|payg|pro|paid>\nupstash redis update-budget --db-id <id> --budget <cents>\nupstash redis update-regions --db-id <id> --read-regions <r1> <r2>\nupstash redis move-to-team --db-id <id> --team-id <id>\n```\n\nRegions — AWS: `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`, `ca-central-1`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `sa-east-1`, `ap-south-1`, `ap-northeast-1`, `ap-southeast-1`, `ap-southeast-2`, `af-south-1`. GCP: `us-central1`, `us-east4`, `europe-west1`, `asia-northeast1`.\n\n### Redis backups\n\n```bash\nupstash redis backup list --db-id <id>\nupstash redis backup create --db-id <id> --name <name>\nupstash redis backup delete --db-id <id> --backup-id <id> [--dry-run]\nupstash redis backup restore --db-id <id> --backup-id <id>\nupstash redis backup {enable,disable}-daily --db-id <id>\n```\n\n### Redis exec (REST, not the Developer API key)\n\n```bash\nupstash redis exec --db-url <url> --db-token <token> SET key value\nupstash redis exec --db-url <url> --db-token <token> --json '[\"SET\",\"key\",\"value\"]'\n```\n\n`--db-url` / `--db-token` fall back to `UPSTASH_REDIS_REST_URL` / `UPSTASH_REDIS_REST_TOKEN`. Get both from `endpoint` and `rest_token` in `upstash redis get --db-id <id>`.\n\n## Team\n\n```bash\nupstash team list\nupstash team create --name <name> [--copy-cc]\nupstash team delete --team-id <id> [--dry-run]\nupstash team members --team-id <id>\nupstash team add-member --team-id <id> --member-email <email> --role <admin|dev|finance>\nupstash team remove-member --team-id <id> --member-email <email> [--dry-run]\n```\n\n## Vector\n\n```bash\nupstash vector list\nupstash vector get --index-id <id>\nupstash vector create --name <name> --region <region> --similarity-function <fn> --dimension-count <n> [--type payg] [--index-type <type>] [--embedding-model <m>] [--sparse-embedding-model <m>]\nupstash vector delete --index-id <id> [--dry-run]\nupstash vector rename --index-id <id> --name <new-name>\nupstash vector reset-password --index-id <id>\nupstash vector set-plan --index-id <id> --plan <free|payg|fixed>\nupstash vector transfer --index-id <id> --target-account <id>\nupstash vector stats                             # aggregate across all indexes\nupstash vector index-stats --index-id <id> [--period <1h|3h|12h|1d|3d|7d|30d>]\n```\n\nRegions: `eu-west-1`, `us-east-1`, `us-central1`. Similarity: `COSINE`, `EUCLIDEAN`, `DOT_PRODUCT`. Index types: `DENSE`, `SPARSE`, `HYBRID`. Dense models: `BGE_SMALL_EN_V1_5`, `BGE_BASE_EN_V1_5`, `BGE_LARGE_EN_V1_5`, `BGE_M3`. Sparse models: `BM25`, `BGE_M3`. For `HYBRID` with managed embeddings, set `--dimension-count 0`.\n\n## Search\n\n```bash\nupstash search list\nupstash search get --index-id <id>\nupstash search create --name <name> --region <region> --type <free|payg|fixed>\nupstash search delete --index-id <id> [--dry-run]\nupstash search rename --index-id <id> --name <new-name>\nupstash search reset-password --index-id <id>\nupstash search transfer --index-id <id> --target-account <id>\nupstash search stats\nupstash search index-stats --index-id <id> [--period <1h|3h|12h|1d|3d|7d|30d>]\n```\n\nRegions: `eu-west-1`, `us-central1`.\n\n## QStash\n\n```bash\nupstash qstash list                              # run first; maps region → id\nupstash qstash get --qstash-id <id>\nupstash qstash rotate-token --qstash-id <id>\nupstash qstash set-plan --qstash-id <id> --plan <paid|qstash_fixed_1m|qstash_fixed_10m|qstash_fixed_100m>\nupstash qstash stats --qstash-id <id> [--period <1h|3h|12h|1d|3d|7d|30d>]\nupstash qstash ipv4                              # CIDR blocks for allowlisting\nupstash qstash move-to-team --qstash-id <id> --target-team-id <id>\nupstash qstash update-budget --qstash-id <id> --budget <dollars>    # 0 = no limit\nupstash qstash {enable,disable}-prodpack --qstash-id <id>\n```\n\n## Blob\n\nRun `upstash blob --help` to check that the installed CLI includes Blob support. If the command is unavailable, use the console for bucket management and `upstash-blob-js` for application code until a CLI release includes it.\n\n```bash\nupstash blob list\nupstash blob get --bucket-id <id> [--hide-credentials]\nupstash blob create --name <name> [--visibility <private|public>] [--cors <origin> <origin>]\nupstash blob delete --bucket-id <id> [--dry-run]\nupstash blob credentials [--bucket-id <id>]\n```\n\nBuckets are `private` by default. `blob get` returns the bucket token, which is a bearer secret for the whole bucket — pass `--hide-credentials` when you only need the metadata.\n\n`blob credentials` exchanges a bucket token for temporary, bucket-scoped S3 credentials to use with the AWS CLI, rclone, or any S3 SDK. With `--bucket-id` it reads the token through the Developer API; with no flag it uses `UPSTASH_BLOB_TOKEN` and needs no account auth at all. `expiresAt` is the expiry as a **unix timestamp in seconds** (multiply by 1000 before comparing with `Date.now()`) — re-mint before it passes rather than caching.\n\n```bash\nCREDS=$(upstash blob credentials --bucket-id <id>)\nexport AWS_ACCESS_KEY_ID=$(echo \"$CREDS\" | jq -r .accessKeyId)\nexport AWS_SECRET_ACCESS_KEY=$(echo \"$CREDS\" | jq -r .secretAccessKey)\nexport AWS_SESSION_TOKEN=$(echo \"$CREDS\" | jq -r .sessionToken)\n\naws s3 cp image.png \"s3://$(echo \"$CREDS\" | jq -r .bucket)/image.png\" \\\n  --endpoint-url \"$(echo \"$CREDS\" | jq -r .endpoint)\" --region auto\n```\n\nObject operations are not CLI commands — the bucket is S3-compatible, so use the credentials above with an S3 tool, or the `upstash-blob-js` skill for the TypeScript SDK.\n\n## Conventions\n\n- Pipe any output to `jq` for field extraction, e.g. `upstash redis list | jq '.[].database_id'`.\n- Use `--dry-run` first on any `delete` or `remove-member`.\n- Use `--hide-credentials` on `redis get` and `blob get` when the secret isn't needed.\n"
}

SHA-256: 3fe5bd74863aed164f04cf88bb450e6576dc1fc55f0e7077fa78f552cfb91e0b