Skip to content
Authrim

Test database connection

POST
/api/admin/database-connections/{id}/test
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/database-connections/example/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Runs a connectivity test for a setup-managed or admin-managed database connection. Error test results are returned with HTTP 400.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Database connection ID.

Request Body

Section titled “Request Body ”
Media type application/json
object
key
additional properties
Example 
{}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Database connection test result.

Media type application/json
object
status
string
Allowed values: ok error skipped
message
string
latency_ms
integer
checked_at
integer
metadata
object
key
additional properties
key
additional properties
Example 
{
  "status": "ok",
  "message": "Connection test succeeded.",
  "latency_ms": 18,
  "checked_at": 1770000000000,
  "metadata": {
    "provider": "postgres"
  }
}

400

Section titled “400 ”

Database connection test result.

Media type application/json
object
status
string
Allowed values: ok error skipped
message
string
latency_ms
integer
checked_at
integer
metadata
object
key
additional properties
key
additional properties
Example 
{
  "status": "ok",
  "message": "Connection test succeeded.",
  "latency_ms": 18,
  "checked_at": 1770000000000,
  "metadata": {
    "provider": "postgres"
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}