Provision and manage Upstash Redis databases programmatically with the Upstash Developer (Management) API

Documented steps

1. Confirm eligibility: the Upstash Developer (Management) API is available to native Upstash accounts only — accounts created through third-party platforms such as Vercel or Fly.io are not supported.
2. Create a management key in the console under Account > Management API. Key names cannot be reused. Copy the value immediately, because Upstash does not store or re-display it and a lost key must be replaced with a new one. Up to 37 keys per account by default.
3. Every call uses HTTP Basic authentication: the account email is the username and the management key is the password. Supply both from environment variables or a secret store — never inline them in scripts or commit them. Base URL for all calls is https://api.upstash.com/v2.
4. Create a database: POST /v2/redis/database with required database_name, platform (aws or gcp) and primary_region from the documented enum (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, us-central1, us-east4, europe-west1, asia-northeast1).
5. Optional create fields: read_regions (array of additional read-replica regions), plan (free, payg, or the fixed_250mb through fixed_500gb tiers), budget (integer monthly cap), eviction (boolean) and tls (boolean).
6. The create response is a Database object containing database_id, database_name, region, port, state (active, suspended or passive), endpoint, tls, type (plan), primary_region, primary_members, all_members, eviction, read_regions and db_* resource-limit fields.
7. List every database on the account: GET /v2/redis/databases returns an array of Database objects.
8. Get one database: GET /v2/redis/database/{id}. Pass the query parameter credentials=hide to strip credential fields from the response — useful when piping output to logs or CI.
9. Rename: POST /v2/redis/rename/{id} with body {"name":"new-name"}; returns the updated Database object.
10. Change read replicas: POST /v2/redis/update-regions/{id} with body {"read_regions":["us-west-1","us-west-2"]}; returns the bare string "OK".
11. Rotate the database credential: POST /v2/redis/reset-password/{id}; returns the Database object. Update every consumer immediately, since the previous value stops working.
12. Delete: DELETE /v2/redis/database/{id} returns the bare string "OK" and is irreversible.
13. To wire the database into @upstash/redis, read the Endpoint/HTTPS value and the token values shown on the database page in the console; they map to the UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN environment variables.
14. Official docs: https://upstash.com/docs/devops/developer-api/introduction | https://upstash.com/docs/devops/developer-api/authentication | https://upstash.com/docs/devops/developer-api/redis/create_database_global | https://upstash.com/docs/redis/howto/connect-client