Download Support Bundle

GET/v0/pipelines/{pipeline_name}/support_bundle

Authentication

JSON web token (JWT) or API key (http bearer)

Parameters

pipeline_name (path, string, required)

collect (query, boolean)

circuit_profile (query, boolean)

heap_profile (query, boolean)

metrics (query, boolean)

logs (query, boolean)

stats (query, boolean)

pipeline_config (query, boolean)

system_config (query, boolean)

dataflow_graph (query, boolean)

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.

Authentication

Scheme	Type	Details
`JSON web token (JWT) or API key`	Bearer token	Authorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Parameters

Path parameters

Name	Type	Required	Description
`pipeline_name`	string	Yes	Unique pipeline name

Query parameters

Name	Type	Required	Description
`collect`	boolean	No	Whether to collect new data from the running pipeline (default: true) When false, only previously collected data will be included in the bundle
`circuit_profile`	boolean	No	Whether to collect circuit profile data (default: true)
`heap_profile`	boolean	No	Whether to collect heap profile data (default: true)
`metrics`	boolean	No	Whether to collect metrics data (default: true)
`logs`	boolean	No	Whether to collect logs data (default: true)
`stats`	boolean	No	Whether to collect stats data (default: true)
`pipeline_config`	boolean	No	Whether to collect pipeline configuration data (default: true)
`system_config`	boolean	No	Whether to collect system configuration data (default: true)
`dataflow_graph`	boolean	No	Whether to collect dataflow graph data (default: true)

Response

application/zip

Support bundle containing diagnostic information

string (binary)

curl -X GET '/v0/pipelines/{pipeline_name}/support_bundle?collect=%3Ccollect%3E&circuit_profile=%3Ccircuit_profile%3E&heap_profile=%3Cheap_profile%3E&metrics=%3Cmetrics%3E&logs=%3Clogs%3E&stats=%3Cstats%3E&pipeline_config=%3Cpipeline_config%3E&system_config=%3Csystem_config%3E&dataflow_graph=%3Cdataflow_graph%3E' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Support bundle containing diagnostic information


"string"