POST
/
v1
/
users
/
{userId}
/
database-connections
/
test
{
  "outcome": "SUCCESS"
}

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

userId
string
required

Body

application/json
databaseType
enum<string>
required

The SQL flavour of the database.

Available options:
POSTGRESQL,
MYSQL,
SQLSERVER,
ORACLE
host
string
required

The host name or address of the database.

port
integer
required

The port number of the database.

databaseName
string
required

The name of the database.

username
string
required

The name of the user to connect to the database as.

password
string
required

The password of the user to connect to the database as.

Response

200 - application/json
outcome
enum<string>
required
Available options:
SUCCESS,
FAILURE
errors
object[]