Database connections
Create a database connection
Mock APIs
Teams
Organisations
Data sources
Database connections
Usage
Access control
Stub Mappings
- GETGet all stub mappings
- POSTCreate a new stub mapping
- DELDelete all stub mappings
- POSTReset stub mappings
- POSTPersist stub mappings
- POSTImport stub mappings
- GETGet stub mapping by ID
- PUTUpdate a stub mapping
- DELDelete a stub mapping
- POSTFind stub mappings matching metadata
- POSTDelete stub mappings matching metadata
Requests
Database connections
Create a database connection
POST
/
v1
/
users
/
{userId}
/
database-connections
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
userId
string
*
userId
Required
string
object
*
databaseConnection
object
*
databaseConnection
Required
object
connectionName
string
*
connectionName
Required
string
The name of the connection, for display purposes.
databaseType
enum<string>
*
databaseType
Required
enum<string>
The SQL flavour of the database.
host
string
*
host
Required
string
The host name or address of the database.
port
integer
*
port
Required
integer
The port number of the database.
databaseName
string
*
databaseName
Required
string
The name of the database.
username
string
*
username
Required
string
The name of the user to connect to the database as.
password
string
*
password
Required
string
The password of the user to connect to the database as.
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
databaseConnection
object
requiredResponse
201 - application/json
databaseConnection
object
required