Update Connection | Polytomic Docs

curl -X PUT https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "configuration": {
    "database": "example",
    "hostname": "postgres.example.com",
    "password": "********",
    "port": 5432,
    "username": "user"
  },
  "name": "My Postgres Connection"
}'

{
  "data": {
    "auth_code": "string",
    "auth_url": "string",
    "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_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
      "name": "PostgreSQL",
      "operations": [
        "bulksyncsource"
      ]
    }
  }
}

Updates a connection’s configuration.

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.

Updates a connection's configuration. 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}`](../../../api-reference/connections/get), 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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

namestringRequired

healthcheck_intervalstringOptional

Override interval for connection health checking.

organization_idstring or nullOptionalformat: "uuid"

policieslist of strings or nullOptional

reconnectbooleanOptional

typestringOptional

validatebooleanOptionalDefaults to true

Validate connection configuration.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors