Get the captures for a trace
Returns the request/response body/headers for a trace ID as part of the session capture
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Debug Session identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Unique identifier of the trace.
Example:0b419ff749c4dabf5f45b0cfee053bc1
Response
application/json
Response
The capture content for a trace ID
TraceCaptures
Represents the request/response captures associated with a trace
The captured request body
The captured request headers
The captured response body
The captured response headers
Authentication
Path Parameters
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).
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Debug Session identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Unique identifier of the trace.
Example:0b419ff749c4dabf5f45b0cfee053bc1
Body
application/json
Body
TraceDownloadRequest
Request payload for downloading traces and logs for a specific trace ID
Whether to include associated logs in the ZIP file
Default:true
Key-value pairs to filter logs based on specific attributes.
Show Child Parameters
Whether to include request/response captures in the ZIP file
Default:true
The format for the downloaded data (currently only ZIP is supported)
Allowed values:zip
Default:zip
Response
application/zip
Response
ZIP file containing separate JSON files for traces, logs, and captures for the specified trace ID
ZIP file containing separate JSON files (trace.json, logs.json, captures.json)
Authentication
Path Parameters
Body
Mark Target Completed (Internal)
Marks the target as completed in an active debug session
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Debug Session identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Unique identifier of the data plane node.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
Debug Session Done Response
Authentication
Path Parameters
Session Logs
Debug Session Logs APIs
Search Logs
Search logs for a specific debug session in a control plane
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Debug Session identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
LogSearchRequest
Represents the request payload for searching logs in a debug session.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
A list of identifier of the span within a trace to filter logs.
A list of identifier of the trace to filter logs.
A list of severity levels to filter logs (e.g., ERROR, WARN).
A list of numeric severity levels to filter logs (e.g., 17 for ERROR, 15 for WARN).
Key-value pairs to filter logs based on specific attributes.
Show Child Parameters
Specifies the sorting order for the logs in the response.
Show Child Parameters
Response
application/json
Response
Matching OTel data plane logs
LogSearchResponse
Show Child Parameters
Represents a log entry based on the OpenTelemetry (OTel) data model.
Example:{"span_id":"090a0b0c0d0e0f00","trace_id":"ff0102030405060708090a0b0c0d0e0f","timestamp":"2025-04-22T14:12:00.123Z","observed_timestamp_ns":1749449968177456600,"severity_text":"ERROR","severity_number":17,"body":"Timeout from downstream service","attributes":{"user_id":"user-123","request_id":"abc-123","check_number":2344},"resource":{"attributes":{"service.name":"Kong","service.version":"1.2.3"}},"scope":{"attributes":{"log_body_decryption_error\"":"error decrypting log"}}}