Update Connection | Polytomic Docs

import requests
url = "https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d"
payload = {
    "configuration": {
        "database": "example",
        "hostname": "postgres.example.com",
        "password": "********",
        "port": 5432,
        "username": "user"
    },
    "name": "My Postgres Connection"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "data": {
    "auth_code": "auth_code",
    "auth_url": "auth_url",
    "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": [
        "operations"
      ]
    }
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

namestringRequired

healthcheck_intervalstringOptional

Override interval for connection health checking.

organization_idstringOptionalformat: "uuid"

policieslist of stringsOptional

reconnectbooleanOptional

typestringOptional

validatebooleanOptionalDefaults to true

Validate connection configuration.

Response

dataobject

Errors

400

Connections Update Request Bad Request Error

401

Connections Update Request Unauthorized Error

403

Connections Update Request Forbidden Error

404

Connections Update Request Not Found Error

422

Connections Update Request Unprocessable Entity Error

500

Connections Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors