---
title: "Konnect Dolly APIs"
url: "https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4"
---

# Konnect Dolly APIs

OpenAPI specification document.

```json
{"openapi":"3.0.3","info":{"title":"Konnect Dolly APIs","version":"1.0.0","description":"Kong Debuggability APIs.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/control-planes/{controlPlaneId}/o11y/debug-sessions":{"get":{"operationId":"dolly-list-debug-sessions","summary":"List all debug sessions for a control plane","description":"List all debug sessions for a control plane","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"},{"name":"filter","in":"query","description":"Filter portals returned in the response.","required":false,"schema":{"$ref":"#/components/schemas/DollyApiFilterParameters"},"style":"deepObject"},{"$ref":"#/components/parameters/DollyApiPublicationSort"}],"responses":{"200":{"$ref":"#/components/responses/ListDebugSessionsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Tracing Sessions"]},"post":{"operationId":"dolly-create-debug-session","summary":"Create Debug Session","description":"Create Debug Session","parameters":[{"$ref":"#/components/parameters/controlPlaneId"}],"requestBody":{"$ref":"#/components/requestBodies/CreateDebugSessionRequest"},"responses":{"201":{"$ref":"#/components/responses/DebugSessionResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"}],"get":{"operationId":"dolly-get-debug-session","summary":"Get a Debug Session","description":"Returns a Debug Session","responses":{"200":{"$ref":"#/components/responses/DebugSessionResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Tracing Sessions"]},"delete":{"operationId":"dolly-delete-debug-session","summary":"Delete a Debug Session","description":"Deletes a Debug Session","responses":{"204":{"description":"The debug session was deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/stop":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"}],"post":{"operationId":"dolly-stop-debug-session","summary":"Stops an active Debug Session","description":"Stops an active Debug Session","responses":{"200":{"$ref":"#/components/responses/DebugSessionStopResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/targets/{targetId}/done":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/targetId"}],"post":{"operationId":"dolly-done-debug-session-target","summary":"Mark Target Completed","description":"Marks the target as completed in an active debug session","responses":{"200":{"$ref":"#/components/responses/DebugSessionDoneResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"deprecated":true,"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/data":{"get":{"operationId":"dolly-get-debug-sessions-data","summary":"Gets data for a debug session (internal only)","description":"Gets data for a debug session (internal only)","parameters":[{"$ref":"#/components/parameters/controlPlaneId"}],"responses":{"200":{"description":"Data response","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/start_time_secs"},{"$ref":"#/components/parameters/end_time_secs"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/FilterByNodeIdShort"},{"$ref":"#/components/parameters/FilterByStatusCodeGroup"}],"get":{"operationId":"listDebugSessionTraces","summary":"List debug session traces","description":"Returns a list of debug session traces using time range and selectors","responses":{"200":{"description":"List of traces response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDebugSessionTracesResponse"},"examples":{"ListDebugSessionTracesExample":{"$ref":"#/components/examples/ListDebugSessionTracesExample"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/traceId"}],"get":{"operationId":"getDebugSessionTraceById","summary":"Get debug session trace","description":"Returns a Trace in a debug session by ID","responses":{"200":{"description":"Trace response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trace"},"examples":{"DebugSessionTraceByIDExample":{"$ref":"#/components/examples/DebugSessionTraceByIDExample"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/captures":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/traceId"}],"get":{"operationId":"getCapturesForTrace","summary":"Get the captures for a trace","description":"Returns the request/response body/headers for a trace ID as part of the session capture","responses":{"200":{"description":"The capture content for a trace ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceCaptures"},"examples":{"TraceCapturesExample":{"$ref":"#/components/examples/TraceCapturesExample"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/download":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/traceId"}],"post":{"operationId":"downloadTraceAndLogs","summary":"Download traces and logs for a trace ID","description":"Downloads traces and associated logs and payload for a specific trace ID in a debug session as a ZIP file.\n\nThe ZIP file contains separate JSON files:\n- `trace.json`: Complete trace data (same format as getTraceById)\n- `logs.json`: Associated logs array (same format as log search responses)\n- `captures.json`: Request/response captures (same format as getCapturesForTrace)\n\nFiles are only included based on the request parameters (include_logs, include_captures).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceDownloadRequest"},"examples":{"TraceDownloadRequestExample":{"$ref":"#/components/examples/TraceDownloadRequestExample"}}}}},"responses":{"200":{"description":"ZIP file containing separate JSON files for traces, logs, and captures for the specified trace ID","headers":{"Content-Disposition":{"description":"Indicates the content should be downloaded as a file","schema":{"type":"string","example":"attachment; filename=\"trace-{traceId}-data.zip\""}},"Content-Type":{"description":"MIME type of the response","schema":{"type":"string","example":"application/zip"}}},"content":{"application/zip":{"schema":{"description":"ZIP file containing separate JSON files (trace.json, logs.json, captures.json)","type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Tracing Sessions"]}},"/internal/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/targets/{targetId}/done":{"parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/targetId"}],"post":{"operationId":"dolly-internal-done-debug-session-target","summary":"Mark Target Completed (Internal)","description":"Marks the target as completed in an active debug session","responses":{"200":{"$ref":"#/components/responses/DebugSessionDoneResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Tracing Sessions"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/logs/search":{"post":{"operationId":"searchDebugSessionLogs","summary":"Search Logs","description":"Search logs for a specific debug session in a control plane","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSearchRequest"},"examples":{"LogSearchRequestExample":{"$ref":"#/components/examples/LogSearchRequestExample"}}}}},"responses":{"200":{"description":"Matching OTel data plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSearchResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Session Logs"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/logs/distinct-values/{logFieldFilter}":{"post":{"operationId":"searchDebugSessionLogsDistinctValues","summary":"Search Distinct Values in Logs","description":"Search distinct values in specified logs attributes for a specific debug session in a control plane","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/logFieldFilter"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSearchRequest"},"examples":{"LogSearchRequestExample":{"$ref":"#/components/examples/LogSearchRequestExample"}}}}},"responses":{"200":{"description":"Distinct values for the specified attributes in the logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsDistinctValuesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Session Logs"]}},"/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/profiles/cpu":{"get":{"operationId":"getDebugSessionCPUProfile","summary":"Get CPU profile for a debug session","description":"Get CPU profile for a debug session with support for multiple formats (otel/flamegraph/frames)","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/debugSessionId"},{"$ref":"#/components/parameters/cpuProfileFormat"}],"responses":{"200":{"$ref":"#/components/responses/CPUProfileResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Session Profiles"]}},"/control-planes/{controlPlaneId}/o11y/logs/search":{"post":{"operationId":"ollySearchControlPlaneLogs","summary":"Search Control Plane Logs","description":"Search logs for a specific control plane with filtering capabilities","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"}],"requestBody":{"$ref":"#/components/requestBodies/ControlPlaneLogSearchRequest"},"responses":{"200":{"$ref":"#/components/responses/ControlPlaneLogSearchResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Control Plane Logs"]}},"/control-planes/{controlPlaneId}/o11y/logs/distinct-values/{logFieldFilter}":{"post":{"operationId":"ollyControlPlaneLogsDistinctValues","summary":"Search Distinct Values in Control Plane Logs","description":"Retrieve distinct values for a specified field in control plane logs with optional filtering","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/controlPlaneLogFieldFilter"}],"requestBody":{"$ref":"#/components/requestBodies/ControlPlaneLogSearchRequest"},"responses":{"200":{"$ref":"#/components/responses/ControlPlaneLogDistinctValuesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Control Plane Logs"]}},"/control-planes/{controlPlaneId}/o11y/cgw-logs/search":{"post":{"operationId":"ollySearchCGWLogs","summary":"Search cloud gateway logs","description":"Search logs for a cloud gateway with filtering capabilities","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"}],"requestBody":{"$ref":"#/components/requestBodies/CGWLogSearchRequest"},"responses":{"200":{"description":"Matching OTel CGW data plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSearchResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/control-planes/{controlPlaneId}/o11y/cgw-logs/count":{"post":{"operationId":"ollyCountCGWLogs","summary":"Count cloud gateway logs","description":"Count logs for a cloud gateway with filtering capabilities","parameters":[{"$ref":"#/components/parameters/controlPlaneId"}],"requestBody":{"$ref":"#/components/requestBodies/CGWLogSearchRequest"},"responses":{"200":{"description":"Count of matching OTel CGW data plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogCountResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/control-planes/{controlPlaneId}/o11y/cgw-logs/download":{"post":{"operationId":"ollyDownloadCGWLogsCSV","summary":"Download cloud gateway logs as CSV","description":"Download logs for a cloud gateway with filtering capabilities in CSV format","parameters":[{"$ref":"#/components/parameters/controlPlaneId"}],"requestBody":{"$ref":"#/components/requestBodies/CGWLogSearchRequest"},"responses":{"200":{"description":"CSV file containing matching OTel CGW data plane logs","headers":{"Content-Disposition":{"description":"Indicates the content should be downloaded as a file","schema":{"type":"string","example":"attachment; filename=\"cgw-logs.csv\""}},"Content-Type":{"description":"MIME type of the response","schema":{"type":"string","example":"text/csv"}}},"content":{"text/csv":{"schema":{"description":"CSV formatted log data","type":"string"},"example":"timestamp,body,organisation_id,controlplane_id,node_id\n2025-04-22T14:12:00.123Z,\"Timeout from downstream service\",org-123e4567-e89b-12d3-a456-426614174001,cp-456e7890-e89b-12d3-a456-426614174002,d32d905a-ed33-46a3-a093-d8f536af9a8a\n2025-04-22T14:13:15.456Z,\"Request processed successfully\",org-123e4567-e89b-12d3-a456-426614174001,cp-456e7890-e89b-12d3-a456-426614174002,d32d905a-ed33-46a3-a093-d8f536af9a8a\n"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/control-planes/{controlPlaneId}/o11y/cgw-logs/distinct-values/{logFieldFilter}":{"post":{"operationId":"ollySearchCGWLogsDistinctValues","summary":"Search Distinct Values in Cloud Gateway Logs","description":"Search distinct values in specified logs attributes for cloud gateway logs in a control plane","parameters":[{"$ref":"#/components/parameters/controlPlaneId"},{"$ref":"#/components/parameters/cgwLogFieldFilter"}],"requestBody":{"$ref":"#/components/requestBodies/CGWLogSearchRequest"},"responses":{"200":{"description":"Distinct values for the specified attributes in the cloud gateway logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogsDistinctValuesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/o11y/cgw-logs/search":{"post":{"operationId":"ollyOrgScopedSearchCGWLogs","summary":"Search cloud gateway logs for an organization","description":"Search logs for all cloud gateways in the organization with filtering capabilities","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"$ref":"#/components/parameters/PageBefore"}],"requestBody":{"$ref":"#/components/requestBodies/OrgScopedCGWLogSearchRequest"},"responses":{"200":{"description":"Matching OTel CGW data plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogSearchResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/o11y/cgw-logs/count":{"post":{"operationId":"ollyOrgScopedCountCGWLogs","summary":"Count cloud gateway logs for an organization","description":"Count logs for all cloud gateways in the organization with filtering capabilities","requestBody":{"$ref":"#/components/requestBodies/OrgScopedCGWLogSearchRequest"},"responses":{"200":{"description":"Count of matching OTel CGW data plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogCountResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/o11y/cgw-logs/download":{"post":{"operationId":"ollyOrgScopedDownloadCGWLogsCSV","summary":"Download cloud gateway logs","description":"Download logs for all cloud gateways in the organization with filtering capabilities","requestBody":{"$ref":"#/components/requestBodies/OrgScopedCGWLogSearchRequest"},"responses":{"200":{"description":"CSV file containing matching OTel CGW data plane logs","headers":{"Content-Disposition":{"description":"Indicates the content should be downloaded as a file","schema":{"type":"string","example":"attachment; filename=\"cgw-logs.csv\""}},"Content-Type":{"description":"MIME type of the response","schema":{"type":"string","example":"text/csv"}}},"content":{"text/csv":{"schema":{"description":"CSV formatted log data","type":"string"},"example":"timestamp,body,organisation_id,controlplane_id,node_id\n2025-04-22T14:12:00.123Z,\"Timeout from downstream service\",org-123e4567-e89b-12d3-a456-426614174001,cp-456e7890-e89b-12d3-a456-426614174002,d32d905a-ed33-46a3-a093-d8f536af9a8a\n2025-04-22T14:13:15.456Z,\"Request processed successfully\",org-123e4567-e89b-12d3-a456-426614174001,cp-456e7890-e89b-12d3-a456-426614174002,d32d905a-ed33-46a3-a093-d8f536af9a8a\n"}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}},"tags":["Cloud Gateway Logs"]}},"/o11y/org-settings/dpa":{"put":{"operationId":"update-dpa-settings","summary":"Update DPA settings for an organization","description":"Update Data Protection Addendum (DPA) settings for an organization","requestBody":{"$ref":"#/components/requestBodies/UpdateDPASettingsRequest"},"responses":{"200":{"$ref":"#/components/responses/DPASettingsResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"415":{"$ref":"#/components/responses/UnsupportedMediaType"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Organization Settings"]},"get":{"operationId":"get-latest-dpa-settings","summary":"Get latest DPA settings for organization","description":"Fetch latest DPA settings for organization","responses":{"200":{"$ref":"#/components/responses/DPASettingsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Internal"}},"tags":["Organization Settings"]}}},"components":{"parameters":{"cgwLogFieldFilter":{"schema":{"type":"string","example":"node_id","enum":["node_id"]},"name":"logFieldFilter","in":"path","required":true,"description":"Field to filter cloud gateway logs by distinct values. Currently, only \"node_id\" is supported."},"controlPlaneId":{"name":"controlPlaneId","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"9524ec7d-36d9-465d-a8c5-83a3c9390458"},"description":"The UUID of your control plane. This variable is available in the Konnect manager."},"controlPlaneLogFieldFilter":{"schema":{"type":"string","example":"log_level","enum":["log_level","node_id","node_version"]},"name":"logFieldFilter","in":"path","required":true,"description":"Field to filter logs by distinct values."},"cpuProfileFormat":{"schema":{"type":"string","default":"frames","enum":["frames","flamegraph","otel"]},"name":"format","in":"query","required":false,"description":"The format in which cpu profile should be returned"},"debugSessionId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"debugSessionId","in":"path","required":true,"description":"Debug Session identifier"},"DollyApiPublicationSort":{"name":"sort","description":"Sorts a collection of API publications. Supported sort attributes are:\n  - name\n  - created_at\n  - updated_at\n","required":false,"in":"query","schema":{"$ref":"#/components/schemas/SortQuery"}},"end_time_secs":{"schema":{"description":"Unix epoch start time in seconds","type":"integer","format":"int64"},"name":"end_time_secs","in":"query","required":false,"description":"end time in unix seconds"},"fields":{"schema":{"type":"string"},"name":"fields","in":"query","required":false,"description":"Comma-separated list of span attribute keys (e.g. `span.http.response.status_code,span.http.request.method,span.url.full`)"},"FilterByNodeIdShort":{"name":"filter[node_id]","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","uniqueItems":true,"format":"uuid","example":"39596fd9-0b88-4728-9957-9a2be978d8ef"}},"description":"A list of data plane node IDs to filter traces. Usage filter[node_id]={node_id1}&filter[node_id]={node_id2}."},"FilterByStatusCodeGroup":{"name":"filter[status_code_group]","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string","uniqueItems":true,"enum":["2XX","3XX","4XX","5XX"],"example":"2XX"}},"description":"A list of status code groups to filter traces. Usage filter[status_code_group]=4XX&filter[status_code_group]=5XX."},"limit":{"schema":{"type":"integer","default":500},"name":"limit","in":"query","required":false,"description":"limit number of traces in a debug session"},"logFieldFilter":{"schema":{"type":"string","example":"severity_text","enum":["severity_text"]},"name":"logFieldFilter","in":"path","required":true,"description":"Field to filter logs by distinct values. Currently, only \"severity_text\" is supported."},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageBefore":{"name":"page[before]","description":"Request the next page of data, starting with the item before this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}},"start_time_secs":{"schema":{"description":"Unix epoch start time in seconds","type":"integer","format":"int64"},"name":"start_time_secs","in":"query","required":false,"description":"start time in unix seconds"},"targetId":{"schema":{"type":"string","format":"uuid","example":"d32d905a-ed33-46a3-a093-d8f536af9a8a"},"name":"targetId","in":"path","required":true,"description":"Unique identifier of the data plane node."},"traceId":{"schema":{"type":"string","example":"0b419ff749c4dabf5f45b0cfee053bc1"},"name":"traceId","in":"path","required":true,"description":"Unique identifier of the trace."}},"schemas":{"DebugSession":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The optional session name.","type":"string"},"max_samples":{"description":"The maximum amount of samples to collect per data plane.","type":"integer","example":10,"default":200,"maximum":200,"minimum":1},"sampling_rule":{"description":"An expression used to filter the requests to sample.","type":"string","example":"http.path == \"/my-path\"","nullable":true},"duration_secs":{"description":"The duration of the debug session in seconds.","type":"integer","example":300,"default":300,"maximum":1800,"minimum":10},"capture_content":{"type":"array","items":{"$ref":"#/components/schemas/CaptureContentType"}},"capture_log":{"type":"array","items":{"$ref":"#/components/schemas/CaptureLogType"}},"capture_traces":{"description":"Determines if Traces should be captured for this session.","type":"boolean","example":true,"default":true},"capture_profile":{"$ref":"#/components/schemas/CaptureProfileInfo"},"started_at":{"description":"An ISO-8601 timestamp representation of start date.","type":"string","format":"date-time","example":"2024-11-04T20:10:06.927Z","readOnly":true},"stopped_at":{"description":"An ISO-8601 timestamp representation of stop date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"completed_at":{"description":"An ISO-8601 timestamp representation of completion date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"timed_out":{"description":"Determines whether the target did not respond in time before the sampling time elapsed.","type":"boolean","readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"targets":{"description":"The data plane nodes to collect samples from.","type":"array","items":{"type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","description":"Unique identifier of the data plane node."},"minItems":1},"payload_sanitization":{"$ref":"#/components/schemas/PayloadSanitizationConfig"}}},"TargetStatus":{"description":"Represents the status of supported features for a node instance based on its version","type":"object","properties":{"target_id":{"description":"Unique identifier of the data plane node.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"},"version":{"description":"Version of the node instance","type":"string","example":"3.11"},"compatible_features":{"description":"List of debugger features that are compatible","type":"array","items":{"$ref":"#/components/schemas/DebuggerFeatures"},"example":["logs","traces"],"uniqueItems":true},"incompatible_features":{"description":"List of debugger features that are incompatible","type":"array","items":{"$ref":"#/components/schemas/DebuggerFeatures"},"example":["logs"],"uniqueItems":true}},"required":["target_id","version","compatible_features","incompatible_features"]},"DebuggerFeatures":{"type":"string","enum":["logs","traces","payload_sanitization"]},"CaptureContentType":{"type":"string","enum":["headers","body"]},"CaptureLogType":{"type":"string","enum":["error","access"]},"CaptureProfileInfo":{"description":"CaptureProfile contains the information around the profile that needs to be captured. Currently supports CPU profiling, with potential for memory profiling in the future.","type":"object","properties":{"cpu":{"$ref":"#/components/schemas/CPUProfile"}}},"CPUProfile":{"description":"CPUProfile contains parameters for cpu profile collection","type":"object","properties":{"mode":{"description":"The mode of cpu profile","type":"string","example":"time","enum":["time","instruction"]},"sampling_interval":{"description":"The interval for sampling. If the mode is 'time', this value is in microseconds. If the mode is 'instruction', this value is the step count.","type":"integer","format":"int64","example":1000}},"required":["mode"]},"PayloadSanitizationConfig":{"description":"Configuration for sanitizing sensitive data in captured payloads","type":"object","properties":{"user_defined_rules":{"$ref":"#/components/schemas/UserDefinedRules"}}},"UserDefinedRules":{"description":"User-defined payload sanitization rules","type":"object","properties":{"headers":{"description":"Rules for sanitizing HTTP headers","type":"array","items":{"$ref":"#/components/schemas/HeaderSanitizationRule"}},"body":{"description":"Rules for sanitizing request/response body content","type":"array","items":{"$ref":"#/components/schemas/BodySanitizationRule"}}}},"HeaderSanitizationRule":{"type":"object","properties":{"name":{"description":"Optional identifier for this rule","type":"string","example":"api-key"},"header_name":{"description":"HTTP header name to sanitize (case-insensitive)","type":"string","example":"auth-token"},"scope":{"$ref":"#/components/schemas/SanitizationScope"},"action":{"$ref":"#/components/schemas/SanitizationAction"}},"required":["header_name","scope","action"]},"BodySanitizationRule":{"type":"object","properties":{"name":{"description":"Optional identifier for this rule","type":"string","example":"user-id"},"strategy":{"$ref":"#/components/schemas/BodySanitizationStrategy"},"scope":{"$ref":"#/components/schemas/SanitizationScope"},"action":{"$ref":"#/components/schemas/SanitizationAction"}},"required":["strategy","scope","action"]},"SanitizationScope":{"description":"Where the rule applies","type":"array","items":{"type":"string","enum":["request","response"]},"default":["request","response"]},"SanitizationAction":{"description":"- mask: Replace with \"******\"\n","type":"string","default":"mask","enum":["mask"]},"BodySanitizationStrategy":{"description":"Strategy for body content sanitization.","oneOf":[{"$ref":"#/components/schemas/JsonPathStrategy"},{"$ref":"#/components/schemas/RegexStrategy"}]},"JsonPathStrategy":{"description":"Strategy using JSONPath expression to locate content for sanitization.","type":"object","properties":{"json_path":{"$ref":"#/components/schemas/JsonPathExpression"}},"additionalProperties":false,"required":["json_path"]},"RegexStrategy":{"description":"Strategy using regex pattern to locate content for sanitization.","type":"object","properties":{"regex":{"$ref":"#/components/schemas/RegexPattern"}},"additionalProperties":false,"required":["regex"]},"JsonPathExpression":{"description":"JSONPath expression to locate the value.","type":"string","example":"$.user.email"},"RegexPattern":{"description":"Regex to match to locate the value.","type":"string","format":"regex","example":"\\d{4}-\\d{4}-\\d{4}-\\d{4}"},"DollyApiFilterParameters":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/StringFieldFilter"},"created_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"},"updated_at":{"$ref":"#/components/schemas/DateTimeFieldFilter"}},"title":"API Filter Parameters"},"Attributes":{"type":"object"},"Resource":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Attributes"}}},"AttributesFilter":{"description":"Key-value pairs to filter logs based on specific attributes.","type":"object","properties":{"log_type":{"$ref":"#/components/schemas/KeyValueFilter"},"introspection_name":{"$ref":"#/components/schemas/KeyValueFilter"},"introspection_namewhat":{"$ref":"#/components/schemas/KeyValueFilter"},"introspection_source":{"$ref":"#/components/schemas/KeyValueFilter"},"plugin_name":{"$ref":"#/components/schemas/KeyValueFilter"},"plugin_id":{"$ref":"#/components/schemas/KeyValueFilter"},"request_id":{"$ref":"#/components/schemas/KeyValueFilter"}},"additionalProperties":false},"ControlPlaneLogsAttributesFilter":{"description":"Key-value pairs to filter logs based on specific attributes.","type":"object","properties":{"node_version":{"$ref":"#/components/schemas/KeyValueFilter"},"node_hostname":{"$ref":"#/components/schemas/KeyValueFilter"}},"additionalProperties":false},"SpanLink":{"type":"object","properties":{"trace_id":{"type":"string"},"span_id":{"type":"string"},"trace_state":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}}},"ScopeItem":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"required":["name","version"]},"Span":{"type":"object","properties":{"trace_id":{"type":"string"},"span_id":{"type":"string"},"parent_span_id":{"type":"string","nullable":true},"name":{"type":"string"},"kind":{"type":"string"},"start_time_unix_nano":{"type":"string"},"end_time_unix_nano":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"},"events":{"type":"array","items":{"type":"object","properties":{"timeUnixNano":{"type":"string"},"name":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"required":["timeUnixNano","name"]}},"links":{"type":"array","items":{"$ref":"#/components/schemas/SpanLink"}},"status":{"type":"object","additionalProperties":true}},"required":["trace_id","span_id","start_time_unix_nano","end_time_unix_nano"]},"ScopeSpans":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/ScopeItem"},"spans":{"type":"array","items":{"$ref":"#/components/schemas/Span"}}}},"ResourceSpan":{"type":"object","properties":{"resource":{"$ref":"#/components/schemas/Resource"},"scope_spans":{"type":"array","items":{"$ref":"#/components/schemas/ScopeSpans"}}}},"Trace":{"type":"object","properties":{"resource_spans":{"type":"array","items":{"$ref":"#/components/schemas/ResourceSpan"}}}},"ListDebugSessionTracesResponse":{"type":"object","properties":{"traces":{"type":"array","items":{"$ref":"#/components/schemas/TraceItem"}}}},"TraceItem":{"type":"object","properties":{"trace_id":{"type":"string"},"root_service_name":{"type":"string"},"root_trace_name":{"type":"string"},"start_time_unix_nano":{"type":"string"},"duration_ms":{"type":"integer"},"span_sets":{"type":"array","items":{"$ref":"#/components/schemas/SpanSet"}}},"required":["trace_id","start_time_unix_nano","duration_ms"]},"SpanSet":{"type":"object","properties":{"matched":{"type":"integer"},"spans":{"type":"array","items":{"$ref":"#/components/schemas/SpanItem"}}},"required":["spans"]},"SpanItem":{"type":"object","properties":{"span_id":{"type":"string"},"start_time_unix_nano":{"type":"string"},"duration_nanos":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"required":["span_id","start_time_unix_nano","duration_nanos"]},"LogsOrderBy":{"description":"Specifies the sorting order for the logs in the response.","type":"object","properties":{"field":{"description":"The field to sort by. Can be either `timestamp` or `severity_number`.","type":"string","enum":["timestamp","severity_number"]},"direction":{"description":"The sorting direction. Can be `asc` for ascending or `desc` for descending order.","type":"string","enum":["asc","desc"]}}},"ControlPlaneLogsOrderBy":{"description":"Specifies the sorting order for the logs in the response.","type":"object","properties":{"field":{"description":"The field to sort by. Can be either `timestamp`.","type":"string","enum":["timestamp"]},"direction":{"description":"The sorting direction. Can be `asc` for ascending or `desc` for descending order.","type":"string","enum":["asc","desc"]}}},"LogsDistinctValuesResponse":{"description":"Represents the distinct values for a specific attribute in the logs.","type":"object","properties":{"data":{"description":"A list of distinct values for the specified attribute in the logs.","type":"array","items":{"type":"string","uniqueItems":true}}},"example":{"data":["DEBUG","INFO","ERR"]},"required":["data"]},"LogSearchRequest":{"description":"Represents the request payload for searching logs in a debug session.","type":"object","properties":{"start":{"description":"The start time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"end":{"description":"The end time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"node_id":{"description":"A list of data plane node IDs to filter logs.","type":"array","items":{"type":"string","uniqueItems":true,"format":"uuid"}},"span_id":{"description":"A list of identifier of the span within a trace to filter logs.","type":"array","items":{"type":"string","uniqueItems":true}},"trace_id":{"description":"A list of identifier of the trace to filter logs.","type":"array","items":{"type":"string","uniqueItems":true}},"severity_text":{"description":"A list of severity levels to filter logs (e.g., ERROR, WARN).","type":"array","items":{"type":"string","uniqueItems":true}},"severity_number":{"description":"A list of numeric severity levels to filter logs (e.g., 17 for ERROR, 15 for WARN).","type":"array","items":{"type":"integer","uniqueItems":true}},"attributes":{"$ref":"#/components/schemas/AttributesFilter"},"order_by":{"$ref":"#/components/schemas/LogsOrderBy"}}},"KeyValueFilter":{"description":"Represents a filter for key-value pairs, allowing equality, inequality, inclusion, or exclusion conditions.","type":"object","properties":{"eq":{"description":"Specifies a value that the key must be equal to."},"neq":{"description":"Specifies a value that the key must not be equal to."},"in":{"description":"Specifies a list of values that the key must be included in.","type":"array","items":{}},"nin":{"description":"Specifies a list of values that the key must not be included in.","type":"array","items":{}}},"example":{"in":["prod",123,true]},"additionalProperties":false},"LogSearchResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMetaPage"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/OTelLog"}}},"example":{"logs":[{"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"},"resource":{"attributes":{"service.name":"Kong","service.version":"1.2.3"}}}],"meta":{"next":"ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ","previous":null,"size":2}},"required":["logs"]},"OTelLog":{"description":"Represents a log entry based on the OpenTelemetry (OTel) data model.","type":"object","properties":{"span_id":{"description":"Identifier of the span within a trace. Refers to the OTel `SpanId` field.","type":"string"},"trace_id":{"description":"Identifier of the trace. Refers to the OTel `TraceId` field.","type":"string"},"timestamp":{"description":"The time at which the event occurred. Refers to the OTel `Timestamp` field.","type":"string","format":"date-time"},"observed_timestamp_ns":{"description":"Unix epoch time when the event was observed by the collection system in nanoseconds","type":"integer","format":"int64"},"severity_text":{"description":"Human-readable severity level of the log (e.g., ERROR, WARN). Refers to the OTel `SeverityText` field.","type":"string"},"severity_number":{"description":"Numeric representation of the severity level. Refers to the OTel `SeverityNumber` field.","type":"integer"},"body":{"description":"The main content of the log entry. Refers to the OTel `Body` field.","type":"string"},"attributes":{"description":"Key-value pairs providing additional context for the log. Refers to the OTel `Attributes` field.","type":"object"},"resource":{"description":"Resource information associated with the log, such as service name or version. Refers to the OTel `Resource` field.","type":"object","additionalProperties":{},"properties":{"attributes":{"$ref":"#/components/schemas/Attributes"}}},"scope":{"description":"Scope information associated with the log. Refers to the OTel `Scope` field.","type":"object","properties":{"attributes":{"$ref":"#/components/schemas/Attributes"}}}},"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"}}},"required":["timestamp","body","attributes","resource","observed_timestamp_ns"]},"TraceCaptures":{"description":"Represents the request/response captures associated with a trace","type":"object","properties":{"request_body":{"description":"The captured request body","type":"string"},"request_headers":{"description":"The captured request headers","type":"object"},"response_body":{"description":"The captured response body","type":"string"},"response_headers":{"description":"The captured response headers","type":"object"}}},"CPUProfileMetadata":{"description":"Represents the metadata for the cpu profile","type":"object","properties":{"resource":{"$ref":"#/components/schemas/Resource"},"profile":{"$ref":"#/components/schemas/ProfileMetadata"}},"required":["profile"]},"CPUProfileFrame":{"description":"Represents a frame in a cpu profile","type":"object","properties":{"stacktrace":{"description":"The stacktrace for the frame","type":"string"},"value":{"description":"The number of times the stacktrace was sampled in the profile","type":"integer","format":"uint64"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/CPUProfileFrameLocation"}},"attributes":{"$ref":"#/components/schemas/Attributes"}},"required":["stacktrace","value","locations"]},"CPUProfileFrameLocation":{"description":"The location in the cpu profiling frame (contains function, line, file metadata)","type":"object","properties":{"function":{"$ref":"#/components/schemas/CPUProfileFunction"},"line":{"description":"The line number for the function call","type":"integer"}}},"CPUProfileFunction":{"description":"Represents a function in the cpu profile (contains the name of the function and the file where it's defined)","type":"object","properties":{"name":{"description":"The name of the function","type":"string"},"file":{"description":"The file where the function is defined","type":"string"}}},"CPUProfileFlamegraph":{"description":"Represents the flamegraph representation of a cpu profile","type":"object","properties":{"root":{"$ref":"#/components/schemas/CPUProfileFlamegraphNode"}},"required":["root"]},"CPUProfileFlamegraphNode":{"description":"Represents a node in the flamegraph tree","type":"object","properties":{"location":{"$ref":"#/components/schemas/CPUProfileFrameLocation"},"value":{"description":"The value associated with this node in the flamegraph tree","type":"integer","format":"uint64"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CPUProfileFlamegraphNode"}}},"required":["children","value"]},"ProfileMetadata":{"description":"Contains the metadata for the profile","type":"object","properties":{"type":{"description":"Represents the type of profile","type":"string"},"mode":{"description":"Represents the mode for the profile","type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"required":["type","mode"]},"TraceDownloadRequest":{"description":"Request payload for downloading traces and logs for a specific trace ID","type":"object","properties":{"include_logs":{"description":"Whether to include associated logs in the ZIP file","type":"boolean","default":true},"log_filters":{"$ref":"#/components/schemas/AttributesFilter"},"include_captures":{"description":"Whether to include request/response captures in the ZIP file","type":"boolean","default":true},"format":{"description":"The format for the downloaded data (currently only ZIP is supported)","type":"string","default":"zip","enum":["zip"]}},"required":["include_logs","include_captures"]},"ConsentStatus":{"description":"The consent status for DPA.","type":"string","enum":["APPROVED","REVOKED"]},"ControlPlaneLogLevel":{"description":"The log level for control plane logs.","type":"string","enum":["DEBUG","INFO","WARN","ERROR"]},"DPASettings":{"description":"Represents the settings for Data Protection Addendum (DPA) for an organization.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"name":{"description":"The optional settings name.","type":"string"},"consent_by":{"description":"The optional settings consent by.","type":"string"},"consent_status":{"$ref":"#/components/schemas/ConsentStatus"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"required":["id","consent_status","created_at"]},"DistinctValuesResponse":{"description":"Represents distinct values for a specific attribute","type":"object","properties":{"data":{"description":"A list of distinct values for the specified attribute","type":"array","items":{"type":"string","uniqueItems":true}}},"required":["data"]},"ControlPlaneLogSearchResponseSchema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMetaPage"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/ControlPlaneLogMessage"}}},"required":["logs"]},"ControlPlaneLogMessage":{"description":"Represents a control plane log message","type":"object","properties":{"id":{"type":"string"},"source":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"log_level":{"type":"string"},"message":{"type":"string"},"node_id":{"type":"string","format":"uuid"},"node_hostname":{"type":"string"},"node_version":{"type":"string"},"config_version":{"type":"string"},"subject":{"type":"string"},"context":{"type":"object","additionalProperties":true}},"required":["id","timestamp"]},"CGWLogSearchRequestSchema":{"description":"Base schema for searching cloud gateway logs.","type":"object","properties":{"start":{"description":"The start time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"end":{"description":"The end time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"node_id":{"description":"A list of data plane node IDs to filter logs.","type":"array","items":{"type":"string","uniqueItems":true,"format":"uuid"}},"order_by":{"$ref":"#/components/schemas/ControlPlaneLogsOrderBy"}},"required":["start","end"]},"OrgScopedCGWLogSearchRequestSchema":{"description":"Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.","allOf":[{"$ref":"#/components/schemas/CGWLogSearchRequestSchema"},{"type":"object","properties":{"control_plane_id":{"description":"A list of control plane IDs to filter logs.","type":"array","items":{"type":"string","uniqueItems":true,"format":"uuid"}}}}]},"LogCountResponse":{"description":"Represents the count response for log search queries.","type":"object","properties":{"count":{"description":"The total number of logs matching the search criteria.","type":"integer","format":"int64"}},"example":{"count":1523},"required":["count"]},"StringFieldFilter":{"oneOf":[{"title":"Filter by operator","description":"Filter using **one** of the following operators: `eq`, `oeq`, `neq`, `contains`, `ocontains`","x-examples":{"example-1":{"contains":"some-value","ocontains":"this-value,or-that-value","oeq":"some-value,some-other-value","neq":"not-this-value"},"example-2":{"eq":"some-value"}},"properties":{"eq":{"description":"The field exactly matches the provided value.","type":"string","example":"?filter[field_name_here][eq]=foo"},"contains":{"description":"The field contains the provided value.","type":"string","example":"?filter[field_name_here][contains]=foo"},"ocontains":{"description":"The field contains any of the provided values.","type":"string","example":"?filter[field_name_here][ocontains]=foo,bar"},"oeq":{"description":"The field matches any of the provided values.","type":"string","example":"?filter[field_name_here][oeq]=foo,bar"},"neq":{"description":"The field does not match the provided value.","type":"string","example":"?filter[field_name_here][neq]=bar"}},"type":"object","additionalProperties":false},{"title":"Filter by exact string match","type":"string","description":"The field exactly matches the provided value.","example":"?filter[title]=foo"}]},"DateTimeFieldFilter":{"description":"Filters on the given datetime (RFC-3339) field value.","oneOf":[{"type":"string","title":"DateTimeFieldImplicitEqualsFilter","format":"date-time","description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","example":"2022-03-30T07:20:50Z"},{"type":"object","title":"DateTimeFieldEqualsFilter","additionalProperties":false,"properties":{"eq":{"description":"Value strictly equals given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["eq"]},{"type":"object","title":"DateTimeFieldLTFilter","additionalProperties":false,"properties":{"lt":{"description":"Value is less than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lt"]},{"type":"object","title":"DateTimeFieldLTEFilter","additionalProperties":false,"properties":{"lte":{"description":"Value is less than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["lte"]},{"type":"object","title":"DateTimeFieldGTFilter","additionalProperties":false,"properties":{"gt":{"description":"Value is greater than the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gt"]},{"type":"object","title":"DateTimeFieldGTEFilter","additionalProperties":false,"properties":{"gte":{"description":"Value is greater than or equal to the given RFC-3339 formatted timestamp in UTC","type":"string","format":"date-time","example":"2022-03-30T07:20:50Z"}},"required":["gte"]}],"title":"DateTimeFieldFilter","x-examples":{"datetime_field_1":"2022-03-30T07:20:50Z","datetime_field_2":{"eq":"2022-03-30T07:20:50Z"},"datetime_field_3":{"lt":"2022-03-30T07:20:50Z"},"datetime_field_4":{"lte":"2022-03-30T07:20:50Z"},"datetime_field_5":{"gt":"2022-03-30T07:20:50Z"},"datetime_field_6":{"gte":"2022-03-30T07:20:50Z"}}},"SortQuery":{"description":"The `asc` suffix is optional as the default sort order is ascending.\nThe `desc` suffix is used to specify a descending order.\nMultiple sort attributes may be provided via a comma separated list.\nJSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').\n","type":"string","example":"created_at desc","title":"SortQuery"},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"UnsupportedMediaTypeError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":415},"title":{"example":"UnsupportedMediaType"},"type":{"example":"https://httpstatuses.com/415"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"UnsupportedMediaType"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]}},"examples":{"CreateDebugSessionRequestExample":{"summary":"Create Debug Session Request","value":{"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"}]}}}},"DebugSessionExample":{"value":{"id":"e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee","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","5f9fd312-a987-4628-b4c5-bb4f4fddd5f7"],"created_at":"2024-10-01T20:10:00.000Z","updated_at":"2024-10-01T20:10:00.000Z","target_status":[{"target_id":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","version":"3.9","compatible_features":["traces"],"incompatible_features":["logs"]},{"target_id":"ae853602-23c7-4218-9071-82fdef3a1efe","version":"3.11","compatible_features":["traces","logs"],"incompatible_features":[]}],"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"}]}}}},"CGWLogSearchRequestExample":{"value":{"start":"2025-04-22T00:00:00Z","end":"2025-04-22T23:59:59Z","node_id":["d32d905a-ed33-46a3-a093-d8f536af9a8a","ae853602-23c7-4218-9071-82fdef3a1efe"],"order_by":{"field":"timestamp","direction":"desc"}}},"LogSearchRequestExample":{"value":{"start":"2025-04-22T00:00:00Z","end":"2025-04-22T23:59:59Z","node_id":["d32d905a-ed33-46a3-a093-d8f536af9a8a","ae853602-23c7-4218-9071-82fdef3a1efe"],"span_id":["090a0b0c0d0e0f00"],"trace_id":["ff0102030405060708090a0b0c0d0e0f"],"severity_text":["ERROR","WARN"],"severity_number":[17,15],"attributes":{"log_type":{"neq":"access"},"introspection_name":{"in":["request","response"]},"plugin_name":{"eq":"my-plugin"}},"order_by":{"field":"timestamp","direction":"desc"}}},"DebugSessionTraceByIDExample":{"value":{"resource_spans":[{"resource":{"attributes":{"service.instance.id":"1bcb601e-0e49-4c36-93ef-0a627b7415a0","service.version":"3.10.0.1","session.id":"019685c2-dafc-7633-8538-8be9b6c465cd","service.name":"kong"}},"scope_spans":[{"scope":{"name":"kong-internal","version":"0.1.0","attributes":{"instrumentation.version":"1.0.0"}},"spans":[{"trace_id":"487b5c0c365cf68d4e13fead68cfce93","span_id":"131cf8c7f90656b6","name":"kong","kind":"SPAN_KIND_SERVER","start_time_unix_nano":"1746000870167000064","end_time_unix_nano":"1746000870411013632","attributes":{"http.request.method":"GET","url.scheme":"http","network.protocol.version":"1.1","network.protocol.name":"http","http.response.status_code":200,"url.full":"http://localhost:8000/mock/anything","http.route":"/mock","user_agent.original":"curl/8.11.1"},"status":{"code":"STATUS_CODE_OK"}},{"trace_id":"487b5c0c365cf68d4e13fead68cfce93","span_id":"29b14f902993f6ea","parent_span_id":"131cf8c7f90656b6","name":"kong.read_client_http_body","kind":"SPAN_KIND_INTERNAL","start_time_unix_nano":"1746000870169033216","end_time_unix_nano":"1746000870169217280","attributes":{"proxy.kong.http.content_length":0,"kong.phase":"access"},"events":[{"timeUnixNano":"1746000870169100000","name":"request.body.read","attributes":{"bytes_read":0,"content_type":"application/json"}}],"links":[{"trace_id":"99dae214e66279fd559293af5e85f1d0","span_id":"af55acb4c1ad30d7","trace_state":"vendor1=value1,vendor2=value2","attributes":{"link.description":"log phase of request"}}],"status":{"code":"STATUS_CODE_OK"}}]}]}]}},"ListDebugSessionTracesExample":{"value":{"traces":[{"trace_id":"6126005fc4368d8eab4ce43433fcf7fd","root_service_name":"kong","root_trace_name":"kong","start_time_unix_nano":"1744883253696999936","duration_ms":2,"span_sets":[{"matched":1,"spans":[{"span_id":"8f36e5fa99c797dd","start_time_unix_nano":"1744883253696999936","duration_nanos":"2324736","attributes":{"url.full":"http://localhost:8000/abc","http.response.status_code":404,"session.id":"01964324-f95a-7e35-be97-51ae689fc853","http.request.method":"GET","user_agent.original":"curl/8.11.1"}}]}]},{"trace_id":"7237116ad4479a9fab5de544444fde8e","root_service_name":"kong","root_trace_name":"kong.proxy","start_time_unix_nano":"1744883258123456789","duration_ms":15,"span_sets":[{"matched":2,"spans":[{"span_id":"9e47f6fb88d908ee","start_time_unix_nano":"1744883258123456789","duration_nanos":"15234567","attributes":{"url.full":"http://localhost:8000/mock/users/123","http.response.status_code":200,"session.id":"01964324-f95a-7e35-be97-51ae689fc853","http.request.method":"POST","user_agent.original":"PostmanRuntime/7.32.1"}},{"span_id":"af58g7gc99e919ff","start_time_unix_nano":"1744883258125000000","duration_nanos":"12000000","attributes":{"upstream.host":"httpbin.org","http.response.status_code":200,"kong.plugin":"rate-limiting"}}]}]}]}},"TraceCapturesExample":{"value":{"response_body":"{\n  \"args\": {}, \n  \"data\": \"\", \n  \"files\": {}, \n  \"form\": {}, \n  \"headers\": {\n    \"Accept\": \"*/*\", \n    \"Connection\": \"keep-alive\", \n    \"Host\": \"httpbin.konghq.com\", \n    \"User-Agent\": \"curl/8.11.1\", \n    \"X-Forwarded-Host\": \"localhost\", \n    \"X-Forwarded-Path\": \"/mock/anything\", \n    \"X-Forwarded-Prefix\": \"/mock\", \n    \"X-Kong-Request-Id\": \"c018277347142c1211ece5329370a706\"\n  }, \n  \"json\": null, \n  \"method\": \"GET\", \n  \"origin\": \"172.17.0.1\", \n  \"url\": \"http://localhost/anything\"\n}\n","request_body":"fdddd","request_headers":{"host":"localhost:8000","user-agent":"curl/8.11.1","accept":"*/*"},"response_headers":{"content-length":"488","access-control-allow-origin":"*","connection":"keep-alive","content-type":"application/json"}}},"TraceDownloadRequestExample":{"value":{"include_logs":true,"include_captures":true,"format":"zip","log_filters":{"log_type":{"neq":"access"}}}},"CPUProfileResponseFramesFormatExample":{"value":{"metadata":{"profile":{"mode":"instruction","type":"cpu"}},"frames":[{"locations":[{"function":{"file":"/usr/local/openresty/site/lualib/resty/events/worker.lua","name":"Lua()"},"line":151},{"function":{"file":"/usr/local/openresty/site/lualib/resty/events/worker.lua","name":"terminating()"},"line":116}],"stacktrace":"@/usr/local/openresty/site/lualib/resty/events/worker.lua:151:Lua();@/usr/local/openresty/site/lualib/resty/events/worker.lua:116:terminating()","value":1},{"locations":[{"function":{"file":"/usr/local/share/lua/5.1/kong/clustering/telemetry.lu","name":"Lua()"},"line":105},{"function":{"file":"/usr/local/openresty/site/lualib/resty/websocket/client.lua","name":"recv_frame()"},"line":367}],"stacktrace":"@/usr/local/share/lua/5.1/kong/clustering/telemetry.lua:105:Lua();@/usr/local/openresty/site/lualib/resty/websocket/client.lua:367:recv_frame()","value":1}]}},"CPUProfileResponseFlamegraphFormatExample":{"value":{"metadata":{"profile":{"mode":"instruction","type":"cpu"}},"flamegraph":{"root":{"value":1056,"children":[{"location":{"function":{"file":"/usr/local/openresty/site/lualib/resty/events/worker.lua","name":"Lua()"},"line":151},"value":56,"children":[{"location":{"function":{"file":"/usr/local/openresty/site/lualib/resty/events/worker.lua","name":"terminating()"},"line":116},"value":450,"children":[]}]},{"location":{"function":{"file":"/usr/local/share/lua/5.1/kong/clustering/telemetry.lua","name":"Lua()"},"line":105},"value":550,"children":[]}]}}}},"DPASettingsExample":{"summary":"DPA settings example","value":{"id":"e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee","name":"OrgA DPA Settings","consent_by":"john.doe@example.com","consent_status":"APPROVED","created_at":"2024-10-01T20:10:00.000Z","updated_at":"2024-10-01T20:10:00.000Z"}},"UpdateDPASettingsRequestExample":{"summary":"Update DPA settings for organization","value":{"consent_by":"Jane Doe","consent_status":"REVOKED"}},"ControlPlaneLogSearchRequestExample":{"value":{"start":"2025-04-22T00:00:00Z","end":"2025-04-22T23:59:59Z","node_id":["d32d905a-ed33-46a3-a093-d8f536af9a8a"],"log_level":["ERROR","WARN"],"attributes":{"node_version":{"eq":"3.11.0.2"},"node_hostname":{"in":["dataplane-aea06c00","148e2409b54038"]}},"order_by":{"field":"timestamp","direction":"desc"}}},"ControlPlaneLogsExample":{"value":{"meta":{"next":"ewogICJpZCI6ICJhYmMxMjM0NTY3ODkwIgp9","previous":null,"size":2},"logs":[{"id":"fc15d9c9-f676-4871-9e30-c84c5e11b795","source":"control-plane","timestamp":"2025-04-22T15:30:45.123Z","log_level":"INFO","message":"Config payload pushed to DP","node_id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","node_hostname":"dp-worker-3","node_version":"3.11.0.2","config_version":"b33eeb0a6eb3751eb33eeb0a6eb3751e","subject":"dataplane.configuration_updated","context":{"specversion":"1.0","node_id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","node_version":"3.11.0.2","node_hostname":"dp-worker-3"}},{"id":"123e4567-e89b-12d3-a456-426614174003","source":"control-plane","timestamp":"2025-04-22T15:38:30.456Z","log_level":"WARN","message":"Dataplane disconnected","node_id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","node_hostname":"cp-worker-3","node_version":"3.10.0.1","subject":"dataplane.disconnect","context":{"specversion":"1.0","node_id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","node_version":"3.10.0.1","node_hostname":"cp-worker-3"}}]}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"UnsupportedMediaTypeExample":{"value":{"status":415,"title":"Unsupported Media Type","instance":"kong:trace:8347343766220159418","detail":"This API only supports requests with `Content-Type: application/json`"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"CreateDebugSessionRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugSession"},"examples":{"CreateDebugSessionRequestExample":{"$ref":"#/components/examples/CreateDebugSessionRequestExample"}}}}},"UpdateDPASettingsRequest":{"required":true,"description":"Request body for updating DPA settings for an organization.","content":{"application/json":{"schema":{"type":"object","properties":{"consent_by":{"description":"The optional settings consent by.","type":"string"},"consent_status":{"$ref":"#/components/schemas/ConsentStatus"}},"required":["consent_status"]},"examples":{"UpdateDPASettingsRequestExample":{"$ref":"#/components/examples/UpdateDPASettingsRequestExample"}}}}},"ControlPlaneLogSearchRequest":{"required":true,"description":"Request body for searching control plane logs.","content":{"application/json":{"schema":{"description":"Represents the request payload for searching control plane logs.","type":"object","properties":{"start":{"description":"The start time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"end":{"description":"The end time for the log search query. Must be in RFC-3339 format.","type":"string","format":"date-time"},"node_id":{"description":"A list of data plane node IDs to filter logs.","type":"array","items":{"type":"string","uniqueItems":true,"format":"uuid"}},"log_level":{"description":"The log levels to filter logs.","type":"array","items":{"$ref":"#/components/schemas/ControlPlaneLogLevel"},"uniqueItems":true},"attributes":{"$ref":"#/components/schemas/ControlPlaneLogsAttributesFilter"},"order_by":{"$ref":"#/components/schemas/ControlPlaneLogsOrderBy"}},"required":["start","end"]},"examples":{"ControlPlaneLogSearchRequestExample":{"$ref":"#/components/examples/ControlPlaneLogSearchRequestExample"}}}}},"CGWLogSearchRequest":{"required":true,"description":"Request body for searching cloud gateway logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CGWLogSearchRequestSchema"},"examples":{"ControlPlaneLogSearchRequestExample":{"$ref":"#/components/examples/CGWLogSearchRequestExample"}}}}},"OrgScopedCGWLogSearchRequest":{"required":true,"description":"Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrgScopedCGWLogSearchRequestSchema"},"examples":{"OrgScopedCGWLogSearchRequestExample":{"value":{"start":"2025-04-22T00:00:00Z","end":"2025-04-22T23:59:59Z","control_plane_id":["456e7890-e89b-12d3-a456-426614174002","789e1234-e89b-12d3-a456-426614174005"],"node_id":["d32d905a-ed33-46a3-a093-d8f536af9a8a","ae853602-23c7-4218-9071-82fdef3a1efe"],"order_by":{"field":"timestamp","direction":"desc"}}}}}}}},"responses":{"ListDebugSessionsResponse":{"description":"List of DebugSessions","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/CursorMeta"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DebugSession"}}},"required":["data","meta"],"title":"ListDebugSessionsResponse"},"examples":{"Debug Sessions":{"value":{"data":[{"id":"e7a4f6c0-5777-4a37-bcb9-2d37d3b362ee","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}},"created_at":"2024-10-01T20:00:00.000Z","updated_at":"2024-10-01T20:00:00.000Z","targets":["ae853602-23c7-4218-9071-82fdef3a1efe"]}],"meta":{"page":{"size":10,"next":null,"previous":null}}}}}}}},"DebugSessionResponse":{"description":"Debug Session Response","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DebugSession"},{"required":["id","max_samples","duration_secs","created_at","targets"],"properties":{"target_status":{"description":"Feature support and status for each node instance based on its version","type":"array","items":{"$ref":"#/components/schemas/TargetStatus"}}}}]},"examples":{"Create Debug Session Response":{"$ref":"#/components/examples/DebugSessionExample"}}}}},"DebugSessionStopResponse":{"description":"Debug Session Stop Response","content":{"application/json":{"schema":{"type":"object"}}}},"DPASettingsResponse":{"description":"Response body for retrieving DPA settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DPASettings"},"examples":{"Response example":{"$ref":"#/components/examples/DPASettingsExample"}}}}},"DebugSessionDoneResponse":{"description":"Debug Session Done Response","content":{"application/json":{"schema":{"type":"object"}}}},"CPUProfileResponse":{"description":"Returns cpu profile belonging to a session","content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CPUProfileMetadata"},"frames":{"type":"array","items":{"$ref":"#/components/schemas/CPUProfileFrame"}},"flamegraph":{"$ref":"#/components/schemas/CPUProfileFlamegraph"}},"required":["metadata"]},"examples":{"Frames Format Example":{"$ref":"#/components/examples/CPUProfileResponseFramesFormatExample"},"Flamegraph Format Example":{"$ref":"#/components/examples/CPUProfileResponseFlamegraphFormatExample"}}}}},"ControlPlaneLogSearchResponse":{"description":"Response body for searching control plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ControlPlaneLogSearchResponseSchema"},"examples":{"Response example":{"$ref":"#/components/examples/ControlPlaneLogsExample"}}}}},"ControlPlaneLogDistinctValuesResponse":{"description":"Response containing distinct values for a specific attribute in control plane logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistinctValuesResponse"},"example":{"data":["WARN","INFO","ERROR"]}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"UnsupportedMediaType":{"description":"Unsupported Media Type","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError"},"examples":{"UnsupportedMediaTypeExample":{"$ref":"#/components/examples/UnsupportedMediaTypeExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"securitySchemes":{"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"}}},"tags":[{"name":"Tracing Sessions","description":"Tracing Session APIs"},{"name":"Session Logs","description":"Debug Session Logs APIs"},{"name":"Session Profiles","description":"Debug Session Profiles APIs"},{"name":"Organization Settings","description":"Organization Settings APIs"},{"name":"Control Plane Logs","description":"Control Plane Logs APIs"},{"name":"Cloud Gateway Logs","description":"Cloud Gateway Logs APIs"}],"security":[{"konnectAccessToken":[]},{"personalAccessToken":[]}]}
```
