Create Connection | Polytomic Docs

curl -X POST https://app.polytomic.com/api/connections \
     -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",
  "type": "postgresql"
}'

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

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.

Creates a new connection of the specified type. Use [`GET /api/connection_types`](../../api-reference/connections/get-types) to retrieve the list of available types and their parameter schemas. The `configuration` object is type-specific; consult the [integration guides](../../guides/configuring-your-connections/overview) 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.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

namestringRequired

typestringRequired

healthcheck_intervalstringOptional

Override interval for connection health checking.

organization_idstring or nullOptionalformat: "uuid"

policieslist of strings or nullOptional

redirect_urlstringOptional

URL to redirect to after completing OAuth flow.

validatebooleanOptionalDefaults to true

Validate connection configuration.

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors