Delete a Debug Session

Deletes a Debug Session

delete

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

The debug session was deleted successfully.

delete/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}
 

Stops an active Debug Session

Stops 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

Response

application/json

Debug Session Stop Response

object
post/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/stop
 
application/json

Mark Target Completed

DEPRECATED

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/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/targets/{targetId}/done
 
application/json

Gets data for a debug session (internal only)

Gets data for a debug session (internal only)

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

Response

application/json

Data response

object
get/control-planes/{controlPlaneId}/o11y/debug-sessions/data
 
application/json

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