Create Connection | Polytomic Docs

from polytomic import Polytomic
client = Polytomic(
    version="YOUR_VERSION",
    token="YOUR_TOKEN",
)
client.connections.create(
    configuration={
        "database": "example",
        "hostname": "postgres.example.com",
        "password": "********",
        "port": 5432,
        "username": "user",
    },
    name="My Postgres Connection",
    type="postgresql",
)

{
  "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.

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

namestringRequired

typestringRequired

healthcheck_intervalstringOptional

Override interval for connection health checking.

organization_idstringOptionalformat: "uuid"

policieslist of stringsOptional

redirect_urlstringOptional

URL to redirect to after completing OAuth flow.

validatebooleanOptionalDefaults to true

Validate connection configuration.

Response

dataobject

Errors

400

Connections Create Request Bad Request Error

401

Connections Create Request Unauthorized Error

403

Connections Create Request Forbidden Error

422

Connections Create Request Unprocessable Entity Error

500

Connections Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors