Download Support Bundle

GET/v0/pipelines/{pipeline_name}/support_bundleMetrics & Debugging

Try it

GET/v0/pipelines/{pipeline_name}/support_bundle

Authentication

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

Parameters

pipeline_name (path, required)

collect (query)

circuit_profile (query)

heap_profile (query)

metrics (query)

logs (query)

stats (query)

pipeline_config (query)

system_config (query)

dataflow_graph (query)

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

JSON web token (JWT) or API keyBearer token

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

200Support bundle containing diagnostic informationapplication/zip

string (binary)

404Pipeline with that name does not existapplication/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

500application/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.

503application/json

object
Information returned by REST API endpoints on error.
- detailsobjectrequired
  Detailed error metadata. The contents of this field is determined by `error_code`.
- error_codestringrequired
  Error code is a string that specifies this error type.
- messagestringrequired
  Human-readable error message.


curl -X GET 'https://api.example.com/v0/pipelines/{pipeline_name}/support_bundle?collect=<collect>&circuit_profile=<circuit_profile>&heap_profile=<heap_profile>&metrics=<metrics>&logs=<logs>&stats=<stats>&pipeline_config=<pipeline_config>&system_config=<system_config>&dataflow_graph=<dataflow_graph>' \
  -H 'Authorization: Bearer YOUR_TOKEN'


const response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/support_bundle?collect=<collect>&circuit_profile=<circuit_profile>&heap_profile=<heap_profile>&metrics=<metrics>&logs=<logs>&stats=<stats>&pipeline_config=<pipeline_config>&system_config=<system_config>&dataflow_graph=<dataflow_graph>', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = await response.json();
console.log(data);


interface ApiResponse {
  // shape your response here
}
 
const response: Response = await fetch('https://api.example.com/v0/pipelines/{pipeline_name}/support_bundle?collect=<collect>&circuit_profile=<circuit_profile>&heap_profile=<heap_profile>&metrics=<metrics>&logs=<logs>&stats=<stats>&pipeline_config=<pipeline_config>&system_config=<system_config>&dataflow_graph=<dataflow_graph>', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
 
const data = (await response.json()) as ApiResponse;
console.log(data);


import requests
 
url = "https://api.example.com/v0/pipelines/{pipeline_name}/support_bundle"
params = {
    "collect": "<collect>",
    "circuit_profile": "<circuit_profile>",
    "heap_profile": "<heap_profile>",
    "metrics": "<metrics>",
    "logs": "<logs>",
    "stats": "<stats>",
    "pipeline_config": "<pipeline_config>",
    "system_config": "<system_config>",
    "dataflow_graph": "<dataflow_graph>"
}
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
 
response = requests.request("get", url, params=params, headers=headers)
print(response.json())


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	req, err := http.NewRequest("GET", "https://api.example.com/v0/pipelines/{pipeline_name}/support_bundle?collect=<collect>&circuit_profile=<circuit_profile>&heap_profile=<heap_profile>&metrics=<metrics>&logs=<logs>&stats=<stats>&pipeline_config=<pipeline_config>&system_config=<system_config>&dataflow_graph=<dataflow_graph>", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, _ := io.ReadAll(resp.Body)
	fmt.Println(string(out))
}


"string"