Management Of Connector Lifecycle

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}/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.
Responses
200

Success In Restarting Connector

Returns RestartConnectorResponse of type(s) application/json 
{
    "id": "testconnector1",
    "status": "STARTED"
}
string
id
Optional

Instance id of the connector object

string
status
Optional

Status of the object after restart operation


400

Invalid Request sent by the user

Operation doesn't return any data structure

401

User authentication failed

Operation doesn't return any data structure

403

Access to the requested resource/operation is forbidden

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/dcc/v1/connectors/{connector-name}
On This Page
Connector Operations
GET
List Connector Instances
POST
Create Connector
GET
Get Connector Instance
PUT
Update Connector Instance
DELETE
Delete Connector
POST
Management Of Connector Lifecycle