Search Distinct Values in Cloud Gateway Logs
Search distinct values in specified logs attributes for cloud gateway logs in a control plane
Path Parameters
The UUID of your control plane. This variable is available in the Konnect manager.
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Field to filter cloud gateway logs by distinct values. Currently, only “node_id” is supported.
Allowed values:node_id
Example:node_id
Body
application/json
Body
Request body for searching cloud gateway logs.
CGWLogSearchRequestSchema
Base schema for searching cloud gateway logs.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
Response
application/json
Response
Distinct values for the specified attributes in the cloud gateway logs
LogsDistinctValuesResponse
Represents the distinct values for a specific attribute in the logs.
A list of distinct values for the specified attribute in the logs.
Authentication
Path Parameters
Body
Search cloud gateway logs for an organization
Search logs for all cloud gateways in the organization with filtering capabilities
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Body
application/json
Body
Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.
OrgScopedCGWLogSearchRequestSchema
Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
A list of control plane IDs to filter logs.
Response
application/json
Response
Matching OTel CGW data plane logs
LogSearchResponse
Show Child Parameters
Represents a log entry based on the OpenTelemetry (OTel) data model.
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"}}}
Show Child Parameters
Authentication
Query Parameters
Body
Count cloud gateway logs for an organization
Count logs for all cloud gateways in the organization with filtering capabilities
Body
application/json
Body
Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.
OrgScopedCGWLogSearchRequestSchema
Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
A list of control plane IDs to filter logs.
Response
application/json
Response
Count of matching OTel CGW data plane logs
LogCountResponse
Represents the count response for log search queries.
The total number of logs matching the search criteria.
Authentication
Body
Download cloud gateway logs
Download logs for all cloud gateways in the organization with filtering capabilities
Body
application/json
Body
Request body for searching cloud gateway logs globally. Accepts controlPlaneIds and all CGWLogSearchRequest attributes.
OrgScopedCGWLogSearchRequestSchema
Schema for searching cloud gateway logs globally, extending base CGW search with control plane filtering.
The start time for the log search query. Must be in RFC-3339 format.
The end time for the log search query. Must be in RFC-3339 format.
A list of data plane node IDs to filter logs.
Specifies the sorting order for the logs in the response.
Show Child Parameters
A list of control plane IDs to filter logs.
Response
text/csv
Response
CSV file containing matching OTel CGW data plane logs
CSV formatted log data
Authentication
Body
DebugSession
objectContains 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