v51

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

Get a single Essentials database

Gets details and settings of a single database in an Essentials subscription.

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

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Response

OK

databaseIdinteger
namestring
protocol'redis' | 'memcached' | 'stack'
providerstring
regionstring
redisVersionstring
redisVersionCompliancestring
respVersion'resp2' | 'resp3'
statusstring
planMemoryLimitnumber double
planDatasetSizenumber double
memoryLimitMeasurementUnitstring
memoryLimitInGbnumber double
datasetSizeInGbnumber double
memoryUsedInMbnumber double
networkMonthlyUsageInBytenumber double
memoryStorage'ram' | 'ram-and-flash'
redisFlexboolean
supportOSSClusterApiboolean
useExternalEndpointForOSSClusterApiboolean
dataPersistence'none' | 'aof-every-1-second' | 'aof-every-write' | 'snapshot-every-1-hour' | 'snapshot-every-6-hours' | 'snapshot-every-12-hours'
replicationboolean
dataEvictionPolicy'allkeys-lru' | 'allkeys-lfu' | 'allkeys-lrm' | 'allkeys-random' | 'volatile-lru' | 'volatile-lfu' | 'volatile-lrm' | 'volatile-random' | 'volatile-ttl' | 'noeviction'
activatedOnstring date-time
lastModifiedstring date-time
publicEndpointstring
privateEndpointstring
linksobject[]

Example response

{
  "databaseId": 51324587,
  "name": "bdb",
  "protocol": "stack",
  "provider": "AWS",
  "region": "us-east-1",
  "status": "draft",
  "planMemoryLimit": 250,
  "respVersion": "resp2",
  "memoryLimitMeasurementUnit": "MB",
  "memoryUsedInMb": 7,
  "memoryStorage": "ram",
  "dataPersistence": "none",
  "replication": true,
  "dataEvictionPolicy": "noeviction",
  "dynamicEndpoints": {
    "public": "hyperclear-comparison-purpose-36067.db-qa.redis.io:12037",
    "private": "mahogany-refined-system-53022.db-qa.redis.io:12037"
  },
  "clustering": {
    "enabled": false,
    "regexRules": [
      {
        "ordinal": 0,
        "pattern": ".*\\{(?<tag>.*)\\}.*"
      },
      {
        "ordinal": 1,
        "pattern": "(?<tag>.*)"
      }
    ],
    "hashingPolicy": "standard"
  },
  "security": {
    "defaultUserEnabled": true,
    "password": "myCustomPassword",
    "sourceIps": [
      "0.0.0.0/0"
    ]
  },
  "modules": [
    {
      "id": 18534,
      "name": "RediSearch",
      "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": []
}