---
title: "Get Database"
method: GET
path: "/redis/database/{id}"
tags: ["redis"]
---

# Get Database

`GET /redis/database/{id}`

## Request

- Base URL: `https://api.upstash.com/v2`
- URL: `https://api.upstash.com/v2/redis/database/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/upstash/apis/developer-api-upstash/docs/redis/database/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint gets details of a database.

## Path parameters

- `id` string, required

## Query parameters

- `credentials` string

## Response `200`

OK

- Database
  - `database_id` string: ID of the database
  - `database_name` string: Name of the database
  - `database_type` string: Pricing model of the database, one of `free`, `Pay as You Go` or `Enterprise`
  - `region` 'global': The region where database is hosted
  - `port` integer: Database port for clients to connect
  - `creation_time` integer: Creation time of the database as Unix time
  - `state` 'active' | 'suspended' | 'passive': State of database
  - `endpoint` string: Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
  - `rest_token` string: REST token for the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
  - `read_only_rest_token` string: Read-only REST token for the database. Omitted when credential protection is on, or when you pass the `credentials=hide` query parameter to Get Database.
  - `password` string: Password of the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
  - `tls` boolean: TLS/SSL is enabled or not
  - `db_daily_bandwidth_limit` integer: Daily bandwidth limit for the database (in bytes). The response can omit this field.
  - `db_max_clients` integer: Max number of concurrent clients can be opened on this database currently
  - `db_max_request_size` integer: Max size of a request that will be accepted by the database currently(in bytes)
  - `db_disk_threshold` integer: Total disk size limit that can be used for the database currently(in bytes)
  - `db_max_entry_size` integer: Max size of an entry that will be accepted by the database currently(in bytes)
  - `db_memory_threshold` integer: Max size of a memory the database can use(in bytes)
  - `db_max_commands_per_second` integer: Max number of commands can be sent to the database per second
  - `db_request_limit` integer: Total number of commands can be sent to the database
  - `type` 'free' | 'payg' | 'pro' | 'paid': Payment plan of the database
  - `budget` integer: Allocated monthly budget for the database
  - `primary_region` 'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'ca-central-1' | 'eu-central-1' | 'eu-west-1' | 'eu-west-2' | 'sa-east-1' | 'ap-south-1' | 'ap-northeast-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'af-south-1' | 'us-central1' | 'us-east4' | 'europe-west1' | 'asia-northeast1': Primary region of the database cluster
  - `primary_members` string[]: List of primary regions in the database cluster
  - `all_members` string[]: List of all regions in the database cluster
  - `eviction` boolean: Entry eviction is enabled
  - `auto_upgrade` boolean: Automatic upgrade capability is enabled
  - `consistent` boolean: Strong consistency mode is enabled
  - `modifying_state` string: Current modifying state of the database
  - `db_resource_size` 'S' | 'M' | 'L' | 'XL' | 'XXL' | '3XL': Resource allocation tier
  - `db_type` 'bolt' | 'badger' | 'pebble': Database storage engine type
  - `db_conn_idle_timeout` integer: Connection idle timeout in nanoseconds
  - `db_lua_timeout` integer: Lua script execution timeout in nanoseconds
  - `db_lua_credits_per_min` integer: Lua script execution credits per minute
  - `db_store_max_idle` integer: Store connection idle timeout in nanoseconds
  - `db_max_loads_per_sec` integer: Maximum load operations per second
  - `db_acl_enabled` 'true' | 'false': Access Control List enabled status
  - `db_acl_default_user_status` 'true' | 'false': Default user access status in ACL
  - `db_eviction` boolean: Database-level eviction policy status
  - `last_plan_upgrade_time` integer: Unix timestamp of the last plan upgrade
  - `replicas` integer: Replica factor of the database
  - `user_email` string: Owner identifier of the database (may be email or marketplace-scoped email)
  - `daily_backup_enabled` boolean: Whether daily backup is enabled
  - `read_regions` string[]: Array of read regions of the database
  - `securityAddons` object: Security add-ons and their enablement status
    - `ipWhitelisting` boolean
    - `vpcPeering` boolean
    - `privateLink` boolean
    - `tlsMutualAuth` boolean
    - `encryptionAtRest` boolean
  - `prometheus_enabled` 'true' | 'false': Prometheus integration enabled status
  - `prod_pack_enabled` boolean: Production pack enabled status

## Changes

- **2026-10-22** `bddbdcab9052`: 1 warning, 6 info
  - removed the optional property `customer_id` from the response with the `200` status
  - added the optional property `database_type` to the response with the `200` status
  - added the optional property `db_daily_bandwidth_limit` to the response with the `200` status
  - added the optional property `password` to the response with the `200` status
  - …3 more

[Operation history](https://skmtc.dev/upstash/apis/developer-api-upstash/changes/redis/database/:id/get.md)

---

[API](https://skmtc.dev/upstash/apis/developer-api-upstash.md) - [All operations](https://skmtc.dev/upstash/apis/developer-api-upstash/llms.txt) - [OpenAPI document](https://skmtc.dev/upstash/apis/developer-api-upstash/revisions/bddbdcab9052?raw)