A valid request URL is required to generate request examples{
"results": {
"action": "create"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Upsert external connection as code
Create or update a data-app external connection from its code
representation. Enterprise only; requires the manage ExternalConnection
permission. The body nests the document under connection; the optional
secret rides alongside it and is never part of the YAML document.
A valid request URL is required to generate request examples{
"results": {
"action": "create"
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Query Parameters
Body
Deliberately a flat wrapper, NOT ExternalConnectionAsCode & { secret }:
TSOA validates intersection bodies in remove-extras mode, which empties
Record<string, string> fields (customHeaders). Same workaround as
ApiTestExternalConnectionConfigRequest.
Portable document for an external connection, stored as
lightdash/external-connections/<slug>.yml. Never carries the secret —
uploads resolve it from the LIGHTDASH_EXTERNAL_CONNECTION_SECRET_
environment variable on the CLI side.
Show child attributes
Show child attributes
Resolved by the CLI from LIGHTDASH_EXTERNAL_CONNECTION_SECRET_ at upload time. Omitted = leave any stored secret unchanged.
Was this page helpful?