Skip to main content
POST
/
v1
/
users
/
{userId}
/
database-connections
/
test
Test a database connection
curl --request POST \
  --url https://wmc.wiremockapi.cloud/v1/users/{userId}/database-connections/test \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "databaseType": "POSTGRESQL",
  "host": "my-db.example.com",
  "port": 5432,
  "databaseName": "my-test-data",
  "username": "alice",
  "password": "mysecretpassword"
}
'
{
  "outcome": "SUCCESS"
}

Authorizations

​
Authorization
string
header
required

Your API key prefixed by 'Token '

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

Success

​
outcome
enum<string>
required
Available options:
SUCCESS,
FAILURE
​
errors
object[]