---
title: "Test a database connection"
method: POST
path: "/v1/users/{userId}/database-connections/test"
tags: ["Database connections"]
---

# Test a database connection

`POST /v1/users/{userId}/database-connections/test`

## Request body

- DatabaseConnectionCoords
  - `databaseType` 'POSTGRESQL' | 'MYSQL' | 'SQLSERVER' | 'ORACLE', required — The SQL flavour of the database.
  - `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`

Success

- object
  - `outcome` 'SUCCESS' | 'FAILURE', required
  - `errors` SingleError[]
    - `code` number
    - `title` string, required
    - `detail` string
    - `source` object

## Other responses

- `400` — 400 Bad Request response
- `401` — 401 Unauthenticated response
- `403` — 403 Unauthorized response

---

[API](https://skmtc.net/wiremock/apis/wiremock-cloud.md) · [All operations](https://skmtc.net/wiremock/apis/wiremock-cloud/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wiremock/wiremock-cloud/revisions/93bebefc672f/schema)