---
layout: default
navsection: api
navmenu: API Methods
title: "pipeline_instances"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@

UUID type: @d1hrv@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Resource

Deprecated.  A pipeline instance is a collection of jobs managed by @aravdos-run-pipeline-instance@.

Each PipelineInstance has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|pipeline_template_uuid|string|||
|name|string|||
|components|hash|||
|success|boolean|||
|active|boolean|||
|properties|Hash|||

h2. Methods

h3. create

Create a new PipelineInstance.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|pipeline_instance|object||query||

h3. delete

Delete an existing PipelineInstance.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||

h3. get

Gets a PipelineInstance's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||

h3. list

List pipeline_instances.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of pipeline_instances to return.|query||
|order|string|Order in which to return matching pipeline_instances.|query||
|filters|array|Conditions for filtering pipeline_instances.|query||

h3. update

Update attributes of an existing PipelineInstance.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
|pipeline_instance|object||query||