Create a custom connector definition

POST

/api/v1/custom-connectors/

• Production
• Local development

Create a new custom connector definition.

Validates the definition and persists it. Returns 422 if validation fails.

Args: body: The connector definition.

Returns: The created connector (auth_config excluded).

Authorizations

• ApiKeyAuth

Request Body ^required

Request body for creating a custom connector.

object

auth_config

object

key

additional properties

any

auth_type

required

Api_key, bearer, oauth2, or basic

string

base_url

required

string

<= 2048 characters

description

Any of:

string

string

null

null

display_name

required

string

<= 255 characters

endpoints

Array<object>

object

key

additional properties

any

slug

required

string

<= 100 characters

Responses

201

Successful Response

Response model for a custom connector (auth_config excluded).

object

auth_type

required

string

base_url

required

string

created_at

Any of:

string

string format: date-time

null

null

description

Any of:

string

string

null

null

display_name

required

string

endpoints

Array<object>

object

key

additional properties

any

id

required

string

is_active

required

boolean

last_test_at

Any of:

string

string format: date-time

null

null

last_test_success

Any of:

boolean

boolean

null

null

slug

required

string

updated_at

Any of:

string

string format: date-time

null

null

version

required

integer

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string