# Get Database

> This endpoint gets details of a database.

## Endpoint

`GET https://api.upstash.com/v2/redis/database/{id}`

## Parameters

- `id` (path, string, required): The ID of the database
- `credentials` (query, string): Set to 'hide' to remove credentials from the response.

## Responses

### 200 - OK

- `database_id` (string): ID of the database
- `database_name` (string): Name of the database
- `region` (enum<string>): 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` (enum<string>): State of database
- `endpoint` (string): Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
- `tls` (boolean): TLS/SSL is enabled or not
- `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` (enum<string>): Payment plan of the database
- `budget` (integer): Allocated monthly budget for the database
- `primary_region` (enum<string>): 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` (enum<string>): Resource allocation tier
- `db_type` (enum<string>): 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` (enum<string>): Access Control List enabled status
- `db_acl_default_user_status` (enum<string>): 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
- `customer_id` (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` (enum<string>): Prometheus integration enabled status
- `prod_pack_enabled` (boolean): Production pack enabled status

## cURL

```bash
curl --request GET \
  --url https://api.upstash.com/v2/redis/database/{id} \
  --header 'Authorization: Bearer <token>'
```