Skip to content

Update a custom connector

PUT
/api/v1/custom-connectors/{connector_id}

Update an existing custom connector definition.

Bumps the version number on each update.

Args: connector_id: The connector UUID. body: The updated definition.

Returns: The updated connector (auth_config excluded).

Authorizations

Parameters

Path Parameters

connector_id
required
string format: uuid

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
display_name
required
string
<= 255 characters
endpoints
Array<object>
object
key
additional properties
any
slug
required
string
<= 100 characters

Responses

200

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 format: date-time
description
Any of:
string
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 format: date-time
last_test_success
Any of:
boolean
slug
required
string
updated_at
Any of:
string format: date-time
version
required
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string