DatabaseConnection

Test database connection

Changed on

Test an existing database connection to validate connection parameters

post/database/connections/test

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/database/connections/test
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Request body

workspace_idstring

Workspace ID

environment_idstring

Environment ID

Response

Database query execution

idstring

DatabaseQueryExecution ID

workspace_idstring

Workspace ID

database_connection_idstring

Database connection ID

environment_idstring

Environment ID

execution_command'get_schema' | 'test_connection'

Command to run against database

snippet_idstring

ID of reusable SQL query to execute

querystring

Base64 encoded SQL query to execute

status'scheduled' | 'running' | 'complete' | 'failure'

Current status of query execution

results_uristring

GCS storage bucket location of the query results

test_context_idstring

The test run id if the query is being executed during a cloud run or the user's id for a local run

test_run_idstring

The test run executing this query, when there is one. A run that opted into use_personal_link_agent routes the query through the calling user's personal Link tunnels, as it does the run's other traffic.

created_timeinteger
created_by_idstring
last_updated_timeinteger
last_updated_by_idstring
completed_timeinteger

Changes