Search Distinct Values in Control Plane Logs

Retrieve distinct values for a specified field in control plane logs with optional filtering

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

logFieldFilterstringrequired

Field to filter logs by distinct values.

Allowed values:log_levelnode_idnode_version

Example:log_level

Body

application/json

Request body for searching control plane logs.

Represents the request payload for searching control plane logs.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

log_levelarray[string]unique-items

The log level for control plane logs.

Allowed values:DEBUGINFOWARNERROR

attributesobject

Key-value pairs to filter logs based on specific attributes.

* Additional properties are NOT allowed.
Show Child Parameters
order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters

Response

application/json

Response containing distinct values for a specific attribute in control plane logs

DistinctValuesResponse

Represents distinct values for a specific attribute

dataarray[string]requiredunique-items

A list of distinct values for the specified attribute

post/control-planes/{controlPlaneId}/o11y/logs/distinct-values/{logFieldFilter}

Body

{ "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" } }
 
application/json

Cloud Gateway Logs

Cloud Gateway Logs APIs

Search cloud gateway logs

Search logs for a cloud gateway with filtering capabilities

post

Query Parameters

page[size]integer

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

Example:10

page[after]string

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

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

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

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Request body for searching cloud gateway logs.

CGWLogSearchRequestSchema

Base schema for searching cloud gateway logs.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters

Response

application/json

Matching OTel CGW data plane logs

LogSearchResponse

metaobject
Show Child Parameters
logsarray[object]required

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
post/control-planes/{controlPlaneId}/o11y/cgw-logs/search

Body

{ "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" } }
 
application/json

Count cloud gateway logs

Count logs for a cloud gateway with filtering capabilities

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Request body for searching cloud gateway logs.

CGWLogSearchRequestSchema

Base schema for searching cloud gateway logs.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters

Response

application/json

Count of matching OTel CGW data plane logs

LogCountResponse

Represents the count response for log search queries.

countinteger(int64)required

The total number of logs matching the search criteria.

post/control-planes/{controlPlaneId}/o11y/cgw-logs/count

Body

{ "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" } }
 
application/json

Download cloud gateway logs as CSV

Download logs for a cloud gateway with filtering capabilities in CSV format

post

Path Parameters

controlPlaneIdstring(uuid)required

The UUID of your control plane. This variable is available in the Konnect manager.

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json

Request body for searching cloud gateway logs.

CGWLogSearchRequestSchema

Base schema for searching cloud gateway logs.

startstring(date-time)required

The start time for the log search query. Must be in RFC-3339 format.

endstring(date-time)required

The end time for the log search query. Must be in RFC-3339 format.

node_idarray[string](uuid)unique-items

A list of data plane node IDs to filter logs.

order_byobject

Specifies the sorting order for the logs in the response.

Show Child Parameters

Response

text/csv

CSV file containing matching OTel CGW data plane logs

string

CSV formatted log data

post/control-planes/{controlPlaneId}/o11y/cgw-logs/download

Body

{ "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" } }
 
text/csv