Skip to main content
PATCH
/
v2
/
connectors
/
{id}
Update Connector
curl --request PATCH \
  --url https://app.textql.com/v2/connectors/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "connector_type": "POSTGRES",
    "name": "<string>",
    "auth_strategy": "<string>"
  },
  "allow_sql_write_operations": true,
  "include_db_session_metadata": true
}
'
{
  "id": 123,
  "name": "<string>",
  "type": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key or JWT token

Path Parameters

​
id
integer<int32>
required

Connector ID

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.

​
allow_sql_write_operations
boolean

Allow the connector to execute write/DDL SQL.

​
include_db_session_metadata
boolean

Attach database session metadata to queries.

Response

Updated connector

​
id
integer<int32>

Connector ID

​
name
string

Connector name

​
type
string

Connector type