v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Connections

Test Connection

Tests a connection configuration.

This endpoint is useful for setup flows that want to verify credentials before persisting them.

If you provide connection_id, Polytomic starts from the saved configuration for that connection and then applies the request's configuration values on top. This lets callers test a partial change without resending every existing field.

The request does not persist any configuration changes even when validation succeeds.

post/api/connections/test

Headers

X-Polytomic-Versionstring

Request body

configurationobject required

Connection configuration to test.

connection_idstring uuid

Optional existing connection ID to use as a base for testing. The provided configuration will be merged over the stored configuration for this connection before testing.

typestring required

The type of connection to test.

Example request

{
  "configuration": {
    "database": "example",
    "hostname": "postgres.example.com",
    "password": "password",
    "port": 5432,
    "username": "user"
  },
  "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "type": "postgresql"
}

Response

No Content