v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Connections

Create Connection

Creates a new connection of the specified type.

Use GET /api/connection_types to retrieve the list of available types and their parameter schemas. The configuration object is type-specific; consult the integration guides for the required and optional fields for each type.

📘 Polytomic validates the connection against the upstream service immediately on creation. The request will fail if the credentials or endpoint cannot be reached.

post/api/connections

Headers

X-Polytomic-Versionstring

Request body

configurationobject required

healthcheck_intervalstring

Override interval for connection health checking.

namestring required

organization_idstring uuid nullable

policiesstring[] nullable

redirect_urlstring

URL to redirect to after completing OAuth flow.

typestring required

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"
  ],
  "redirect_url": "https://example.com/oauth_redirect",
  "type": "postgresql",
  "validate": true
}

Response

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"
    }
  }
}