5 title: "pipeline_instances"
9 Copyright (C) The Arvados Authors. All rights reserved.
11 SPDX-License-Identifier: CC-BY-SA-3.0
14 {% include 'notebox_begin_warning' %}
15 This is a legacy API. This endpoint is deprecated, disabled by default in new installations, and slated to be removed entirely in a future major release of Arvados. It is replaced by "container requests.":container_requests.html
16 {% include 'notebox_end' %}
18 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_instances@
22 Example UUID: @zzzzz-d1hrv-0123456789abcde@
26 Deprecated. A pipeline instance is a collection of jobs managed by @arvados-run-pipeline-instance@.
28 Each PipelineInstance has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
30 table(table table-bordered table-condensed).
31 |_. Attribute|_. Type|_. Description|_. Example|
32 |pipeline_template_uuid|string|The "pipeline template":pipeline_templates.html that this instance was created from.||
41 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
43 Required arguments are displayed in %{background:#ccffcc}green%.
47 Create a new PipelineInstance.
51 table(table table-bordered table-condensed).
52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
53 |pipeline_instance|object||query||
57 Delete an existing PipelineInstance.
61 table(table table-bordered table-condensed).
62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
63 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
67 Gets a PipelineInstance's metadata by UUID.
71 table(table table-bordered table-condensed).
72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
73 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
77 List pipeline_instances.
79 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
83 Update attributes of an existing PipelineInstance.
87 table(table table-bordered table-condensed).
88 |_. Argument |_. Type |_. Description |_. Location |_. Example |
89 {background:#ccffcc}.|uuid|string|The UUID of the PipelineInstance in question.|path||
90 |pipeline_instance|object||query||