POST
/
postgres_databases
/
{id_or_name}
/
test_connection
curl --request POST \
  --url https://api.sequinstream.com/api/postgres_databases/{id_or_name}/test_connection \
  --header 'Authorization: Bearer <token>'
{
    "success": true
}

Tests an existing Postgres connection. This verifies:

  • network reachability
  • authentication
  • connect permissions
  • replication slot validity

​
Path parameters

​
id_or_name
string
required

The ID or the name of the Postgres database connection to test.

​
Example request

curl
curl -X POST 'https://api.sequinstream.com/api/postgres_databases/production_rds/test_connection' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json'

​
Response

​
success
boolean

Indicates whether all connection tests passed (true) or if any test failed (false).

​
reason
string

If success is false, this field provides a human-readable reason for the failure.

{
    "success": true
}