Database connections
Test a database connection
POST
/
v1
/
users
/
{userId}
/
database-connections
/
test
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
userId
string
requiredBody
application/json
databaseType
enum<string>
requiredThe SQL flavour of the database.
Available options:
POSTGRESQL
, MYSQL
, SQLSERVER
, ORACLE
host
string
requiredThe host name or address of the database.
port
integer
requiredThe port number of the database.
databaseName
string
requiredThe name of the database.
username
string
requiredThe name of the user to connect to the database as.
password
string
requiredThe password of the user to connect to the database as.
Response
200 - application/json
outcome
enum<string>
requiredAvailable options:
SUCCESS
, FAILURE
errors
object[]