/database/test_connection

POST

Tests a database connection

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "database_name": "string",
    "encrypted_extra": "string",
    "extra": "string",
    "impersonate_user": true,
    "server_cert": "string",
    "sqlalchemy_uri": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/database/test_connection' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "database_name": "string",
    "encrypted_extra": "string",
    "extra": "string",
    "impersonate_user": true,
    "server_cert": "string",
    "sqlalchemy_uri": "string"
}'

Responses

🟢200OK

application/json

Database Test Connection

Body

Example

{
    "message": "string"
}

🟠400Bad Request

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-04 22:27:17

/database/import/

/database/{pk}