Performs a dry run of creating the connection, testing it, and then deleting the connection. For more information on connections, see Connection Types.
Version: v4
Request Type: POST
Endpoint:
/v4/connections/dryRun |
Request Body - Relational Connection:
For relational connections, the request body should look like the following. All properties are required unless noted.
NOTE: Relational connections require the creation and installation of an encryption key file on the |
This example creates a Postgres connection of basic
credentials type. A valid username/password combination must be specified in the credentials
property.
{ "connectParams": { "vendor": "postgres", "vendorName": "postgres", "host": "postgres.example.com", "port": "5432", "database": "myDB" }, "host": "postgres.example.com", "port": 5432, "vendor": "postgres", "params": { "connectStrOpts": "", "database": "myDB" }, "ssl": false, "vendorName": "postgres", "name": "postgres", "description": "", "type": "jdbc", "isGlobal": false, "credentialType": "basic", "credentialsShared": true, "disableTypeInference": false, "credentials": [ { "username": "<username>", "password": "<password>" } ] } |
For more information on these properties, see API Connections Get v4.
Response Status Code - Success: 200 - OK
Response Body Example - success:
{ "result": "SUCCESS", "reason": null } |
Response Body Example - failure:
In the following example, the message indicates that there was a failure to connect to the host.
{ "result": "FAILURE", "reason": { "exception": { "name": "com.trifacta.connect.spring.exception.JdbcConnectionException", "message": "Could not connect to host", "details": "com.trifacta.connect.spring.exception.JdbcConnectionException", "cause": "ConnectException: Connection refused (Connection refused)" } } } |
For more information on the response body properties, see API Connections Get v4.