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

Search Distinct Values in Cloud Gateway Logs

Search distinct values in specified logs attributes for cloud gateway logs in a control plane

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 cloud gateway logs by distinct values. Currently, only “node_id” is supported.

Allowed values:node_id

Example:node_id

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

Distinct values for the specified attributes in the cloud gateway logs

LogsDistinctValuesResponse

Represents the distinct values for a specific attribute in the logs.

dataarray[string]requiredunique-items

A list of distinct values for the specified attribute in the logs.

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

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

Search cloud gateway logs for an organization

Search logs for all cloud gateways in the organization 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

Body

application/json

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.

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
control_plane_idarray[string](uuid)unique-items

A list of control plane IDs to filter logs.

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/o11y/cgw-logs/search

Body

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