Upsert external connection as code

Error

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"
}

POST

api

projects

{projectUuid}

code

externalConnections

{slug}

Error

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"
}

Path Parameters

projectUuid

string

required

slug

string

required

Query Parameters

force

boolean

Body

application/json

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.

connection

object

required

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

secret

string

Resolved by the CLI from LIGHTDASH_EXTERNAL_CONNECTION_SECRET_ at upload time. Omitted = leave any stored secret unchanged.

Response

Success

results

object

required

Show child attributes

status

enum<string>

required

Available options:

ok

Upsert dashboard as code List charts as code (deprecated)

⌘I

API

Reference

Upsert external connection as code

Path Parameters

Query Parameters

Body

Response