Management API
- Introduction
- Authentication
- Postgres databases
- HTTP endpoints
- Sink consumers
- Backfills
- Errors
Get database
Retrieve a Postgres connection by its ID or name.
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
The ID or name of the Postgres database connection.
Query parameters
Set to true to include the database password in the response. Defaults to false, which obfuscates the password.
Example request
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 -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.
A Postgres database object.
The ID of the database connection.
The user-defined name for the database connection.
The hostname of the database server.
The port number for the database connection.
The name of the logical Postgres database to connect to.
The username for authenticating with the database.
The password for authenticating with the database. This will be obfuscated unless show_sensitive=true is used.
Indicates whether SSL is enabled for the connection.
Indicates whether the hostname resolves to an IPv6 address.
Indicates whether this database connection uses the Sequin local tunnel.
Database connection pool size (internal setting).
Database connection pool queue interval (internal setting).
Database connection pool queue target (internal setting).
Details about the associated replication slot. Will be an empty array if no slot exists.
{
"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"
}
}
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"
}
}