---
title: "Get the captures for a trace"
url: "https://nov18-dev.movespot.fyi/apis/konnect-dolly-apis-dev-1/versions/4ba55f2d-e3a2-486c-a018-16faa4e1afe4/operations/getCapturesForTrace"
---

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

# Get the captures for a trace

`GET` `/control-planes/{controlPlaneId}/o11y/debug-sessions/{debugSessionId}/traces/{traceId}/captures`

Operation ID: `getCapturesForTrace`

Returns the request/response body/headers for a trace ID as part of the session capture

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

## Responses

- `200` - The capture content for a trace ID
- `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}/captures:
    parameters:
      - $ref: "#/components/parameters/controlPlaneId"
      - $ref: "#/components/parameters/debugSessionId"
      - $ref: "#/components/parameters/traceId"
    get:
      operationId: getCapturesForTrace
      summary: Get the captures for a trace
      description: Returns the request/response body/headers for a trace ID as part of
        the session capture
      responses:
        "200":
          description: The capture content for a trace ID
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TraceCaptures"
              examples:
                TraceCapturesExample:
                  $ref: "#/components/examples/TraceCapturesExample"
        "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:
    TraceCaptures:
      description: Represents the request/response captures associated with a trace
      type: object
      properties:
        request_body:
          description: The captured request body
          type: string
        request_headers:
          description: The captured request headers
          type: object
        response_body:
          description: The captured response body
          type: string
        response_headers:
          description: The captured response headers
          type: object
    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
    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
  examples:
    TraceCapturesExample:
      value:
        response_body: |
          {
            "args": {}, 
            "data": "", 
            "files": {}, 
            "form": {}, 
            "headers": {
              "Accept": "*/*", 
              "Connection": "keep-alive", 
              "Host": "httpbin.konghq.com", 
              "User-Agent": "curl/8.11.1", 
              "X-Forwarded-Host": "localhost", 
              "X-Forwarded-Path": "/mock/anything", 
              "X-Forwarded-Prefix": "/mock", 
              "X-Kong-Request-Id": "c018277347142c1211ece5329370a706"
            }, 
            "json": null, 
            "method": "GET", 
            "origin": "172.17.0.1", 
            "url": "http://localhost/anything"
          }
        request_body: fdddd
        request_headers:
          host: localhost:8000
          user-agent: curl/8.11.1
          accept: "*/*"
        response_headers:
          content-length: "488"
          access-control-allow-origin: "*"
          connection: keep-alive
          content-type: application/json
    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:
    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...'`
```
