Trigger a Pipeline

Trigger a pipeline, causing the pipeline to complete a run.

Requires the pipelines-trigger permission.

query
  • include

    Accepted Values: creatorsname

  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns an task resource, otherwise returns an Error.

POST /v1/pipelines/5b9c2a77b6393d0001eb45fd/tasks

Example Request
$ curl https://api.cycle.io/v1/pipelines/5b9c2a77b6393d0001eb45fd/tasks \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -H "Content-Type: application/json" \
  -d '{"action":"trigger"}' \
  -X POST
Example Response
{
  "data": {
    "action": "trigger",
    "job_id": "5d01b9b3db2ab00001508cd8"
  }
}