Get Pipelines

Description: Gets a collection of pipelines that the credential has access to. Filter criteria can be supplied via query string parameters.

Security: Requires a valid user

Usage: GET api/v1/pipelines

Query Parameters:

Parameter	Data Type	Description
`projectIds`	string	Optional. A filter on the list based on the `projectId` property of the pipeline. Expects a comma separated string of projectIds.
`pipelineSourceBranches`	string	Optional. A filter on the list based on the `pipelineSourceBranch` property of the pipeline. Expects a comma separated string of pipelineSourceBranches.
`pipelineIds`	string	Optional. A filter on the list based on the `id` property of the pipeline. Expects a comma separated string of ids.
`names`	string	Optional. A filter on the list based on the `name` property of the pipeline. Expects a comma separated string of names.
`pipelineSourceIds`	string	Optional. A filter on the list based on the `pipelineSourceId` property of the pipeline. Expects a comma separated string of pipelineSourceIds.
`includeDeleted`	boolean	Optional. A filter on the list based on the `isDeleted` property of the pipeline. Default false.
`isDeleted`	boolean	Optional. A filter on the list based on the `isDeleted` property of the pipeline. If includeDeleted is true, this will be ignored.
`deletedBefore`	string($date-time)	Optional. A filter on the list that returns if `deletedAt` property of the pipeline is less than `deletedBefore`.
`light`	boolean	Optional. Default is false. If set to true only part of the data is returned
`sortBy`	string	Optional. Comma separated list of sort attributes
`sortOrder`	integer	Optional. 1 for ascending and -1 for descending based on`sortBy`
`limit`	integer	Optional. A limit on the number of pipelines returned.
`skip`	integer	Optional. A cursor for use in pagination. `skip` defines the number of pipelines skipped.

Produces: application/json

Sample Usage:

GET api/v1/pipelines?light=true
[
  {
    "id": 375,
    "name": "gradle_pipeline",
    "pipelineSourceBranch": null,
    "pipelineSourceId": 544,
    "latestRunId": 717
  },
  {
    "id": 98,
    "name": "basic",
    "pipelineSourceBranch": null,
    "pipelineSourceId": 130,
    "latestRunId": null,
  }
]

Response Codes:

200: Success