List debug session traces

Returns a list of debug session traces using time range and selectors

get

Query Parameters

start_time_secsinteger(int64)

Unix epoch start time in seconds

end_time_secsinteger(int64)

Unix epoch start time in seconds

limitinteger

limit number of traces in a debug session

Default:500

fieldsstring

Comma-separated list of span attribute keys (e.g. span.http.response.status_code,span.http.request.method,span.url.full)

filter[node_id]array[string](uuid)unique-items

A list of data plane node IDs to filter traces. Usage filter[node_id]={node_id1}&filter[node_id]={node_id2}.

Example:39596fd9-0b88-4728-9957-9a2be978d8ef

filter[status_code_group]array[string]unique-items

A list of status code groups to filter traces. Usage filter[status_code_group]=4XX&filter[status_code_group]=5XX.

Allowed values:2XX3XX4XX5XX

Example:2XX

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

List of traces response

ListDebugSessionTracesResponse

tracesarray[object]
Show Child Parameters
get/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces
 
application/json

Get debug session trace

Returns a Trace in a debug session by ID

get

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

traceIdstringrequired

Unique identifier of the trace.

Example:0b419ff749c4dabf5f45b0cfee053bc1

Response

application/json

Trace response

Trace

resource_spansarray[object]
Show Child Parameters
get/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}
 
application/json

Get the captures for a trace

Returns the request/response body/headers for a trace ID as part of the session capture

get

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

traceIdstringrequired

Unique identifier of the trace.

Example:0b419ff749c4dabf5f45b0cfee053bc1

Response

application/json

The capture content for a trace ID

TraceCaptures

Represents the request/response captures associated with a trace

request_bodystring

The captured request body

request_headersobject

The captured request headers

response_bodystring

The captured response body

response_headersobject

The captured response headers

get/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/captures
 
application/json

Download traces and logs for a trace ID

Downloads traces and associated logs and payload for a specific trace ID in a debug session as a ZIP file.

The ZIP file contains separate JSON files:

  • trace.json: Complete trace data (same format as getTraceById)
  • logs.json: Associated logs array (same format as log search responses)
  • captures.json: Request/response captures (same format as getCapturesForTrace)

Files are only included based on the request parameters (include_logs, include_captures).

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

traceIdstringrequired

Unique identifier of the trace.

Example:0b419ff749c4dabf5f45b0cfee053bc1

Body

application/json

TraceDownloadRequest

Request payload for downloading traces and logs for a specific trace ID

include_logsbooleanrequired

Whether to include associated logs in the ZIP file

Default:true

log_filtersobject

Key-value pairs to filter logs based on specific attributes.

* Additional properties are NOT allowed.
Show Child Parameters
include_capturesbooleanrequired

Whether to include request/response captures in the ZIP file

Default:true

formatstring

The format for the downloaded data (currently only ZIP is supported)

Allowed values:zip

Default:zip

Response

application/zip

ZIP file containing separate JSON files for traces, logs, and captures for the specified trace ID

string

ZIP file containing separate JSON files (trace.json, logs.json, captures.json)

post/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/download

Body

{ "include_logs": true, "include_captures": true, "format": "zip", "log_filters": { "log_type": { "neq": "access" } } }
 
application/zip

Mark Target Completed (Internal)

Marks the target as completed in an active debug session

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

debugSessionIdstring(uuid)required

Debug Session identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

targetIdstring(uuid)required

Unique identifier of the data plane node.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

Debug Session Done Response

object
post/internal/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/targets/{targetId}/done
 
application/json