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

# Get Pipeline

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

Gets a pipeline by name.

## Path parameters

- `name` string, required — Pipeline name

## 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.
  - `status_changed_at` string, date-time, nullable
  - `errors` RedisDiApiModelsErrorsError[]
    - `code` 'validation_error' | 'job_validation_error' | 'request_validation_error' | 'cdc_validation_error' | 'pipeline_error' | 'pipeline_pending' | 'pipeline_component_error' | 'operation_error', required — Error codes
    - `message` string, required
    - `remediation` string, nullable
    - `details` object
  - `components` PipelineComponentResponse[]
    - `name` string, required
    - `type` 'debezium-collector' | 'collector-api' | 'stream-processor' | 'metrics-exporter' | 'flink-processor-jobmanager' | 'flink-processor-taskmanager' | 'flink-processor' | 'riotx-collector' | '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.
    - `replicas` integer
    - `errors` string[], nullable
    - `metric_collections` string[], nullable
  - `current` boolean

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/redis/apis/redis-data-integration-api.md) · [All operations](https://skmtc.net/redis/apis/redis-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/redis/redis-data-integration-api/versions/30f630f0aac5/schema)