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

...



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


h2. create

Create a new PipelineInstance.

Arguments:

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

h2. 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||

h2. destroy

destroy pipeline_instances

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string||path||

h2. 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||

h2. index

index pipeline_instances

Arguments:

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

h2. 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||
|pageToken|string|Page token.|query||
|q|string|Query string for searching pipeline_instances.|query||
|where|object|Conditions for filtering pipeline_instances.|query||

h2. show

show pipeline_instances

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string||path||

h2. 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||