Sign in

v5

latestOpenAPI 3.1.02026-08-04166362486.5 KB
data_sources
data_sources

Update a connector

Update a connector.

Args: data_source_id: The ID of the data source to update a connector for. connector_id: The ID of the connector to update. params: The connector to update.

Returns: The updated connector.

put/v1/data_sources/{data_source_id}/connectors/{connector_id}

Path parameters

data_source_idstring uuid required

The ID of the data source to update a connector for

The ID of the data source to update a connector for

connector_idstring uuid required

The ID of the connector to update

The ID of the connector to update

Request body

namestring nullable

The name of the connector

metadataobject nullable

The metadata of the connector

trigger_syncboolean nullable

Whether the connector should be synced after update

Response

The updated connector

idstring required

The ID of the connector

created_atstring date-time required

The creation time of the connector

updated_atstring date-time required

The last update time of the connector

store_idstring required

The ID of the store

data_source_idstring required

The ID of the data source

namestring

The name of the connector

{"stackTrail":"components:schemas:DataSourceConnector:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"The metadata of the connector","nullable":true}
polling_intervalstring duration required

The polling interval of the connector

started_atstring date-time nullable required

The start time of the connector

finished_atstring date-time nullable required

The finish time of the connector

last_synced_atstring date-time nullable required

The last sync time of the connector

status'idle' | 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed' required
errorobject nullable required

The sync error of the connector

object'data_source.connector'

The type of the object