Skip to main content

ConnectorCreate

Payload used to create Connector. Required fields are name, type.

nameName (string)required
alias object
anyOf
string
typeType (string)required

Connector category selected from the supported connector types.

driver object

Built-in connector driver identifier returned in connector type metadata. Omit this field for a custom connector defined by script; when provided, the driver type must match type.

anyOf
string
collection_id object

Identifier of the containing collection.

anyOf
string

Possible values: non-empty

tags object
anyOf
  • Array [
    • string
  • ]
    • description object
    anyOf
    string
    is_builtinIs Builtin (boolean)

    Whether this is a built-in connector

    Default value: false
    options object
    property name*any
    Default value: {}
    credentials object
    property name* ConnectorCredentialInput

    Request-only connector credential value.

    valueValue (string)required

    Possible values: non-empty

    scriptScript (string)

    Connector script

    Default value:
    packagesstring[]

    Required Python packages

    Default value: []
    metadata object
    anyOf
    object
    ConnectorCreate
    {
      "name": "string",
      "alias": "string",
      "type": "string",
      "driver": "string",
      "collection_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "is_builtin": false,
      "options": {},
      "credentials": {},
      "script": "",
      "packages": [
        "string"
      ],
      "metadata": {}
    }