Test Connection | Polytomic Docs

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.

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.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

Connection configuration to test.

typestringRequired

The type of connection to test.

connection_idstringOptionalformat: "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.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

1	curl -X POST https://app.polytomic.com/api/connections/test \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Content-Type: application/json" \
4	-u "<username>:<password>" \
5	-d '{
6	"configuration": {
7	"database": "example",
8	"hostname": "postgres.example.com",
9	"password": "password",
10	"port": 5432,
11	"username": "user"
12	},
13	"type": "postgresql"
14	}'

Authentication

Headers

Request

Errors