Control Input Connector

POST/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/{action}

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, string, required)

table_name (path, string, required)

connector_name (path, string, required)

action (path, string, required)

Start (resume) or pause the input connector.

The following values of the action argument are accepted: start and pause.

Input connectors can be in either the Running or Paused state. By default, connectors are initialized in the Running state when a pipeline is deployed. In this state, the connector actively fetches data from its configured data source and forwards it to the pipeline. If needed, a connector can be created in the Paused state by setting its paused property to true. When paused, the connector remains idle until reactivated using the start command. Conversely, a connector in the Running state can be paused at any time by issuing the pause command.

The current connector state can be retrieved via the GET /v0/pipelines/\{pipeline_name\}/stats endpoint.

Note that only if both the pipeline and the connector state is Running, is the input connector active.


Pipeline state    Connector state    Connector is active?
--------------    ---------------    --------------------
Paused            Paused             No
Paused            Running            No
Running           Paused             No
Running           Running            Yes

Authentication

Scheme	Type	Details
`JSON web token (JWT) or API key`	Bearer token	Authorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name
`table_name`	string	Yes	SQL table name
`connector_name`	string	Yes	Input connector name
`action`	string	Yes

Response

Action has been processed

curl -X POST '/v0/pipelines/{pipeline_name}/tables/{table_name}/connectors/{connector_name}/{action}' \
  -H 'Authorization: Bearer YOUR_TOKEN'