Documentation

Everything you need to build with SwiftCache. From quickstart to advanced topics.

Quickstart

Get started in 5 minutes

API Reference

Complete API documentation

Guides

Best practices and tutorials

Quickstart

1. Create an Account

2. Create Your First Instance

# Via Dashboard (easiest)
1. Click "Create Instance"
2. Choose name, region, and memory size
3. Copy connection string

# Via CLI
npm install -g @swiftcache/cli
swiftcache login
swiftcache create my-cache --region us-east --memory 512mb

3. Connect from Your App

// Node.js
import { createClient } from 'redis'

const client = createClient({
  url: process.env.SWIFTCACHE_URL
})

await client.connect()
await client.set('key', 'value')
const value = await client.get('key')

// Python
import redis

r = redis.from_url(os.environ['SWIFTCACHE_URL'])
r.set('key', 'value')
value = r.get('key')

4. Deploy to Production

Set your connection string as an environment variable and deploy. SwiftCache handles the rest.

API Reference

POST/instances

Create a new Redis instance

Request Body

{
  "name": "my-cache",
  "region": "us-east",
  "memory": "512mb",
  "persistence": "rdb"
}

Response

{
  "id": "inst_abc123",
  "name": "my-cache",
  "status": "creating",
  "connectionUrl": "redis://:pass@ip:6379"
}

GET/instances

List all instances

Response

{
  "instances": [
    {
      "id": "inst_abc123",
      "name": "my-cache",
      "status": "running",
      "region": "us-east",
      "memory": "512mb"
    }
  ]
}

DELETE/instances/:id

Delete an instance

Response

{
  "success": true,
  "message": "Instance deleted"
}

Guides

Choosing a Region

How to select the best region for your application

• Latency optimization
• Data residency
• Multi-region strategy

Persistence Options

Understanding RDB, AOF, and in-memory modes

• When to use persistence
• Backup strategies
• Recovery procedures

Scaling Your Instances

Vertical and horizontal scaling strategies

• Memory sizing
• Connection limits
• Sharding patterns

Security Best Practices

Keep your Redis instances secure

• Password management
• IP whitelisting
• TLS encryption