---
title: "Update Pipeline"
method: PUT
path: "/api/v1/pipelines/{pipeline_id}"
tags: ["pipelines"]
---

# Update Pipeline

`PUT /api/v1/pipelines/{pipeline_id}`

Updates the attribute on a specific pipeline using its unique id.

Args:
    pipeline_id: ID of the pipeline to get.
    pipeline_update: the model containing the attributes to update.

Returns:
    The updated pipeline object.

## Path parameters

- `pipeline_id` string, uuid, required

## Request body

- PipelineUpdate — Update model for pipelines.
  - `description` string, nullable
  - `add_tags` string[], nullable
  - `remove_tags` string[], nullable

## Response `200`

Successful Response

- PipelineResponse — Response model for pipelines.
  - `body` PipelineResponseBody — Response body for pipelines.
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `user` UserResponse — Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
      - `body` UserResponseBody — Response body for users.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `active` boolean
        - `activation_token` string, nullable
        - `full_name` string
        - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
        - `is_service_account` boolean, required
        - `is_admin` boolean, required
      - `metadata` UserResponseMetadata — Response metadata for users.
        - `email` string, nullable
        - `external_user_id` string, uuid, nullable
        - `user_metadata` object
      - `resources` UserResponseResources — Class for all resource models associated with the user entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `latest_run_id` string, uuid, nullable
    - `latest_run_status` 'initializing' | 'failed' | 'completed' | 'running' | 'cached' — Enum that represents the current status of a step or pipeline run.
  - `metadata` PipelineResponseMetadata — Response metadata for pipelines.
    - `workspace` WorkspaceResponse, required — Response model for workspaces.
      - `body` WorkspaceResponseBody — Response body for workspaces.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
        - `description` string
      - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `description` string, nullable
  - `resources` PipelineResponseResources — Class for all resource models associated with the pipeline entity.
    - `tags` TagResponse[], required
      - `body` TagResponseBody — Response body for tags.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `color` 'grey' | 'purple' | 'red' | 'green' | 'yellow' | 'orange' | 'lime' | 'teal' | 'turquoise' | 'magenta' | 'blue' — All possible color variants for frontend.
        - `tagged_count` integer, required — The count of resources tagged with this tag.
      - `metadata` BaseResponseMetadata — Base metadata model. Used as a base class for all metadata models associated with responses.
      - `resources` TagResponseResources — Class for all resource models associated with the tag entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required — The unique title of the tag.
  - `id` string, uuid, required
  - `permission_denied` boolean
  - `name` string, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)