Redpanda Connect Pipelines

List Redpanda Connect pipelines

Changed on

List Redpanda Connect pipelines. Optional: filter based on pipeline name.

get/v1/redpanda-connect/pipelines

Request

  • Base URL
    https://{dataplane_api_url}
  • Auth
    OAuth 2
    Implicit: https://auth.prd.cloud.redpanda.com/oauth/authorize

Query parameters

filter.name_containsstring

Any pipelines that partially match this name will be returned.

filter.tags[string]string

This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18

filter.secret_idstring
filter.statesstring[]

Only pipelines in one of these states will be returned. Drafts additionally require include_drafts.

  • STATE_STARTING: The pipeline is starting.
  • STATE_RUNNING: The pipeline is running.
  • STATE_STOPPING: The pipeline is in the process of stopping.
  • STATE_STOPPED: The pipeline is stopped and in paused state.
  • STATE_ERROR: The pipeline encountered an error. See Error Handling for further guidance.
  • STATE_COMPLETED: The pipeline has completed the job successfully.
  • STATE_DRAFT: The pipeline is saved but has never been deployed. It does not run, is not billed, and its configuration may be incomplete or invalid. StartPipeline validates and deploys it. Omitted from ListPipelines unless ListPipelinesRequest.Filter.include_drafts is set.
filter.include_draftsboolean

Include drafts (STATE_DRAFT) in the response. Drafts are excluded by default, even when states names STATE_DRAFT, so that clients written before drafts existed never receive a state they cannot render.

page_sizeinteger

Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination.

page_tokenstring

Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.

Response

OK

next_page_tokenstring

Changes

    • info

      added the optional property // to the response with the status

    • warning

      added the new STATE_DRAFT enum value to the // response property for the response status

    • info

      added the new optional query request parameter filter.include_drafts

    • info

      added the new optional query request parameter filter.states

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status