Test a connection

post

https://api.data.world/v0/connections/test

Test a virtual connection. For increased security, connection endpoints require an Enterprise Admin Token. This token can be found under Advanced Settings.

Body Params

advancedProperties

object

Advanced properties

credentials

object

Database Credentials

database

string

length between 0 and 256

Database/Schema Logical Name

host

string

Database Host

name

string

length between 0 and 1024

Connection name

port

int32

1 to 65535

Database Port

properties

object

Properties such as auto commit, isolation level etc.

sshTunnel

object

ssh tunnel configuration

sslRequired

boolean

Is ssl required

trustedServerCertificates

string

length between 0 and 100000

trusted server certificates

type

string

enum

Database Type

usePrivateKey

boolean

Should this connection use a private key?

verifyServerCertificate

boolean

Should server certificate be verified

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation

400Bad Request

401User is unauthorized to perform action

403Access forbidden

404Not found

422Unable to parse request. URLs provided must be fully-formed http or https URLs

500Server error