| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| page[size] | integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items. |
| page[after] | string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter. |
{- "data": [
- {
- "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
- "max_samples": 10,
- "duration_secs": 300,
- "created_at": "2024-10-01T20:00:00.000Z",
- "updated_at": "2024-10-01T20:00:00.000Z"
}
], - "meta": {
- "page": {
- "size": 10,
- "next": null,
- "previous": null
}
}
}Create Debug Session
| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| name | string The optional session name. |
| max_samples | integer The maximum amount of samples to collect per data plane. |
| sampling_rule | string or null An expression used to filter the requests to sample. |
| duration_secs | integer The duration of the debug session in seconds. |
| capture_content | Array of strings Items Enum: "headers" "body" |
| targets | Array of strings <uuid> The data plane nodes to collect samples from. |
{- "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
- "max_samples": 10,
- "targets": [
- "ae853602-23c7-4218-9071-82fdef3a1efe"
]
}{- "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
- "max_samples": 10,
- "duration_secs": 300,
- "created_at": "2024-10-01T20:10:00.000Z",
- "updated_at": "2024-10-01T20:10:00.000Z"
}Returns a Debug Session
| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| debugSessionId required | string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Debug Session identifier |
{- "id": "e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee",
- "max_samples": 10,
- "duration_secs": 300,
- "created_at": "2024-10-01T20:10:00.000Z",
- "updated_at": "2024-10-01T20:10:00.000Z"
}Deletes a Debug Session
| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| debugSessionId required | string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Debug Session identifier |
{- "status": 401,
- "title": "Unauthorized",
- "instance": "kong:trace:8347343766220159418",
- "detail": "Unauthorized"
}Stops an active Debug Session
| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| debugSessionId required | string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Debug Session identifier |
{ }Marks the target as completed in an active debug session
| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
| debugSessionId required | string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Debug Session identifier |
| targetId required | string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a Unique identifier of the data plane node. |
{ }| controlPlaneId required | string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager. |
{ }