Update Connection

PATCH

https://app.polytomic.com/api/connections/:id

PATCH

/api/connections/:id

curl -X PATCH https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -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_dark_url": "https://connect-assets.polytomic.com/logos/dark/postgresql.svg",
      "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
      "name": "PostgreSQL",
      "operations": [
        "bulksyncsource"
      ]
    }
  }
}

Updates a connection's configuration.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Connection ID

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"

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

policieslist of strings or nullOptional

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.

reconnectbooleanOptional

validatebooleanOptionalDefaults to true

Validate connection configuration.

typestringOptionalDeprecated

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

Response

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors