Skip to navigation
API ReferenceConnections

Create Connection

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.

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
configurationmap from strings to any or nullOptional
namestringOptional
organization_idstringOptional
typestringOptional

Response

OK
erroranyOptional
resultanyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error