Skip to content

Redis Cloud

Redis Cloud is Redis's fully managed database service. redisctl provides complete CLI access to the Redis Cloud API.

Three-Tier Access

graph LR
    A[API Layer] --> B[Commands]
    B --> C[Workflows]

    style A fill:#e5c07b,color:#000
    style B fill:#98c379,color:#000
    style C fill:#61afef,color:#000

1. API Layer

Direct REST access for scripting and automation: 

redisctl api cloud get /subscriptions
redisctl api cloud post /subscriptions -d @subscription.json

2. Commands

Human-friendly commands for day-to-day operations: 

redisctl cloud subscription list
redisctl cloud database create --subscription 123 --data @db.json --wait

3. Workflows

Multi-step operations: 

redisctl cloud workflow subscription-setup --name prod --region us-east-1

Key Concepts

Subscriptions

Subscriptions are the top-level container for databases. They define:

  • Cloud provider (AWS, GCP, Azure)
  • Region
  • Memory allocation
  • Networking configuration

Databases

Databases run within subscriptions. Each database has:

  • Memory limit
  • Modules (RedisJSON, RediSearch, etc.)
  • Persistence settings
  • Access credentials

Tasks

Most operations are async and return task IDs. Use --wait to block until completion.

Authentication

export REDIS_CLOUD_API_KEY="your-key"
export REDIS_CLOUD_SECRET_KEY="your-secret"

redisctl profile set cloud \
  --cloud-api-key "your-key" \
  --cloud-secret-key "your-secret"

Getting API Keys

Get your API keys from app.redislabs.com under Access Management > API Keys.

Quick Examples

# List subscriptions
redisctl cloud subscription list -o table

# Create database and wait
redisctl cloud database create \
  --subscription 123456 \
  --name cache \
  --memory-limit-in-gb 1 \
  --wait

# Get database connection info
redisctl cloud database get 123456 789 \
  -o json -q '{endpoint: publicEndpoint, password: password}'

# Set up VPC peering
redisctl cloud vpc-peering create \
  --subscription 123456 \
  --data @peering.json \
  --wait

Command Groups

  • Subscriptions

    Create, list, update, and delete subscriptions

    Commands

  • Databases

    Manage databases within subscriptions

    Commands

  • Access Control

    Users, roles, and ACL rules

    Commands

  • Networking

    VPC peering and private endpoints

    Commands

  • Tasks

    Monitor async operations

    Commands

Next Steps