Generate Connector

POST

/api/v1/codegen/connector

curl --request POST \
  --url https://example.com/api/v1/codegen/connector \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "target_type": "s3", "execution_mode": "scheduled", "schedule_cron": "example", "table_configs": [ { "target_name": "example", "pii_suppressed": false, "source_dataset": "example", "watermark_column": "example" } ], "target_config": {}, "warehouse": "example", "encode_artifacts": false, "requested_by": "example" }'

Generate connector artifacts for reverse ETL.

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

ConnectorFlowInput

Input model for Connector code generation.

object

name

required

Name

string

target_type

required

Target Type

string

Allowed value: s3

execution_mode

required

Execution Mode

string

Allowed values: scheduled streaming

schedule_cron

Any of:

string

string

null

null

table_configs

required

Table Configs

Array<object>

TableConfig

Table configuration for connectors.

object

target_name

required

Target Name

string

pii_suppressed

Pii Suppressed

boolean

source_dataset

required

Source Dataset

string

watermark_column

Any of:

string

string

null

null

target_config

required

Any of:

object

object

key

additional properties

any

string

string

warehouse

Any of:

string

string

null

null

encode_artifacts

Encode Artifacts

boolean

requested_by

required

Requested By

string

Responses

200

Successful Response

Media typeapplication/json

CodegenResponse

Standard response for all codegen endpoints.

object

status

Status

string

default: success

Allowed values: success error

artifacts

required

Artifacts

Array<object>

ArtifactOutput

Standard artifact output format.

object

path

required

Path

string

content

required

Content

string

file_type

Any of:

string

string

null

null

is_base64

Is Base64

boolean

metadata

Any of:

object

object

key

additional properties

any

null

null

errors

Errors

Array<string>

Example

{
  "status": "success",
  "artifacts": [
    {
      "is_base64": false
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}