Sign in

v4

latestOpenAPI 3.1.02026-08-01166346466.7 KB
data_sources
data_sources

Create a new connector

Create a new connector.

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

Returns: The created connector.

post/v1/data_sources/{data_source_id}/connectors

Path parameters

data_source_idstring uuid required

The ID of the data source to create a connector for

The ID of the data source to create a connector for

Request body

store_idstring required

The ID of the store

namestring

The name of the connector

trigger_syncboolean

Whether the connector should be synced after creation

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

Response

The created 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