---
title: "Patch Pipeline"
method: PATCH
path: "/api/v2/pipelines/{name}"
tags: ["v2", "pipelines"]
---

# Patch Pipeline

`PATCH /api/v2/pipelines/{name}`

Updates a pipeline partially (only updates specified fields), with retries on 409 conflicts received from the K8s API server.

## Path parameters

- `name` string, required — Pipeline name

## Query parameters

- `dry_run` boolean, nullable — Only validate the provided configuration without making changes

## Request body

- PipelinePatchRequest — Request model for updating a pipeline partially.
  - `active` boolean, nullable
  - `config` object, nullable

## Response `200`

Successful Response

- PipelineResponse — Response model containing the details of a pipeline.
  - `name` string, required
  - `active` boolean, required
  - `config` object, required
  - `status` 'started' | 'stopped' | 'error' | 'creating' | 'updating' | 'deleting' | 'starting' | 'stopping' | 'resetting' | 'pending' | 'unknown' — Pipeline status.
  - `errors` RedisDiApiModelsErrorsError[]
    - `code` 'validation_error' | 'job_validation_error' | 'request_validation_error' | 'pipeline_error' | 'pipeline_pending' | 'pipeline_component_error' | 'operation_error', required — Error codes
    - `message` string, required
    - `details` object
  - `components` PipelineComponentResponse[]
    - `name` string, required
    - `type` 'debezium-collector' | 'collector-api' | 'stream-processor' | 'unknown', required — Component types for RDI pipeline components.
    - `version` string, required
    - `status` 'started' | 'stopped' | 'error' | 'creating' | 'updating' | 'deleting' | 'starting' | 'stopping' | 'resetting' | 'pending' | 'unknown' — Pipeline status.
    - `errors` string[], nullable
    - `metric_collections` string[], nullable
  - `current` boolean

## Other responses

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

## Changes

- **2026-02-02** `f0a3d26cc0c6` — 1 info
  - endpoint added
- **2025-02-27** `b0ed6c7dac42` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/redis/apis/redis-data-integration-api/changes/api/v2/pipelines/:name/patch.md)

---

[API](https://skmtc.dev/redis/apis/redis-data-integration-api.md) · [All operations](https://skmtc.dev/redis/apis/redis-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redis/redis-data-integration-api/revisions/f0a3d26cc0c6/schema)