Update a Pipeline

Update the values of a pipeline resource.

Requires the pipelines-manage 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 

Values
  • name
    string

    A user defined name for the pipeline resource.

  • disable
    bool

    A boolean where true represents this pipeline is disabled.

  • stages
    array of objects

    An array of steps for this stage.

    Show child fields

Returns

Returns an source resource, otherwise returns an Error.

PATCH /v1/pipelines/5b9c2a77b6393d0001eb45fd

Example Request
$ curl https://api.cycle.io/v1/pipelines/5b9c2a77b6393d0001eb45fd \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -H "Content-Type: application/json" \
  -d '{"value":{"name":"Demo Name","disable":true}}' \
  -X PATCH
Example Response
{
  "data": {
    "id": "5ccc2a2226393d1231eb4abd",
    "name": "Demo Name",
    "creator": {
      "id": "5b9c2a77b6393d0001eb45fd",
      "type": "account"
    },
    "hub_id": "5a232a77b6393d0001ac2df2",
    "disable": false,
    "stages": [],
    "state": {
      "changed": "2021-01-11T18:00:44.952Z",
      "current": "live"
    },
    "events": {
      "created": "2021-01-11T18:00:44.952Z",
      "updated": "0001-01-01T00:00:00Z",
      "deleted": "0001-01-01T00:00:00Z",
      "last_run": "0001-01-01T00:00:00Z"
    }
  }
}