POpolytomic
Connections

Update Connection

Changed on

Updates a connection's configuration.

Connections owned by a managed Harbor return 409 Conflict. To rename the Connection, update its Harbor. Customer-managed Harbor backing Connections remain independently editable.

Updating a connection is a full replacement of its configuration. Any configuration field you omit is cleared. To make a partial change, fetch the current connection with GET /api/connections/{id}, apply your edits, and send the complete object back.

📘 The connection is re-validated against the upstream service after every update. The request will fail if the new credentials or endpoint cannot be reached.

Syncs that are already running when the update is submitted are not interrupted; the updated configuration takes effect on their next execution.

put/api/connections/{id}

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Connection ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

configurationobject required
healthcheck_intervalstring

Override interval for connection health checking

namestring required
organization_idstring uuid nullable

Ignored for user and organization-scoped API keys, which always act in their own organization

policiesstring[] nullable

Permissions policy IDs applied to the connection. A non-empty list replaces the connection's policies and an empty or omitted list leaves them unchanged.

reconnectboolean
typestring

Ignored. A connection's type is fixed at creation.

validateboolean

Validate connection configuration.

Example request

{
  "configuration": {
    "database": "example",
    "hostname": "postgres.example.com",
    "password": "********",
    "port": 5432,
    "username": "user"
  },
  "healthcheck_interval": "3h30m",
  "name": "My Postgres Connection",
  "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "policies": [
    "248df4b7-aa70-47b8-a036-33ac447e668d"
  ],
  "type": "postgresql",
  "validate": true
}

Response

OK

Example response

{
  "data": {
    "configuration": {
      "database": "example",
      "hostname": "postgres.example.com",
      "password": "********",
      "port": 5432,
      "username": "user"
    },
    "healthcheck_interval": "3h30m",
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "name": "My Postgres Connection",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "saved": true,
    "status": "healthy",
    "status_error": "error message",
    "type": {
      "id": "postgresql",
      "logo_dark_url": "https://connect-assets.polytomic.com/logos/dark/postgresql.svg",
      "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
      "name": "PostgreSQL"
    }
  }
}

Changes