v3.0
File Coordinator
Servers
Choose a server to use:
/api/v1.0/
https://file-qa.adara.com/api/v1.0/
https://file-prod.adara.com/api/v1.0/
Pipelines
Execute a pipeline on demand
POST /executions/{pipeline_id}
Auth
Path Params
| pipeline_id | string | required |
Example Request
x
curl --request POST \ --url /api/v1.0//executions/{pipeline_id}Responses
204 404
| No response body |
Example Response
204 Sweep initiated
404 Pipeline not found
xxxxxxxxxxNo responseGet the list of pipeline executions
GET /executions
Auth
Query String
| limit | integer | Default: 20 | optional |
| pipeline_id | string | optional | |
| adara_id | string | optional |
Example Request
xxxxxxxxxxcurl --request GET \ --url /api/v1.0//executions?limit=20&pipeline_id={pipeline_id}&adara_id={adara_id}Responses
200 400
| object | object | ||
| active | boolean | optional | |
| response | array[object] | optional | |
| job_id | string | optional | |
| pipeline_id | string | optional | |
| filename | string | optional | |
| status | string | Enum: | optional |
| created | integer | optional | |
| updated | integer | optional |
Example Response
200 Return list of Pipeline executions
400 Bad Request pipeline_id or Adara_id required
xxxxxxxxxx{ "active": "{boolean}", "response": [ { "job_id": "{string}", "pipeline_id": "{string}", "filename": "{string}", "status": "{string}", "created": "{integer}", "updated": "{integer}" } ]}Add a managed file pipeline
POST /pipelines
Auth
Request Body
| object | object | required | |
| origin | object | required | |
| destination | object | required | |
| adara_id | string | required | |
| input | object | required | |
| compression | string | optional | |
| file_type | string | Enum: | required |
| delimiter | string | optional | |
| file_pattern | string | required | |
| encryption | object | optional | |
| key | string | required | |
| type | string | required |
Example Request
xxxxxxxxxxcurl --request POST \ --url /api/v1.0//pipelines \ --data '{ "origin": {}, "destination": {}, "adara_id": "{string}", "input": { "compression": "gzip", "file_type": "json", "delimiter": "|", "file_pattern": "/input/*.csv", "encryption": { "key": "{string}", "type": "{string}" } }}'Responses
200
Example Response
200 New pipeline created
xxxxxxxxxx{ "schema": "{}"}Get list of file pipelines
GET /pipelines
Auth
Example Request
xxxxxxxxxxcurl --request GET \ --url /api/v1.0//pipelinesResponses
200
| object | object | ||
| active | boolean | optional | |
| response | array | optional |
Example Response
200 Return list of existing pipelines
xxxxxxxxxx{ "active": "{boolean}", "response": [ "{array...}" ]}Integrations
Get list of pipeline origin types
GET /origins
Auth
Example Request
xxxxxxxxxxcurl --request GET \ --url /api/v1.0//originsResponses
200
| object | object | ||
| active | boolean | optional | |
| response | array[object] | optional | |
| type | string | required | |
| parameters | object | required |
Example Response
200 Return list of origins
xxxxxxxxxx{ "active": "{boolean}", "response": [ { "type": "{string}", "parameters": {} } ]}Get list of pipeline destinations
GET /destinations
Auth
Example Request
xxxxxxxxxxcurl --request GET \ --url /api/v1.0//destinationsResponses
200
| object | object | ||
| active | boolean | optional | |
| response | array[object] | optional | |
| name | string | required | |
| parameters | object | required |
Example Response
200 Return list of origins
xxxxxxxxxx{ "active": "{boolean}", "response": [ { "name": "onboarding", "parameters": {} } ]}