Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

DatabaseConnection

Test database connection

Test an existing database connection to validate connection parameters

post/database/connections/test

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

created_timeinteger
created_by_idstring
last_updated_timeinteger
last_updated_by_idstring
completed_timeinteger