---
title: "Download traces and logs for a trace ID"
url: "https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4/operations/downloadTraceAndLogs"
---

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

# Download traces and logs for a trace ID

`POST` `/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/download`

Operation ID: `downloadTraceAndLogs`

Downloads traces and associated logs and payload for a specific trace ID in a debug session as a ZIP file. The ZIP file contains separate JSON files: - `trace.json`: Complete trace data (same format as getTraceById) - `logs.json`: Associated logs array (same format as log search responses) - `captures.json`: Request/response captures (same format as getCapturesForTrace) Files are only included based on the request parameters (include_logs, include_captures).

## Path parameters

- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.
- `debugSessionId` (string, uuid, required) - Debug Session identifier
- `traceId` (string, required) - Unique identifier of the trace.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - ZIP file containing separate JSON files for traces, logs, and captures for the specified trace ID
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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/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.


        The ZIP file contains separate JSON files:

        - `trace.json`: Complete trace data (same format as getTraceById)

        - `logs.json`: Associated logs array (same format as log search
        responses)

        - `captures.json`: Request/response captures (same format as
        getCapturesForTrace)


        Files are only included based on the request parameters (include_logs,
        include_captures).
      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
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.
    debugSessionId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: debugSessionId
      in: path
      required: true
      description: Debug Session identifier
    traceId:
      schema:
        type: string
        example: 0b419ff749c4dabf5f45b0cfee053bc1
      name: traceId
      in: path
      required: true
      description: Unique identifier of the trace.
  schemas:
    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
    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
    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
    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
    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
    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
  examples:
    TraceDownloadRequestExample:
      value:
        include_logs: true
        include_captures: true
        format: zip
        log_filters:
          log_type:
            neq: access
    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
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  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"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  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...'`
```
