You can use the Redis Cloud REST API with both Essentials and Pro subscriptions. This guide focuses on enabling and authenticating API access in an Essentials subscription, making requests via Swagger UI or cURL, and handling rate limits and errors.
Quick Fix Table
Problem |
Likely Cause |
Fast Fix |
|---|---|---|
Authentication fails |
Incorrect or expired API key |
Regenerate keys in the Redis Cloud Console and replace them in scripts |
“Access Denied” / “Endpoint Not Allowed” |
Endpoint not available in Essentials plan |
Review the API reference to confirm endpoint availability |
429 errors (Too Many Requests) |
More than 400 requests/minute per API key |
Add exponential backoff with jitter, stagger automated jobs, or reduce parallel requests |
Prerequisites
An active Redis Cloud Essentials
Admin access to your Redis Cloud account
Ability to create and manage API keys under your account
Enable and Authenticate the REST API
Sign in to your Redis Cloud account as an account owner.
From the menu, choose Access Management.
When the Access Management screen appears, select the API Keys tab.
If a Copy button appears to the right of the API account key, the API is enabled. This button copies the account key to the Clipboard.
If you see an Enable API button, select it to enable the API and generate your API account key.
Read more at Manage API keys
Step-by-Step Instructions
A. Accessing the REST API
Base endpoint:
https://api.redislabs.com/v1Supported methods: Swagger UI, cURL, or custom HTTP clients
B. Using the Swagger UI (recommended for new users)
Visit the Swagger UI explorer.
Click Authorize.
Enter
x-api-key(Account Key) andx-api-secret-key(Secret Key).Click Authorize → Close.
Choose an operation such as GET /subscriptions to verify connectivity.
C. Using cURL or Other REST Clients
Example request:
curl -s -X GET "https://api.redislabs.com/v1/logs" \ -H "accept: application/json" \ -H "x-api-key: <YOUR_ACCOUNT_KEY>" \ -H "x-api-secret-key: <YOUR_SECRET_KEY>" \ | jq -r .
Replace <YOUR_ACCOUNT_KEY> and <YOUR_SECRET_KEY> with your actual credentials. For more working examples, see the API use cases and scripts.
D. API Usage Limits
Rate limit: 400 requests per minute per API key
Implement retry logic with exponential backoff and jitter; stagger requests to avoid bursts. For implementation details, follow the Getting Started guide.
Troubleshooting
Issue |
Likely Cause |
Suggested Resolution |
|---|---|---|
Authentication fails |
Incorrect or expired API key |
Regenerate keys in the Redis Cloud Console and confirm correct usage |
“Access Denied” / “Endpoint Not Allowed” |
Endpoint not available in Essentials plan |
Verify plan tier and permissions against the API reference |
Too many requests |
Exceeding 400 requests/minute |
Add client-side rate limiting or backoff logic |
Swagger JSON errors |
Copy/paste issues or missing fields |
Adjust payload examples before executing in Swagger UI |
HTTP 4xx/5xx errors |
Malformed requests or expired session |
Review request formatting and authorization headers using the getting started guide |
0 comments
Please sign in to leave a comment.