> ## Documentation Index
> Fetch the complete documentation index at: https://sequinstream.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get database

> Retrieve a Postgres connection by its ID or name.

### Path parameters

<ParamField path="id_or_name" type="string" required>
  The ID or name of the Postgres database connection.
</ParamField>

### Query parameters

<ParamField path="show_sensitive" type="boolean" default="false">
  Set to `true` to include the database password in the response. Defaults to `false`, which obfuscates the password.
</ParamField>

### Example request

```bash curl Using Name theme={null}
curl -X GET 'https://api.sequinstream.com/api/postgres_databases/production_rds?show_sensitive=true' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json'
```

```bash curl Using ID theme={null}
curl -X GET 'https://api.sequinstream.com/api/postgres_databases/2593a3fc-9afe-4ea8-8ede-cffc8ae57c89' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json'
```

## Response

Returns a single Postgres database object.

<ResponseField name="data" type="object">
  A Postgres database object.

  <Expandable title="properties" defaultOpen={true}>
    <ResponseField name="id" type="string (uuid)">
      The ID of the database connection.
    </ResponseField>

    <ResponseField name="name" type="string">
      The user-defined name for the database connection.
    </ResponseField>

    <ResponseField name="hostname" type="string">
      The hostname of the database server.
    </ResponseField>

    <ResponseField name="port" type="integer">
      The port number for the database connection.
    </ResponseField>

    <ResponseField name="database" type="string">
      The name of the logical Postgres database to connect to.
    </ResponseField>

    <ResponseField name="username" type="string">
      The username for authenticating with the database.
    </ResponseField>

    <ResponseField name="password" type="string">
      The password for authenticating with the database. This will be obfuscated unless `show_sensitive=true` is used.
    </ResponseField>

    <ResponseField name="ssl" type="boolean">
      Indicates whether SSL is enabled for the connection.
    </ResponseField>

    <ResponseField name="ipv6" type="boolean">
      Indicates whether the hostname resolves to an IPv6 address.
    </ResponseField>

    <ResponseField name="use_local_tunnel" type="boolean">
      Indicates whether this database connection uses the [Sequin local tunnel](/reference/cli#tunnel-sequin-cloud-only).
    </ResponseField>

    <ResponseField name="pool_size" type="integer">
      Database connection pool size (internal setting).
    </ResponseField>

    <ResponseField name="queue_interval" type="integer">
      Database connection pool queue interval (internal setting).
    </ResponseField>

    <ResponseField name="queue_target" type="integer">
      Database connection pool queue target (internal setting).
    </ResponseField>

    <ResponseField name="replication_slots" type="array">
      Details about the associated replication slot. Will be an empty array if no slot exists.

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="id" type="string (uuid)">
          The ID of the replication slot.
        </ResponseField>

        <ResponseField name="publication_name" type="string">
          The name of the Postgres publication used for replication.
        </ResponseField>

        <ResponseField name="slot_name" type="string">
          The name of the Postgres replication slot.
        </ResponseField>

        <ResponseField name="status" type="string (enum: active | disabled)">
          The current status of the replication slot.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": {
      "database": "sequin_prod",
      "hostname": "db.abc123xyz.us-east-1.rds.amazonaws.com",
      "id": "2593a3fc-9afe-4ea8-8ede-cffc8ae57c89",
      "ipv6": false,
      "name": "production_rds",
      "password": "supersecret", // Not obfuscated because show_sensitive=true
      "pool_size": 10,
      "port": 5432,
      "queue_interval": 1000,
      "queue_target": 50,
      "replication_slots": [
          {
              "publication_name": "sequin_pub",
              "slot_name": "sequin_slot",
              "status": "active"
          }
      ],
      "ssl": true,
      "use_local_tunnel": false,
      "username": "sequin_user"
    }
  }
  ```

  ```json 404 Not Found theme={null}
  {
      "errors": {
          "detail": "Postgres Database not found"
      }
  }
  ```
</ResponseExample>