Test Connection | Polytomic Docs

Tests a connection configuration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

Connections Test Connection Request Bad Request Error

401

Connections Test Connection Request Unauthorized Error

404

Connections Test Connection Request Not Found Error

500

Connections Test Connection Request Internal Server Error

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

Authentication

Headers

Request

Errors