Skip to main content

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
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)

Responses
200

Support bundle containing diagnostic information

Schema OPTIONAL
string
404

Pipeline with that name does not exist

Schema OPTIONAL
details object

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 object

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 object

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.