Update database

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "url": "postgresql://postgres:secret-password@new-db.example.com:5432/postgres"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com",
    "replication_slots": [
      {
        "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
        "publication_name": "new_sequin_pub",
        "slot_name": "new_sequin_slot"
      }
    ]
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/replica-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "replica-db-renamed",
    "hostname": "new-replica.example.com",
    "primary": {
      "hostname": "new-primary.example.com"
    }
  }'

{
  "id": "db_01HRMW3ZNE5EFGW9SDXW01TT92",
  "name": "example-db-renamed",
  "hostname": "new-db.example.com",
  "database": "postgres",
  "username": "postgres",
  "password": "************",
  "port": 5432,
  "ssl": true,
  "use_local_tunnel": false,
  "ipv6": false,
  "replication_slots": [
    {
      "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
      "publication_name": "new_sequin_pub",
      "slot_name": "new_sequin_slot",
      "status": "active"
    }
  ]
}

PUT

api

postgres_databases

{id_or_name}

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "url": "postgresql://postgres:secret-password@new-db.example.com:5432/postgres"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com",
    "replication_slots": [
      {
        "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
        "publication_name": "new_sequin_pub",
        "slot_name": "new_sequin_slot"
      }
    ]
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/replica-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "replica-db-renamed",
    "hostname": "new-replica.example.com",
    "primary": {
      "hostname": "new-primary.example.com"
    }
  }'

{
  "id": "db_01HRMW3ZNE5EFGW9SDXW01TT92",
  "name": "example-db-renamed",
  "hostname": "new-db.example.com",
  "database": "postgres",
  "username": "postgres",
  "password": "************",
  "port": 5432,
  "ssl": true,
  "use_local_tunnel": false,
  "ipv6": false,
  "replication_slots": [
    {
      "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
      "publication_name": "new_sequin_pub",
      "slot_name": "new_sequin_slot",
      "status": "active"
    }
  ]
}

Path parameters

id_or_name

string

required

The database ID or name to update

Request body

For updates, the replication_slots array is optional. If provided, it must contain a single replication slot object. If you include a replication slot, it must have an id field to identify which slot to update.

name

string

A name for this database connection. You can use this name to identify the database across the API.

url

string

The full connection URL for the database, e.g. postgresql://postgres:secret-password@db.example.com:5432/postgres.Pass in either this parameter or database, hostname, port, username, password.To specify SSL, use the separate ssl field.

hostname

string

The database server hostname.

database

string

The name of the logical database in Postgres.

username

string

The database username.

password

string

The database password.

port

integer

The database server port.

ssl

boolean

Whether to use SSL for the connection.

ipv6

boolean

Whether to use IPv6 for the connection.

primary

object

Connection details for the primary database, only needed when connecting to a replica.

Show primary properties

hostname

string

required

The primary database server hostname.

database

string

required

The name of the logical database in the primary Postgres instance.

username

string

required

The primary database username.

password

string

required

The primary database password.

port

integer

The primary database server port. Defaults to 5432.

ssl

boolean

Whether to use SSL for the primary connection. Defaults to true.

annotations

object

Optional metadata as key-value pairs.

replication_slots

array

Hide properties

string

required

The ID of the replication slot to update.

publication_name

string

The name of the publication to use for this replication slot.

slot_name

string

The name of the replication slot.

status

string

The replication slot status. Possible values: “active”, “disabled”.

Response

Show properties

string (uuid)

The ID of the database connection.

name

string

The user-defined name for the database connection.

hostname

string

The hostname of the database server.

port

integer

The port number for the database connection.

database

string

The name of the logical Postgres database to connect to.

username

string

The username for authenticating with the database.

password

string

The password for authenticating with the database. This will be obfuscated unless show_sensitive=true is used.

ssl

boolean

Indicates whether SSL is enabled for the connection.

ipv6

boolean

Indicates whether the hostname resolves to an IPv6 address.

use_local_tunnel

boolean

Indicates whether this database connection uses the Sequin local tunnel.

pool_size

integer

Database connection pool size (internal setting).

queue_interval

integer

Database connection pool queue interval (internal setting).

queue_target

integer

Database connection pool queue target (internal setting).

replication_slots

array

Details about the associated replication slot. Will be an empty array if no slot exists.

Hide properties

string (uuid)

The ID of the replication slot.

publication_name

string

The name of the Postgres publication used for replication.

slot_name

string

The name of the Postgres replication slot.

status

string (enum: active | disabled)

The current status of the replication slot.

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "url": "postgresql://postgres:secret-password@new-db.example.com:5432/postgres"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com",
    "replication_slots": [
      {
        "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
        "publication_name": "new_sequin_pub",
        "slot_name": "new_sequin_slot"
      }
    ]
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/example-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "example-db-renamed",
    "hostname": "new-db.example.com"
  }'

curl --request PUT \
  --url https://api.sequinstream.com/api/postgres_databases/replica-db \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "name": "replica-db-renamed",
    "hostname": "new-replica.example.com",
    "primary": {
      "hostname": "new-primary.example.com"
    }
  }'

{
  "id": "db_01HRMW3ZNE5EFGW9SDXW01TT92",
  "name": "example-db-renamed",
  "hostname": "new-db.example.com",
  "database": "postgres",
  "username": "postgres",
  "password": "************",
  "port": 5432,
  "ssl": true,
  "use_local_tunnel": false,
  "ipv6": false,
  "replication_slots": [
    {
      "id": "rs_01HRMW3ZNE5EFGW9SDXW01TT93",
      "publication_name": "new_sequin_pub",
      "slot_name": "new_sequin_slot",
      "status": "active"
    }
  ]
}

Create database Delete database

​Path parameters

​Request body

​Response

Path parameters

Request body

Response