Download Support Bundle
Required role: read or higher.
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.
Request
- The document declares no server URL.
- Auth: HTTP bearer
Path parameters
Unique pipeline name
Query parameters
Whether to collect new data from the running pipeline (default: true) When false, only previously collected data will be included in the bundle
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.
Whether to collect circuit profile data (default: true)
Whether to collect heap profile data (default: true)
Whether to collect metrics data (default: true)
Whether to collect logs data (default: true)
Whether to collect stats data (default: true)
Whether to collect pipeline configuration data (default: true)
Whether to collect system configuration data (default: true)
Whether to collect dataflow graph data (default: true)
Whether to collect the pipeline monitor event history (default: true)
Response
Support bundle containing diagnostic information
Changes
No recorded changes to this operation across all 51 revisions of this API.