
<h1 class="has-pills">
  Pipeline
  <span data-algolia-exclude><span class="pill pill--object pill--normal-case pill--large"><code>OBJECT</code></span></span>
</h1>

A pipeline



| `allowRebuilds` `Boolean` Whether existing builds can be rebuilt as new builds. |
| --- |
| `archived` `Boolean!` Whether this pipeline has been archived |
| `archivedAt` `DateTime` The time when the pipeline was archived |
| `archivedBy` `User` The user that archived this pipeline |
| `badgeURL` `String!` The URL for build badge to the show the current build state for a pipeline. |
| `branchConfiguration` `String` A branch filter pattern to limit which pushed branches trigger builds on this pipeline. |
| `builds` `BuildConnection` Returns the builds for this pipeline Arguments `after` `String` Returns the elements in the list that come after the specified cursor. |
| `before` `String` Returns the elements in the list that come before the specified cursor. |
| `branch` `[String!]` Use `%default` to search by the Pipelines default branch |
| `commit` `[String!]` |
| `createdAtFrom` `DateTime` |
| `createdAtTo` `DateTime` |
| `first` `Int` Returns the first _n_ elements from the list. |
| `last` `Int` Returns the last _n_ elements from the list. |
| `metaData` `[String!]` |
| `state` `[BuildStates!]` |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>cancelIntermediateBuilds</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a></h3><p>When a new build is created on a branch, any previous builds that are running on the same branch will be automatically cancelled</p></td></tr><tr><td><h3 class="is-small has-pills"><code>cancelIntermediateBuildsBranchFilter</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>Limit which branches build cancelling applies to, for example <code>!main</code> will ensure that the main branch won't have it's builds automatically cancelled.</p></td></tr><tr><td><h3 class="is-small has-pills"><code>cluster</code><a href="/docs/apis/graphql/schemas/object/cluster" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT Cluster"><code>Cluster</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>color</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The color of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>commitShortLength</code><a href="/docs/apis/graphql/schemas/scalar/int" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Int"><code>Int!</code></a></h3><p>The shortest length to which any git commit ID may be truncated while guaranteeing referring to a unique commit</p></td></tr><tr><td><h3 class="is-small has-pills"><code>createdAt</code><a href="/docs/apis/graphql/schemas/scalar/datetime" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR DateTime"><code>DateTime</code></a></h3><p>The time when the pipeline was created</p></td></tr><tr><td><h3 class="is-small has-pills"><code>createdBy</code><a href="/docs/apis/graphql/schemas/object/user" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT User"><code>User</code></a></h3><p>The user who created the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>defaultBranch</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The default branch for this pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>defaultTimeoutInMinutes</code><a href="/docs/apis/graphql/schemas/scalar/int" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Int"><code>Int</code></a></h3><p>The default timeout in minutes for all command steps in this pipeline. This can still be overridden in any command step</p></td></tr><tr><td><h3 class="is-small has-pills"><code>description</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The short description of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>emoji</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The emoji of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>favorite</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a></h3><p>Returns true if the viewer has favorited this pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>id</code><a href="/docs/apis/graphql/schemas/scalar/id" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR ID"><code>ID!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>jobs</code><a href="/docs/apis/graphql/schemas/object/jobconnection" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT JobConnection"><code>JobConnection</code></a></h3><div><details><summary>Arguments</summary>

| `after` `String` Returns the elements in the list that come after the specified cursor. |
| --- |
| `agentQueryRules` `[String!]` Filter jobs based on matching agent query rules (for example, a single tag match &quot;queue=test&quot;, or an array of matches [&quot;queue=test&quot;, &quot;tag=value&quot;]) |
| `before` `String` Returns the elements in the list that come before the specified cursor. |
| `concurrency` `JobConcurrencySearch` |
| `first` `Int` Returns the first _n_ elements from the list. |
| `last` `Int` Returns the last _n_ elements from the list. |
| `order` `JobOrder` Order the jobs Default value: `RECENTLY_CREATED` |
| `passed` `Boolean` Whether or not the command job passed. Passing `false` will return all failed jobs (including &quot;soft failed&quot; jobs) |
| `priority` `JobPrioritySearch` |
| `state` `[JobStates!]` |
| `step` `JobStepSearch` Filtering jobs based on related step information |
| `type` `[JobTypes!]` |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>maximumTimeoutInMinutes</code><a href="/docs/apis/graphql/schemas/scalar/int" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Int"><code>Int</code></a></h3><p>The maximum timeout in minutes for all command steps in this pipeline. Any command step without a timeout or with a timeout greater than this value will be set to this value.</p></td></tr><tr><td><h3 class="is-small has-pills"><code>metrics</code><a href="/docs/apis/graphql/schemas/object/pipelinemetricconnection" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineMetricConnection"><code>PipelineMetricConnection</code></a></h3><div><details><summary>Arguments</summary>

| `first` `Int` |
| --- |
| `last` `Int` |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>name</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>The name of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>nextBuildNumber</code><a href="/docs/apis/graphql/schemas/scalar/int" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Int"><code>Int!</code></a></h3><p>The next build number</p></td></tr><tr><td><h3 class="is-small has-pills"><code>organization</code><a href="/docs/apis/graphql/schemas/object/organization" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT Organization"><code>Organization!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>permissions</code><a href="/docs/apis/graphql/schemas/object/pipelinepermissions" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelinePermissions"><code>PipelinePermissions!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>pipelineTemplate</code><a href="/docs/apis/graphql/schemas/object/pipelinetemplate" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineTemplate"><code>PipelineTemplate</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>public</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a><span class="pill pill--deprecated"><code>deprecated</code></span></h3><p><em>Deprecated: Use `visibility`</em></p><p>Whether this pipeline is visible to everyone, including people outside this organization</p></td></tr><tr><td><h3 class="is-small has-pills"><code>repository</code><a href="/docs/apis/graphql/schemas/object/repository" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT Repository"><code>Repository</code></a></h3><p>The repository for this pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>schedules</code><a href="/docs/apis/graphql/schemas/object/pipelinescheduleconnection" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineScheduleConnection"><code>PipelineScheduleConnection</code></a></h3><p>Schedules for this pipeline</p><div><details><summary>Arguments</summary>

| `first` `Int` |
| --- |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>skipIntermediateBuilds</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean!</code></a></h3><p>When a new build is created on a branch, any previous builds that haven't yet started on the same branch will be automatically marked as skipped.</p></td></tr><tr><td><h3 class="is-small has-pills"><code>skipIntermediateBuildsBranchFilter</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>Limit which branches build skipping applies to, for example <code>!main</code> will ensure that the main branch won't have it's builds automatically skipped.</p></td></tr><tr><td><h3 class="is-small has-pills"><code>slug</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>The slug of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>steps</code><a href="/docs/apis/graphql/schemas/object/pipelinesteps" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineSteps"><code>PipelineSteps</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>tags</code><a href="/docs/apis/graphql/schemas/object/pipelinetag" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineTag"><code>[PipelineTag!]</code></a></h3><p>Tags that have been given to this pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>teams</code><a href="/docs/apis/graphql/schemas/object/teampipelineconnection" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT TeamPipelineConnection"><code>TeamPipelineConnection</code></a></h3><p>Teams associated with this pipeline</p><div><details><summary>Arguments</summary>

| `after` `String` Returns the elements in the list that come after the specified cursor. |
| --- |
| `before` `String` Returns the elements in the list that come before the specified cursor. |
| `first` `Int` Returns the first _n_ elements from the list. |
| `last` `Int` Returns the last _n_ elements from the list. |
| `order` `TeamPipelineOrder` Order the pipelines returned Default value: `RECENTLY_CREATED` |
| `search` `String` Search for teams associated that this pipeline is assigned to |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>url</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>The URL for the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>uuid</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>The UUID of the pipeline</p></td></tr><tr><td><h3 class="is-small has-pills"><code>visibility</code><a href="/docs/apis/graphql/schemas/enum/pipelinevisibility" class="pill pill--enum pill--normal-case pill--medium" title="Go to ENUM PipelineVisibility"><code>PipelineVisibility!</code></a></h3><p>Whether this pipeline is visible to everyone, including people outside this organization</p></td></tr><tr><td><h3 class="is-small has-pills"><code>webhookURL</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The webhookURL field returns the webhook URL if the user has edit permissions for the pipeline. Otherwise, it returns null.</p></td></tr>
  </tbody>
</table>

<h2 data-algolia-exclude>Interfaces</h2>
<div>
  <a href="/docs/apis/graphql/schemas/interface/node" class="pill pill--interface pill--normal-case pill--large" title="Go to INTERFACE Node">
  <code>Node</code>
</a>

</div>
