At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key from
REDIS_CLOUD_API_KEYis sent as thex-api-keyheader. - Docs: https://redis.io/docs/latest/operate/rc/api/get-started/use-rest-api/
Credentials
Set these per environment. See Connect an integration.Setup
- Enable the API: Sign in to Redis Cloud (https://cloud.redis.io) as an account owner and go to Access Management → API Keys. Free accounts can sign up and create an Essentials subscription to test with. Enable the API if prompted.
- Copy the account key: The account key identifies your account and is shown on the API Keys page. Add it to your .env as REDIS_CLOUD_API_KEY.
- Create a user secret key: On the same page, add a new API user key. The secret is shown only once - copy it and add it as REDIS_CLOUD_SECRET_KEY.
- Verify access: Run List Subscriptions (Pro) or List Essentials Subscriptions (fixed plans).
- Requests authenticate with two headers: x-api-key (account key) and x-api-secret-key (user secret key) - both env vars are required
- Pro and Essentials subscriptions live under different paths: /v1/subscriptions vs /v1/fixed/subscriptions
- The API is rate limited to 400 requests per minute per account key
Tools
Example prompts
- List my Redis Cloud subscriptions and the databases in each, with their status and memory limits.
- Get the details of my main Redis Cloud database and summarize its configuration.