1.0.0OAS 3.0

Kong Debuggability APIs.

API Base URL
  • Server 1:https://us.api.konghq.com/v1

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v1

    Europe Production region

  • Server 3:https://au.api.konghq.com/v1

    Australia Production region

  • Server 4:https://me.api.konghq.com/v1

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v1

    India Production region

  • Server 6:https://sg.api.konghq.com/v1

    Singapore Production region

Security
personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

Additional Information
Contact Kong

Tracing Sessions

Tracing Session APIs

List all debug sessions for a control plane

List all debug sessions for a control plane

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter portals returned in the response.

Show Child Parameters
sortstring

The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).

Example:created_at desc

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

List of DebugSessions

ListDebugSessionsResponse

metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/control-planes/{controlPlaneId}/o11y/debug-sessions
 
application/json

Create Debug Session

Create 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

Body

application/json

DebugSession

namestring

The optional session name.

max_samplesinteger

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsinteger

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
targetsarray[string](uuid)

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters

Response

application/json

Debug Session Response

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The optional session name.

max_samplesintegerrequired

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsintegerrequired

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
started_atstring(date-time)read-only

An ISO-8601 timestamp representation of start date.

Example:2024-11-04T20:10:06.927Z

stopped_atstring(date-time)read-only

An ISO-8601 timestamp representation of stop date.

Example:2022-11-04T20:10:06.927Z

completed_atstring(date-time)read-only

An ISO-8601 timestamp representation of completion date.

Example:2022-11-04T20:10:06.927Z

timed_outbooleanread-only

Determines whether the target did not respond in time before the sampling time elapsed.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

targetsarray[string](uuid)required

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters
target_statusarray[object]

Represents the status of supported features for a node instance based on its version

Show Child Parameters
post/control-planes/{controlPlaneId}/o11y/debug-sessions

Body

{ "name": "Debug Session 1", "max_samples": 10, "sampling_rule": "http.path == \"/my-path\"", "duration_secs": 300, "capture_content": [ "headers", "body" ], "capture_log": [ "error", "access" ], "capture_traces": true, "capture_profile": { "cpu": { "mode": "time", "sampling_interval": 1000 } }, "targets": [ "ae853602-23c7-4218-9071-82fdef3a1efe" ], "payload_sanitization": { "user_defined_rules": { "headers": [ { "header_name": "auth-token", "scope": [ "request", "response" ], "action": "mask" } ], "body": [ { "strategy": { "json_path": "$.user.email" }, "scope": [ "response" ], "action": "mask" } ] } } }
 
application/json

Get a Debug Session

Returns a Debug Session

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

Response

application/json

Debug Session Response

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The optional session name.

max_samplesintegerrequired

The maximum amount of samples to collect per data plane.

Default:200

>= 1<= 200

Example:10

sampling_rulestring | null

An expression used to filter the requests to sample.

Example:http.path == "/my-path"

duration_secsintegerrequired

The duration of the debug session in seconds.

Default:300

>= 10<= 1800

Example:300

capture_contentarray[string]

Allowed values:headersbody

capture_logarray[string]

Allowed values:erroraccess

capture_tracesboolean

Determines if Traces should be captured for this session.

Default:true

Example:true

capture_profileobject

CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.

Show Child Parameters
started_atstring(date-time)read-only

An ISO-8601 timestamp representation of start date.

Example:2024-11-04T20:10:06.927Z

stopped_atstring(date-time)read-only

An ISO-8601 timestamp representation of stop date.

Example:2022-11-04T20:10:06.927Z

completed_atstring(date-time)read-only

An ISO-8601 timestamp representation of completion date.

Example:2022-11-04T20:10:06.927Z

timed_outbooleanread-only

Determines whether the target did not respond in time before the sampling time elapsed.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

targetsarray[string](uuid)required

Unique identifier of the data plane node.

>= 1 items

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

payload_sanitizationobject

Configuration for sanitizing sensitive data in captured payloads

Show Child Parameters
target_statusarray[object]

Represents the status of supported features for a node instance based on its version

Show Child Parameters
get/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}
 
application/json