Create Debug Session
Create Debug Session
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
DebugSession
The optional session name.
The maximum amount of samples to collect per data plane.
Default:200
>= 1<= 200
Example:10
An expression used to filter the requests to sample.
Example:http.path == "/my-path"
The duration of the debug session in seconds.
Default:300
>= 10<= 1800
Example:300
Allowed values:headersbody
Allowed values:erroraccess
Determines if Traces should be captured for this session.
Default:true
Example:true
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
Unique identifier of the data plane node.
>= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Configuration for sanitizing sensitive data in captured payloads
Show Child Parameters
Response
application/json
Response
Debug Session Response
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The optional session name.
The maximum amount of samples to collect per data plane.
Default:200
>= 1<= 200
Example:10
An expression used to filter the requests to sample.
Example:http.path == "/my-path"
The duration of the debug session in seconds.
Default:300
>= 10<= 1800
Example:300
Allowed values:headersbody
Allowed values:erroraccess
Determines if Traces should be captured for this session.
Default:true
Example:true
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
An ISO-8601 timestamp representation of start date.
Example:2024-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of stop date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of completion date.
Example:2022-11-04T20:10:06.927Z
Determines whether the target did not respond in time before the sampling time elapsed.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Unique identifier of the data plane node.
>= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Configuration for sanitizing sensitive data in captured payloads
Show Child Parameters
Represents the status of supported features for a node instance based on its version
Show Child Parameters
Authentication
Path Parameters
Body
Get a Debug Session
Returns a 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
Response
application/json
Response
Debug Session Response
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The optional session name.
The maximum amount of samples to collect per data plane.
Default:200
>= 1<= 200
Example:10
An expression used to filter the requests to sample.
Example:http.path == "/my-path"
The duration of the debug session in seconds.
Default:300
>= 10<= 1800
Example:300
Allowed values:headersbody
Allowed values:erroraccess
Determines if Traces should be captured for this session.
Default:true
Example:true
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
An ISO-8601 timestamp representation of start date.
Example:2024-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of stop date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of completion date.
Example:2022-11-04T20:10:06.927Z
Determines whether the target did not respond in time before the sampling time elapsed.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Unique identifier of the data plane node.
>= 1 items
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Configuration for sanitizing sensitive data in captured payloads
Show Child Parameters
Represents the status of supported features for a node instance based on its version
Show Child Parameters
Authentication
Path Parameters
Delete a Debug Session
Deletes a 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
Response
Response
The debug session was deleted successfully.
Authentication
Path Parameters
Stops an active Debug Session
Stops 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
Response
application/json
Response
Debug Session Stop Response
Authentication
Path Parameters
Mark Target Completed
DEPRECATEDMarks 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