v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01169142751.2 KB
Databases - Essentials

Get all databases in an Essentials subscription

Gets a list of all databases in the specified Essentials subscription.

get/v1/fixed/subscriptions/{subscriptionId}/databases

Path parameters

subscriptionIdinteger required

Subscription ID.

Query parameters

offsetinteger

Number of items to skip.

limitinteger

Maximum number of items to return.

Response

OK

accountIdinteger
linksobject[]

Example response

{
  "accountId": 40131,
  "subscription": {
    "subscriptionId": 154714,
    "numberOfDatabases": 2,
    "databases": [
      {
        "databaseId": 51324587,
        "name": "bdb",
        "protocol": "stack",
        "provider": "AWS",
        "region": "us-east-1",
        "redisVersion": "7.4",
        "status": "draft",
        "planMemoryLimit": 250,
        "respVersion": "resp2",
        "memoryLimitMeasurementUnit": "MB",
        "memoryUsedInMb": 1,
        "memoryStorage": "ram",
        "dataPersistence": "none",
        "replication": true,
        "dataEvictionPolicy": "noeviction",
        "dynamicEndpoints": {
          "public": "beautiful-ultralight-board-76526.db-qa.redis.io:12345",
          "private": "dog-ball-key-65499.db-qa.redis.io:12345"
        },
        "clustering": {
          "enabled": false,
          "regexRules": [
            {
              "ordinal": 0,
              "pattern": ".*\\{(?<tag>.*)\\}.*"
            },
            {
              "ordinal": 1,
              "pattern": "(?<tag>.*)"
            }
          ],
          "hashingPolicy": "standard"
        },
        "security": {
          "defaultUserEnabled": true,
          "sourceIps": [
            "0.0.0.0/0"
          ]
        },
        "modules": [
          {
            "id": 18534,
            "name": "searchlight",
            "capabilityName": "Search and query",
            "version": "2.2.6",
            "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
            "parameters": []
          },
          {
            "id": 18535,
            "name": "RedisBloom",
            "capabilityName": "Probabilistic",
            "version": "2.2.12",
            "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
            "parameters": []
          },
          {
            "id": 18536,
            "name": "RedisJSON",
            "capabilityName": "JSON",
            "version": "2.0.6",
            "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
            "parameters": []
          },
          {
            "id": 18537,
            "name": "RedisTimeSeries",
            "capabilityName": "Time series",
            "version": "1.6.8",
            "description": "Time-Series data structure for Redis",
            "parameters": []
          }
        ],
        "alerts": [
          {
            "name": "connections-limit",
            "value": 80,
            "defaultValue": 80
          }
        ],
        "backup": {
          "remoteBackupEnabled": false
        },
        "links": []
      },
      {
        "databaseId": 51324586,
        "name": "firstDB",
        "protocol": "stack",
        "provider": "AWS",
        "region": "us-east-1",
        "status": "draft",
        "planMemoryLimit": 250,
        "memoryLimitMeasurementUnit": "MB",
        "memoryUsedInMb": 1,
        "memoryStorage": "ram",
        "dataPersistence": "none",
        "replication": true,
        "dataEvictionPolicy": "noeviction",
        "dynamicEndpoints": {
          "public": "morning-easy-volleyball-28510.db-qa.redis.io:12000",
          "private": "table-peanut-chin-89928.db-qa.redis.io:12000"
        },
        "clustering": {
          "enabled": false,
          "regexRules": [
            {
              "ordinal": 0,
              "pattern": ".*\\{(?<tag>.*)\\}.*"
            },
            {
              "ordinal": 1,
              "pattern": "(?<tag>.*)"
            }
          ],
          "hashingPolicy": "standard"
        },
        "security": {
          "defaultUserEnabled": true,
          "sourceIps": [
            "0.0.0.0/0"
          ]
        },
        "modules": [
          {
            "id": 18529,
            "name": "searchlight",
            "capabilityName": "Search and query",
            "version": "2.2.6",
            "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
            "parameters": []
          },
          {
            "id": 18530,
            "name": "RedisBloom",
            "capabilityName": "Probabilistic",
            "version": "2.2.12",
            "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
            "parameters": []
          },
          {
            "id": 18531,
            "name": "RedisJSON",
            "capabilityName": "JSON",
            "version": "2.0.6",
            "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
            "parameters": []
          },
          {
            "id": 18532,
            "name": "RedisTimeSeries",
            "capabilityName": "Time series",
            "version": "1.6.8",
            "description": "Time-Series data structure for Redis",
            "parameters": []
          }
        ],
        "alerts": [
          {
            "name": "connections-limit",
            "value": 80,
            "defaultValue": 80
          }
        ],
        "backup": {
          "remoteBackupEnabled": false
        },
        "links": []
      }
    ],
    "links": []
  },
  "links": []
}