Management Of Connector Lifecycle

API to start, stop, and restart a connector instance start - connector will start transfering data based on its configuration stop - connector will stop transfering data restart - is usuful if connector is not working as expected

Request

URI

POST

https://{api_host}/tcsa.host.com/dcc/v1/connectors/{connector-name}

COPY

Path Parameters

string

connector-name

Required

Instance id of the connector

connector-name example

demo-connector

Query Parameters

string

action

Required

action to be performed start/stop/restart

action example

start

Possible values are : start, stop, restart,

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Success In Restarting Connector

Returns RestartConnectorResponse of type(s) application/json

{
    "id": "testconnector1",
    "status": "STARTED"
}

string

Optional

Instance id of the connector object

string

status

Optional

Status of the object after restart operation

400

Invalid Request sent by the user