---
title: "Search cloud gateway logs"
url: "https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4/operations/ollySearchCGWLogs"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4.md

# Search cloud gateway logs

`POST` `/control-planes/{controlPlaneId}/o11y/cgw-logs/search`

Operation ID: `ollySearchCGWLogs`

Search logs for a cloud gateway with filtering capabilities

## Path parameters

- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.
- `page[before]` (string, optional) - Request the next page of data, starting with the item before this parameter.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Matching OTel CGW data plane logs
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Dolly APIs
  version: 1.0.0
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/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
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    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.
    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
    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
  requestBodies:
    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"
  schemas:
    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
    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
    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
    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
    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
    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
    Attributes:
      type: object
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          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
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    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
    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
    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
  responses:
    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"
  examples:
    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
    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
  securitySchemes:
    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.
    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.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
```
