GET
/
postgres_databases
/
{id_or_name}
Get database
curl --request GET \
  --url https://api.sequinstream.com/api/postgres_databases/{id_or_name} \
  --header 'Authorization: Bearer <token>'
{
  "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"
  }
}

​
Path parameters

​
id_or_name
string
required
The ID or name of the Postgres database connection.

​
Query parameters

​
show_sensitive
boolean
default:"false"
Set to true to include the database password in the response. Defaults to false, which obfuscates the password.

​
Example request

curl Using Name
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'
curl Using ID
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.
​
data
object
A Postgres database object.
{
  "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"
  }
}