Cosmoner Docs
API Reference

Redis

Managed Redis databases — provision, inspect, and delete Redis instances for a project.

Overview

Redis databases are fully managed instances for caching, sessions, queues, and rate limiting. Each database is isolated, reachable over TLS, and billed monthly on the plan you choose.

Plans come in two families:

  • Redis — the whole dataset is held in memory. Lowest and most predictable latency.
  • Redis Flex — frequently used keys stay in memory while colder keys move to SSD. Several times more capacity for the same price, at the cost of slower reads on cold keys.

High availability

Enabling high availability keeps a replica of your dataset that automatically takes over if the primary fails. The replica is a full mirror, so 50% of the plan's memory is dedicated to replication — a 1 GB plan with HA enabled holds 512 MB of your data. HA bills as two units of the plan price.

Data persistence

Persistence decides how much of your data survives a restart. It is included in the plan price.

ModeDurability
NONENothing is written to disk. Everything is lost on restart.
AOF_EVERY_WRITEEvery write is persisted before it is acknowledged.
AOF_EVERY_1_SECONDWrites are flushed once a second; at most one second of data is lost.
SNAPSHOT_EVERY_1_HOURPoint-in-time copy taken hourly.
SNAPSHOT_EVERY_6_HOURSPoint-in-time copy taken every 6 hours.
SNAPSHOT_EVERY_12_HOURSPoint-in-time copy taken every 12 hours.

Redis Flex plans persist to SSD by design and support the snapshot modes only. The smallest plans support neither replication nor persistence — the plan list reports this per tier.


Catalogue Endpoints

List plans

GET /v1/rediscloud/plans

Returns every purchasable plan tier. priceMonthly is in whole currency units.

Response:

{
  "success": true,
  "data": [
    {
      "slug": "redis-ram-1gb",
      "name": "Redis — 1 GB",
      "planType": "RAM",
      "memoryMb": 1024,
      "throughputOps": 1000,
      "supportsReplication": true,
      "supportsPersistence": true,
      "priceMonthly": 22
    }
  ]
}

List regions

GET /v1/rediscloud/regions

Returns the regions Redis databases can be deployed to.


Management Endpoints

These endpoints require session or API-key authentication and project membership. API keys need the redis:read scope to read and redis:write to create or delete.

List Redis databases

GET /v1/projects/:projectId/redis

Returns every non-deleted Redis database in the project. Passwords are never included here.

Response:

{
  "success": true,
  "data": [
    {
      "id": "clx...",
      "name": "my-cache",
      "planSlug": "redis-ram-1gb",
      "planType": "RAM",
      "memoryMb": 1024,
      "throughputOps": 1000,
      "cloudProvider": "AWS",
      "region": "eu-west-1",
      "replication": false,
      "dataPersistence": "AOF_EVERY_1_SECOND",
      "status": "ACTIVE",
      "host": "redis-12345.example.ec2.cloud.redislabs.com",
      "port": 12345,
      "createdAt": "2026-08-04T10:00:00.000Z"
    }
  ]
}

status is one of CREATING, ACTIVE, ERROR, or TERMINATED.

Get a Redis database

GET /v1/projects/:projectId/redis/:redisId

Same shape as the list entry, plus the password for the default user. Connect with rediss:// — TLS is required.

Preview the cost

GET /v1/projects/:projectId/redis/preview?planSlug=redis-ram-1gb&replication=false

Returns the prorated amount that will be charged for adding this database to your subscription.

Create a Redis database

POST /v1/projects/:projectId/redis

Body:

{
  "name": "my-cache",
  "planSlug": "redis-ram-1gb",
  "region": "eu-west-1",
  "replication": false,
  "dataPersistence": "AOF_EVERY_1_SECOND"
}

name must be lowercase letters, numbers, and hyphens, and cannot start or end with a hyphen. The database is created as CREATING and becomes ACTIVE once provisioning finishes, usually within a couple of minutes.

If provisioning fails, the charge is rolled back — you are never billed for a database that did not come up.

Delete a Redis database

DELETE /v1/projects/:projectId/redis/:redisId

Permanently deletes the database and everything stored in it, and stops the recurring charge. This cannot be undone.

On this page