v1

latestOpenAPI 3.1.0Apache 2.02026-07-2610193196.3 KB

Database connections

Test a database connection

post/v1/users/{userId}/database-connections/test

databaseType'POSTGRESQL' | 'MYSQL' | 'SQLSERVER' | 'ORACLE' required

The SQL flavour of the database.

hoststring required

The host name or address of the database.

portinteger required

The port number of the database.

databaseNamestring required

The name of the database.

usernamestring required

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

passwordstring required

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

Success

outcome'SUCCESS' | 'FAILURE' required