Skip to content
Navigation

List all pipelines

GET
http://localhost:5115/api/v1/pipelines

Query parameters

  • starting_after
    optional
    string
  • limit
    optional
    integer
    format: int32 · minimum: 0

Returns

200

Got pipelines collection

JSON
  • data
    array of
    object
    required
    • action_in_progress
      boolean
      required
    • action_text
      string
      required
    • checkpoint_interval_micros
      integer
      required
      format: int64 · minimum: 0
    • created_at
      integer
      required
      format: int64 · minimum: 0
    • graph
      object
      required
      • edges
        array of
        object
        required
        • dest_id
          integer
          required
          format: int32 · minimum: 0
        • edge_type
          string
          required
        • key_type
          string
          required
        • src_id
          integer
          required
          format: int32 · minimum: 0
        • value_type
          string
          required
      • nodes
        array of
        object
        required
        • description
          string
          required
        • node_id
          integer
          required
          format: int32 · minimum: 0
        • operator
          string
          required
        • parallelism
          integer
          required
          format: int32 · minimum: 0
    • id
      string
      required
    • name
      string
      required
    • preview
      boolean
      required
    • query
      string
      required
    • stop
      none
      or
      checkpoint
      or
      graceful
      or
      immediate
      or
      force
      required
    • tags
      map of
      string
      required

      User-defined key/value tags associated with the pipeline.

    • udfs
      array of
      object
      required
      • definition
        string
        required
      • language
        optional
        python
        or
        rust
    • action
      optional
      none
      or
      checkpoint
      or
      graceful
      or
      immediate
      or
      force
      or null
    • state_url
      optional
      string
      or null

      Optional URL pointing to the state the pipeline was started from.

  • hasMore
    boolean
    required

Type to search…

↑↓ navigate↵ selectEsc close