Pipelines

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Pipelines do not support sorting.

Query fields

The following fields are required: Project

Field Name (and alias) Operators
Author author =
Project project =
Ref ref =
Scope scope =
SHA sha =
Source source =
Status status =
Updated at updated, updatedAt =, >, <, >=, <=

Author

Description: Filter pipelines by the user who triggered them.

Allowed value types:

  • String
  • User (for example, @username)

Project

Description: Specify the project to query pipelines from. This field is required.

Allowed value types: String

Ref

Description: Filter pipelines by the Git ref (branch or tag name) they ran on.

Allowed value types: String

Scope

Description: Filter pipelines by their scope.

Allowed value types:

  • Enum, one of branches, tags, finished, pending, or running

SHA

Description: Filter pipelines by the commit SHA.

Allowed value types: String

Source

Description: Filter pipelines by what triggered them.

Allowed value types: String

Status

Description: Filter pipelines by their CI/CD status.

Allowed value types:

  • Enum, one of canceled, canceling, created, failed, manual, pending, preparing, running, scheduled, skipped, success, waiting_for_callback, or waiting_for_resource

Updated at

Description: Filter pipelines by when they were last updated.

Allowed value types:

  • AbsoluteDate (in the format YYYY-MM-DD)
  • RelativeDate (in the format <sign><digit><unit>, where sign is +, -, or omitted, digit is an integer, and unit is one of d (days), w (weeks), m (months) or y (years))

Notes:

  • For the = operator, the time range is considered from 00:00 to 23:59 in the user’s time zone.
  • >= and <= operators are inclusive of the dates being queried, whereas > and < are not.

Display fields

Field Name (and alias) Description
Active active Display whether the pipeline is active
Cancelable cancelable Display whether the pipeline can be canceled
Child child Display whether this is a child pipeline
Committed at committed, committedAt Display the commit timestamp
Complete complete Display whether the pipeline is complete
Compute minutes computeMinutes Display the compute minutes used
Config source configSource Display the pipeline configuration source
Coverage coverage Display code coverage percentage
Created at created, createdAt Display when the pipeline was created
Duration duration Display the pipeline duration
Failed jobs count failedJobsCount Display the number of failed jobs
Failure reason failureReason Display the reason for pipeline failure
Finished at finished, finishedAt Display when the pipeline finished
ID id Display the pipeline ID
IID iid Display the pipeline internal ID
Latest latest Display whether this is the latest pipeline for the ref
Name name Display the pipeline name
Path path Display the pipeline path
Ref ref Display the Git ref (branch or tag)
Retryable retryable Display whether the pipeline can be retried
SHA sha Display the commit SHA
Source source Display what triggered the pipeline
Started at started, startedAt Display when the pipeline started
Status status Display the pipeline status
Stuck stuck Display whether the pipeline is stuck
Total jobs totalJobs Display the total number of jobs
Updated at updated, updatedAt Display when the pipeline was last updated
Warnings warnings Display pipeline warnings
YAML errors yamlErrors Display whether the pipeline has YAML errors
YAML error messages yamlErrorMessages Display YAML error messages