---
title: "Retrieve the list of available components"
method: GET
path: "/v1/redpanda-connect/components"
tags: ["Redpanda Connect Pipelines"]
---

# Retrieve the list of available components

`GET /v1/redpanda-connect/components`

Returns a JSON list of available [components](https://docs.redpanda.com/redpanda-cloud/develop/connect/components/about), filtered by component type.

## Query parameters

- `read_mask` string

## Response `200`

OK

- ListComponentsResponse
  - `components` ComponentList — ComponentList contains the structured component data.
    - `bloblang_functions` BloblangFunctionSpec[]
      - `categories` string[]
      - `description` string
      - `examples` string[]
      - `name` string
      - `params` ParamSpec — ParamSpec represents parameter specifications.
        - `definitions` ParamDefinition[]
          - `default_value` string
          - `description` string
          - `name` string
          - `type` string
      - `status` string
      - `version` string
    - `bloblang_methods` BloblangMethodSpec[]
      - `categories` string[]
      - `description` string
      - `examples` string[]
      - `name` string
      - `params` ParamSpec — ParamSpec represents parameter specifications.
        - `definitions` ParamDefinition[]
          - `default_value` string
          - `description` string
          - `name` string
          - `type` string
      - `status` string
      - `version` string
    - `buffers` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `caches` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `inputs` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `metrics` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `outputs` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `processors` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `rate_limits` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `scanners` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `tracers` ComponentSpec[]
      - `categories` string[]
      - `config` FieldSpec — FieldSpec represents a field specification.
        - `advanced` boolean
        - `annotated_options` AnnotatedOption[]
          - `description` string
          - `value` string
        - `children` FieldSpec[]
        - `default_value` string
        - `deprecated` boolean
        - `description` string
        - `examples` string[]
        - `interpolated` string[]
        - `kind` string
        - `name` string
        - `optional` boolean
        - `short_description` string — Short plain-text summary of the field, suitable for inline display in config editors. Unlike description, it contains no markup and is capped at roughly 140 characters. Empty when the Redpanda Connect version that produced the schema does not emit short descriptions.
        - `type` string
        - `version` string
      - `description` string
      - `examples` string[]
      - `footnotes` string
      - `name` string
      - `status` 'COMPONENT_STATUS_STABLE' | 'COMPONENT_STATUS_BETA' | 'COMPONENT_STATUS_EXPERIMENTAL' | 'COMPONENT_STATUS_DEPRECATED' — ComponentStatus represents the stability level of a component.
      - `summary` string
      - `type` string
      - `version` string
    - `version` string

## Other responses

- `401` — Unauthenticated.
- `500` — Internal Server Error. Reach out to support.
- `default` — An unexpected error response.

## Changes

> 51 revisions in range; 1 could not be searched.

- **2025-11-13** `45a6313e81ca` — 1 info
  - endpoint added
- **2025-05-27** `dfa71f9d277e` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api/changes/v1/redpanda-connect/components/get.md)

---

[API](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api.md) · [All operations](https://skmtc.dev/redpanda-data/apis/redpanda-cloud-data-plane-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redpanda-data/redpanda-cloud-data-plane-api/revisions/7eef0bcc42e7/schema)
