v51

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

Get a single Pro database

Gets details and settings of a single database in a Pro subscription.

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

Path parameters

subscriptionIdinteger required

Subscription ID.

databaseIdinteger required

Database ID.

Response

OK

databaseIdinteger
linksobject[]

Example response

{
  "databaseId": 1,
  "name": "DB-RCP-2-81-7",
  "protocol": "redis",
  "provider": "AWS",
  "region": "us-east-1",
  "redisVersion": "7.4",
  "respVersion": "resp3",
  "status": "active",
  "datasetSizeInGb": 2,
  "memoryUsedInMb": 4,
  "memoryStorage": "ram",
  "supportOSSClusterApi": true,
  "useExternalEndpointForOSSClusterApi": true,
  "dataPersistence": "snapshot-every-1-hour",
  "replication": false,
  "dataEvictionPolicy": "noeviction",
  "throughputMeasurement": {
    "by": "operations-per-second",
    "value": 2500
  },
  "activatedOn": "2021-08-29T13:03:08Z",
  "lastModified": "2021-08-29T13:03:08Z",
  "publicEndpoint": "redis-17571.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
  "privateEndpoint": "redis-17571.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
  "dynamicEndpoints": {
    "public": "malleable-ultraquiet-point-31101.db-qa.redis.io:17571",
    "private": "cherry-cook-turn-91868.db-qa.redis.io:17571"
  },
  "replica": {
    "syncSources": [
      {
        "endpoint": "redis://localhost:6379",
        "encryption": true,
        "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
      }
    ]
  },
  "clustering": {
    "numberOfShards": 1,
    "regexRules": [
      {
        "ordinal": 1,
        "pattern": "(?<tag>.*)"
      },
      {
        "ordinal": 0,
        "pattern": ".*\\{(?<tag>.*)\\}.*"
      }
    ],
    "hashingPolicy": "standard"
  },
  "security": {
    "enableDefaultUser": true,
    "password": "redis123456redis",
    "sslClientAuthentication": false,
    "tlsClientAuthentication": false,
    "enableTls": false,
    "sourceIps": [
      "0.0.0.0/0"
    ]
  },
  "modules": [
    {
      "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": []
    }
  ],
  "alerts": [],
  "links": [
    {
      "rel": "self",
      "href": "https://api-cloudapi.qa.redislabs.com/v1/subscriptions/120416/databases/51170941",
      "type": "GET"
    }
  ]
}