Skip to main content
POST
/
v2
/
connectors
/
test
Test Connector
curl --request POST \
  --url https://app.textql.com/v2/connectors/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "connector_type": "POSTGRES",
    "name": "<string>",
    "auth_strategy": "<string>"
  },
  "connector_id": "<string>"
}
'
{
  "success": true,
  "error": "<string>"
}

Authorizations

ā€‹
Authorization
string
header
required

API key or JWT token

Body

application/json
ā€‹
config
object
required

A connector's type, display name, and type-specific connection metadata.

Set exactly one metadata field matching connector_type (e.g. connector_type: POSTGRES ā‡’ set postgres). The common database types are documented below; every supported type follows the same shape ā€” see the proto ConnectorConfig for the full list (Snowflake, BigQuery, Databricks, Tableau, PowerBI, SQL Server, Trino, etc.).

Confidential fields (passwords, keys, tokens) are write-only: they are never returned by read endpoints, and on update they are preserved from the stored connector when sent empty.

ā€‹
connector_id
string

Optional. ID of an existing connector whose confidential fields should fill in any empty confidential fields in config before the connection is attempted.

Response

Test result

ā€‹
success
boolean
required

Whether the connection succeeded.

ā€‹
error
string

Failure detail when success is false; empty otherwise.