Caches API: Manage Valkey Instances in AWS

The Caches API lets you provision, configure, and delete Valkey (Redis-compatible) caches inside your project. Each cache runs in your AWS account and is accessible from web servers and workers in the same project over TLS — no password required. Use these endpoints to create a cache, adjust its storage limit, retrieve CloudWatch metrics, and estimate spend.

List Caches

GET /api/projects//redis Return all Valkey caches that exist within the specified project.

curl https://springwinter.dev/api/projects/proj_abc123/redis \
  -H "Authorization: Bearer swt_yourtoken"

{
  "caches": [
    {
      "id": "cache_xyz789",
      "status": "available",
      "endpoint": "cache-xyz789.internal.springwinter.dev:6379",
      "storage_limit_mb": 512,
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:35:22Z"
    }
  ]
}

array

Array of cache objects for the project. Each object has the same shape as the single-cache GET response.

Enable a Cache

string

required

The ID of the project in which to create the cache.

POST /api/projects//redis Create and enable a new Valkey cache for the project.

curl -X POST https://springwinter.dev/api/projects/proj_abc123/redis \
  -H "Authorization: Bearer swt_yourtoken" \
  -H "Content-Type: application/json" \
  -d '{ "storage_limit_mb": 512 }'

{
  "id": "cache_xyz789",
  "status": "creating",
  "endpoint": "cache-xyz789.internal.springwinter.dev:6379",
  "storage_limit_mb": 512,
  "created_at": "2025-01-15T10:30:00Z"
}

integer

required

Maximum memory the cache may use, in megabytes. Minimum: 128. Use a power of two for best alignment with Valkey internals (e.g. 256, 512, 1024).

string

Unique identifier for the cache resource.

string

Provisioning state. One of creating, available, modifying, or deleting.

string

Internal DNS hostname and port your services use to connect. Only reachable from within the same project.

integer

Configured memory limit in megabytes.

Get a Cache

GET /api/projects//redis/ Return the current configuration and status of a Valkey cache.

curl https://springwinter.dev/api/projects/proj_abc123/redis/cache_xyz789 \
  -H "Authorization: Bearer swt_yourtoken"

{
  "id": "cache_xyz789",
  "status": "available",
  "endpoint": "cache-xyz789.internal.springwinter.dev:6379",
  "storage_limit_mb": 512,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:35:22Z"
}

string

Unique cache identifier.

string

Current lifecycle state of the cache.

string

Internal TLS endpoint your services connect to.

integer

Configured memory limit in megabytes.

string

ISO 8601 timestamp of when the cache was created.

string

ISO 8601 timestamp of the most recent update.

Update a Cache

PATCH /api/projects//redis/ Change the storage limit of an existing cache. The cache remains available during the modification.

curl -X PATCH https://springwinter.dev/api/projects/proj_abc123/redis/cache_xyz789 \
  -H "Authorization: Bearer swt_yourtoken" \
  -H "Content-Type: application/json" \
  -d '{ "storage_limit_mb": 1024 }'

{
  "id": "cache_xyz789",
  "status": "modifying",
  "storage_limit_mb": 1024
}

integer

required

New memory limit in megabytes. Must be greater than or equal to the current limit — downsizing is not supported.

Delete a Cache

DELETE /api/projects//redis/ Permanently delete a Valkey cache. All data stored in the cache is lost.

Deleting a cache destroys all cached data immediately. Any web servers or workers that connect to the cache endpoint will begin receiving connection errors. This action cannot be undone.

curl -X DELETE https://springwinter.dev/api/projects/proj_abc123/redis/cache_xyz789 \
  -H "Authorization: Bearer swt_yourtoken"

{
  "id": "cache_xyz789",
  "status": "deleting"
}

Get Cache Cost Estimate

GET /api/projects//redis//cost Return the estimated AWS spend for this cache and a direct link to AWS Cost Explorer for a full cost breakdown.

curl https://springwinter.dev/api/projects/proj_abc123/redis/cache_xyz789/cost \
  -H "Authorization: Bearer swt_yourtoken"

{
  "cost_explorer_url": "https://us-east-1.console.aws.amazon.com/cost-management/home#/custom?...",
  "estimated_monthly_usd": 18.40,
  "month_to_date_usd": 6.12,
  "currency": "USD"
}

string

A direct URL to AWS Cost Explorer pre-filtered for this cache. Open it in your browser while logged in to your AWS account for a full native cost breakdown.

number

Projected full-month cost based on the current configuration and usage, sourced from AWS Cost Explorer.

number

Actual AWS spend recorded so far this calendar month.

string

Currency code for all cost values. Always "USD".

Get Cache Metrics

GET /api/projects//redis//metrics Return CloudWatch metrics for the cache over a recent time window.

curl https://springwinter.dev/api/projects/proj_abc123/redis/cache_xyz789/metrics \
  -H "Authorization: Bearer swt_yourtoken"

{
  "cache_hits": 48201,
  "cache_misses": 3104,
  "memory_used_bytes": 268435456,
  "curr_connections": 12,
  "period_seconds": 3600
}

integer

Number of successful key lookups in the reporting period.

integer

Number of key lookups that returned a miss.

integer

Bytes of memory currently in use by cached data.

integer

Number of active client connections at the end of the period.

integer

Length of the reporting window in seconds.

The cache endpoint is reachable from web servers and workers within the same project over TLS on port 6379. No username or password is required — network-level access controls restrict connectivity to your project’s resources only.

Overview

Projects & Resources

Data & Storage

Account

Caches API: Manage Valkey Instances in AWS

List Caches

Enable a Cache

Get a Cache

Update a Cache

Delete a Cache

Get Cache Cost Estimate

Get Cache Metrics

​List Caches

​Enable a Cache

​Get a Cache

​Update a Cache

​Delete a Cache

​Get Cache Cost Estimate

​Get Cache Metrics

List Caches

Enable a Cache

Get a Cache

Update a Cache

Delete a Cache

Get Cache Cost Estimate

Get Cache Metrics