Pipelines Orchestrator API

Pipelines Orchestrator API allows for an easy way of scheduling your pipelines and manage your runners.

A Swagger UI is available at http://pipelies-orchestrator:9600/swagger-ui.html

get
Get Pipelines

http://pipelines-orchestrator:9600/api/pipelines
Retrieve all the scheduled/running pipelines
Request
Response
Request
Response
200: OK
The list of current Pipeline states
[
{
"info": "string",
"instance": {
"instanceId": "string",
"uri": "string"
},
"name": "string",
"pipelineDescription": "string",
"state": "SCHEDULED"
}
]

post
Submit a pipeline

http://pipelines-orchestrator:9600/api/pipelines
Submit a pipeline to the Orchestrator
Request
Response
Request
Body Parameters
pipelineDescription
required
string
The pipeline description
Response
200: OK
The scheduled pipeline state
{
"info": "string",
"instance": {
"instanceId": "string",
"uri": "string"
},
"name": "string",
"pipelineDescription": "string",
"state": "SCHEDULED"
}

get
Get the runners

http://pipelines-orchestrator:9600/api/runners
Get the runner Pipeline Runner instances
Request
Response
Request
Response
200: OK
The running Pipeline Runners
[
{
"instanceId": "string",
"uri": "string"
}
]