Ingestion Application APIs
Access to REST API operations is only available to users with a business plan subscription.
Gathr’s REST API supports the following actions on Ingestion applications:
Start Ingestion Application
This API will start a Gathr Ingestion application with the following REST call.
Request URL
POST https://app.gathr.one/api/v1/application/start
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Request Body
{
"name":"<your_ingestion_app_name>",
"appType":"ingestion",
"projectName":"<your_project_name>"
}
Request Body Parameters
| Name | Required | Description |
|---|---|---|
name | YES | The name of the Ingestion application to be started. |
appType | YES | The type of the Gathr application that should be started. Value to be provided - Ingestion |
projectName | YES | Gathr project name containing Ingestion 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 Ingestion Application
This API will stop a Gathr Ingestion application with the following REST call.
Request URL
POST https://app.gathr.one/api/v1/application/stop
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Request Body
{
"name":"<your_ingestion_app_name>",
"appType":"ingestion",
"projectName":"<your_project_name>"
}
Request Body Parameters
| Name | Required | Description |
|---|---|---|
name | YES | The name of the Ingestion application to be stopped. |
appType | YES | The type of the Gathr application that should be stopped. Value to be provided - Ingestion |
projectName | YES | The Gathr project name containing the Ingestion 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 Ingestion Application Status
This API will get the status of a Gathr Ingestion application with the following REST call.
Request URL
GET https://app.gathr.one/api/v1/application/status/<appType>/<appName>
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Query Parameters
| Name | Required | Description |
|---|---|---|
appType | YES | The type of the Gathr application to fetch the status. Value to be provided - Ingestion |
appName | YES | The name of the Ingestion 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"}
Update Ingestion Application
This API will update a Gathr Ingestion application with the following REST call.
Request URL
POST https://app.gathr.one/api/v1/application/update
Headers
| Parameter Name | Description |
|---|---|
Content-Type | application/json |
Authorization | < gathr-user-token > |
Request Body
{
"name":"<your_Ingestion_app_name>",
"appType":"Ingestion",
"projectName":"<your_project_name>",
"bucketName":"<yourS3BucketName>",
"filename":["file-1.csv,file-2.csv,file-3.csv"]
}
Request Body Parameters
| Name | Required | Description |
|---|---|---|
name | YES | The name of the Ingestion application to be updated. |
appType | YES | The type of the Gathr application that should be updated. Value to be provided – Ingestion |
projectName | YES | The Gathr project name containing the Ingestion application to be updated. |
bucketName | YES | The bucket name to be updated in the component’s configuration should be provided. |
filename | YES | The array of files to be to be updated in the component’s configuration should be provided. |
Response
HTTP Status Code: 200
{"message": " Application updated successfully.",
"status": "Success"}
HTTP Status Code: 400
{"message": "<A description of the error will be provided.>",
"status": "Error"}
If you have any feedback on Gathr documentation, please email us!