CDC Application APIs

Gathr’s REST API supports the following actions on CDC applications:


Start CDC Application

This API will start a Gathr CDC application with the following REST call.

Request URL

POST https://app.gathr.one/api/v1/application/start

Headers

Parameter NameDescription
Content-Typeapplication/json
Authorization< gathr-user-token >

Request Body

{
"name":"<your_cdc_app_name>",
"appType":"cdc",
"groupName":"<your_cdc_app_group_name>",
"projectName":"<your_project_name>"
}

Request Body Parameters

NameRequiredDescription
nameYESThe name of the CDC application to be started.
appTypeYESThe type of the Gathr application that should be started. Value to be provided - cdc
projectNameYESThe group name of the CDC application to be started.
projectNameYESGathr project name containing CDC application to be started.

Response

HTTP Status Code: 200

{"message": "Request to start the application is accepted.",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}

Stop CDC Application

This API will stop a Gathr CDC application with the following REST call.

Request URL

POST https://app.gathr.one/api/v1/application/stop

Headers

Parameter NameDescription
Content-Typeapplication/json
Authorization< gathr-user-token >

Request Body

{
"name":"<your_cdc_app_name>",
"appType":"cdc",
"groupName":"<your_cdc_app_group_name>",
"projectName":"<your_project_name>"
}

Request Body Parameters

NameRequiredDescription
nameYESThe name of the CDC application to be stopped.
appTypeYESThe type of the Gathr application that should be stopped. Value to be provided - cdc
groupNameYESThe group name of the CDC application to be stopped.
projectNameYESThe Gathr project name containing the CDC application to be stopped.

Response

HTTP Status Code: 200

{"message": "Request to stop the application is accepted.",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}

Get CDC Application Status

This API will get the status of a Gathr CDC application with the following REST call.

Request URL

GET https://app.gathr.one/api/v1/application/status/<appType>/<appName>

Headers

Parameter NameDescription
Content-Typeapplication/json
Authorization< gathr-user-token >

Query Parameters

NameRequiredDescription
appTypeYESThe type of the Gathr application to fetch the status. Value to be provided - cdc
appNameYESThe group name of the CDC application for which the status is to be fetched.

Response

HTTP Status Code: 200

{"application_status": "STOPPED",
"status": "Success"}
{"application_status": "STARTING",
"status": "Success"}
{"application_status": "RUNNING",
"status": "Success"}
{"application_status": "ERROR",
"status": "Success"}

HTTP Status Code: 400

{"message": "<A description of the error will be provided.>",
"status": "Error"}
Top