Download Support Bundle

Generate a support bundle for a pipeline.

This endpoint collects various diagnostic data from the pipeline including circuit profile, heap profile, metrics, logs, stats, and connector statistics, and packages them into a single ZIP file for support purposes.

Path Parameters
pipeline_name string — REQUIRED Unique pipeline name

Query Parameters
collect boolean Whether to collect new data from the running pipeline (default: true) When false, only previously collected data will be included in the bundle
limit int64 Maximum number of collections to include in the bundle, counted from the most recent. Must be at least 1; limit=0 is rejected with HTTP 400. Omit the parameter to include every retained collection (which is capped server-side by --support-data-retention, default 3). With the default collect=true, limit=1 returns only the collection gathered by this request. Combine with collect=false to return the most recent previously stored collections instead.
circuit_profile boolean Whether to collect circuit profile data (default: true)
heap_profile boolean Whether to collect heap profile data (default: true)
metrics boolean Whether to collect metrics data (default: true)
logs boolean Whether to collect logs data (default: true)
stats boolean Whether to collect stats data (default: true)
pipeline_config boolean Whether to collect pipeline configuration data (default: true)
system_config boolean Whether to collect system configuration data (default: true)
dataflow_graph boolean Whether to collect dataflow graph data (default: true)
pipeline_events boolean Whether to collect the pipeline monitor event history (default: true)

Responses
200 Support bundle containing diagnostic information Schema — OPTIONAL string
400 A query parameter was invalid (e.g., limit=0) Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.
404 Pipeline with that name does not exist Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.
500 Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.
503 Schema — OPTIONAL details Detailed error metadata. The contents of this field is determined by error_code. error_code string Error code is a string that specifies this error type. message string Human-readable error message.