Tyk Debug API

openapi: 3.2.0
info:
  title: Tyk Debug API
  contact:
    email: support@tyk.io
    name: Tyk Technologies
    url: https://tyk.io/contact
  version: '1.0'
  description: 'Operations tagged Debug across 2 of this provider''s published API definitions: tyk-gateway-api-openapi.yml, tyk-mdcb-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: localhost:8080
      description: Your gateway host
security:
- api_key: []
tags:
- name: Debug
paths:
  /tyk/debug:
    post:
      description: Used to test API definition by sending sample request and analysing output of both response and logs.
      operationId: debugApiDefinition
      requestBody:
        content:
          application/json:
            example:
              request:
                method: GET
                path: /update-listen-path
              spec:
                api_id: b84fe1a04e5648927971c0557971565c
                auth:
                  auth_header_name: authorization
                definition:
                  key: version
                  location: header
                name: Tyk Test API
                org_id: 664a14650619d40001f1f00f
                proxy:
                  listen_path: /tyk-api-test/
                  strip_listen_path: true
                  target_url: https://httpbin.org
                use_oauth2: true
                version_data:
                  not_versioned: true
                  versions:
                    Default:
                      name: Default
            schema:
              $ref: '#/components/schemas/TraceRequest'
      responses:
        '200':
          content:
            application/json:
              example:
                logs: '{"level":"warning","msg":"Legacy path detected! Upgrade to extended....'
                message: ok
                response: '====== Request ======

                  GET / HTTP/1.1

                  Host: httpbin.org



                  ====== Response...'
              schema:
                $ref: '#/components/schemas/TraceResponse'
          description: Success tracing request.
        '400':
          content:
            application/json:
              example:
                message: Request malformed
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Bad Request
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: 'Unexpected failure:'
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Internal server error.
      summary: Tyk Test an an Api Definition.
      tags:
      - Debug
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{tenant}
      variables:
        tenant:
          default: localhost:8080
          description: Your gateway host
  /debug/pprof/profile:
    get:
      summary: Tyk Cpu Profiling Data
      description: Returns CPU profiling data. Available only when HTTPProfile is enabled in sink.conf.
      operationId: debugPprofProfileGet
      responses:
        '200':
          description: CPU profiling data.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      tags:
      - Debug
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{tenant}
      variables:
        tenant:
          default: localhost:8181
          description: Your MDCB host
  /debug/pprof/{profileType}:
    get:
      summary: Tyk Pprof Data
      description: 'Serves various pprof data like heap, goroutine, threadcreate, block, and so on. The `{profileType}` path parameter can accept various profiling types as well as more complex patterns. Available only when HTTPProfile is enabled in sink.conf.

        '
      operationId: debugPprofProfileTypeGet
      parameters:
      - in: path
        name: profileType
        required: true
        description: The specific pprof data to retrieve (heap, goroutine, threadcreate, block, etc.), or a pattern matching multiple types.
        schema:
          type: string
          example: heap
      responses:
        '200':
          description: pprof data.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
      tags:
      - Debug
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{tenant}
      variables:
        tenant:
          default: localhost:8181
          description: Your MDCB host
components:
  schemas:
    GlobalRateLimit:
      properties:
        disabled:
          type: boolean
          example: true
        per:
          type: number
          example: 42.5
        rate:
          type: number
          example: 42.5
      type: object
    GraphQLIntrospectionConfig:
      properties:
        disabled:
          type: boolean
          example: true
      type: object
    OpenIDOptions:
      properties:
        providers:
          items:
            $ref: '#/components/schemas/OIDProviderConfig'
          type:
          - array
          - 'null'
          example: []
        segregate_by_client:
          type: boolean
          example: true
      type: object
    GraphQLEngineConfig:
      properties:
        data_sources:
          items:
            $ref: '#/components/schemas/GraphQLEngineDataSource'
          type:
          - array
          - 'null'
          example: []
        field_configs:
          items:
            $ref: '#/components/schemas/GraphQLFieldConfig'
          type:
          - array
          - 'null'
          example: []
        global_headers:
          items:
            $ref: '#/components/schemas/UDGGlobalHeader'
          type:
          - array
          - 'null'
          example: []
      type: object
    TemplateData:
      properties:
        enable_session:
          type: boolean
          example: true
        input_type:
          enum:
          - json
          - xml
          type: string
          example: json
        template_mode:
          enum:
          - blob
          - file
          type: string
          example: blob
        template_source:
          type: string
          example: example_value
      type: object
    Scopes:
      properties:
        jwt:
          $ref: '#/components/schemas/ScopeClaim'
        oidc:
          $ref: '#/components/schemas/ScopeClaim'
      type: object
    ResponseProcessor:
      properties:
        name:
          type: string
          example: Example Title
        options:
          example: example_value
      type: object
    EndpointMethodMeta:
      properties:
        action:
          enum:
          - no_action
          - reply
          type: string
          example: no_action
        code:
          type: integer
          example: 10
        data:
          type: string
          example: example_value
        headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
      type: object
    DatasourceSourceConfig:
      properties:
        data_source_config:
          example: example_value
        kind:
          type: string
          example: example_value
      type: object
    GraphQLSubgraphConfig:
      properties:
        sdl:
          type: string
          example: example_value
      type: object
    InternalMeta:
      properties:
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    GraphQLConfig:
      properties:
        enabled:
          type: boolean
          example: true
        engine:
          $ref: '#/components/schemas/GraphQLEngineConfig'
        execution_mode:
          enum:
          - proxyOnly
          - executionEngine
          - subgraph
          - supergraph
          type: string
          example: proxyOnly
        introspection:
          $ref: '#/components/schemas/GraphQLIntrospectionConfig'
        last_schema_update:
          format: date-time
          type:
          - string
          - 'null'
          example: '2026-01-15T10:30:00Z'
        playground:
          $ref: '#/components/schemas/GraphQLPlayground'
        proxy:
          $ref: '#/components/schemas/GraphQLProxyConfig'
        schema:
          type: string
          example: example_value
        subgraph:
          $ref: '#/components/schemas/GraphQLSubgraphConfig'
        supergraph:
          $ref: '#/components/schemas/GraphQLSupergraphConfig'
        type_field_configurations:
          items:
            $ref: '#/components/schemas/DatasourceTypeFieldConfiguration'
          type:
          - array
          - 'null'
          example: []
        version:
          enum:
          - ''''
          - '1'
          - '2'
          type: string
          example: ''''
      type: object
    RoutingTrigger:
      properties:
        'on':
          enum:
          - all
          - any
          type: string
          example: all
        options:
          $ref: '#/components/schemas/RoutingTriggerOptions'
        rewrite_to:
          type: string
          example: example_value
      type: object
    HeaderInjectionMeta:
      properties:
        act_on:
          type: boolean
          example: true
        add_headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        delete_headers:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    JWTValidation:
      properties:
        enabled:
          type: boolean
          example: true
        expires_at_validation_skew:
          minimum: 0
          type: integer
          example: 10
        identity_base_field:
          type: string
          example: example_value
        issued_at_validation_skew:
          minimum: 0
          type: integer
          example: 10
        not_before_validation_skew:
          minimum: 0
          type: integer
          example: 10
        signing_method:
          type: string
          example: example_value
        source:
          type: string
          example: example_value
      type: object
    CORSConfig:
      properties:
        allow_credentials:
          example: false
          type: boolean
        allowed_headers:
          example:
          - Origin
          - Accept
          - Content-Type
          - Authorization
          items:
            type: string
          type:
          - array
          - 'null'
        allowed_methods:
          example:
          - GET
          - HEAD
          - POST
          items:
            type: string
          type:
          - array
          - 'null'
        allowed_origins:
          example:
          - https://*.foo.com
          items:
            type: string
          type:
          - array
          - 'null'
        debug:
          example: true
          type: boolean
        enable:
          example: false
          type: boolean
        exposed_headers:
          example:
          - Accept
          - Content-Type
          items:
            type: string
          type:
          - array
          - 'null'
        max_age:
          example: 24
          type: integer
        options_passthrough:
          example: false
          type: boolean
      type: object
    RequestSizeMeta:
      properties:
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        size_limit:
          format: int64
          type: integer
          example: 10
      type: object
    AuthConfig:
      properties:
        auth_header_name:
          example: Authorization
          type: string
        cookie_name:
          type: string
          example: example_value
        disable_header:
          type: boolean
          example: true
        name:
          type: string
          example: Example Title
        param_name:
          type: string
          example: example_value
        signature:
          $ref: '#/components/schemas/SignatureConfig'
        use_certificate:
          type: boolean
          example: true
        use_cookie:
          type: boolean
          example: true
        use_param:
          type: boolean
          example: true
        validate_signature:
          type: boolean
          example: true
      type: object
    RoutingTriggerOptions:
      properties:
        header_matches:
          additionalProperties:
            $ref: '#/components/schemas/StringRegexMap'
          type:
          - object
          - 'null'
          example: example_value
        path_part_matches:
          additionalProperties:
            $ref: '#/components/schemas/StringRegexMap'
          type:
          - object
          - 'null'
          example: example_value
        payload_matches:
          $ref: '#/components/schemas/StringRegexMap'
        query_val_matches:
          additionalProperties:
            $ref: '#/components/schemas/StringRegexMap'
          type:
          - object
          - 'null'
          example: example_value
        request_context_matches:
          additionalProperties:
            $ref: '#/components/schemas/StringRegexMap'
          type:
          - object
          - 'null'
          example: example_value
        session_meta_matches:
          additionalProperties:
            $ref: '#/components/schemas/StringRegexMap'
          type:
          - object
          - 'null'
          example: example_value
      type: object
    TemplateMeta:
      properties:
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        template_data:
          $ref: '#/components/schemas/TemplateData'
      type: object
    EndPointMeta:
      properties:
        disabled:
          type: boolean
          example: true
        ignore_case:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        method_actions:
          additionalProperties:
            $ref: '#/components/schemas/EndpointMethodMeta'
          type: object
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    GraphQLEngineDataSource:
      properties:
        config:
          example: example_value
        internal:
          type: boolean
          example: true
        kind:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
        root_fields:
          items:
            $ref: '#/components/schemas/GraphQLTypeFields'
          type:
          - array
          - 'null'
          example: []
      type: object
    Introspection:
      properties:
        cache:
          $ref: '#/components/schemas/IntrospectionCache'
        client_id:
          type: string
          example: '500123'
        client_secret:
          type: string
          example: example_value
        enabled:
          type: boolean
          example: true
        identity_base_field:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      type: object
    TraceRequest:
      properties:
        request:
          $ref: '#/components/schemas/TraceHttpRequest'
        spec:
          $ref: '#/components/schemas/APIDefinition'
      type: object
    DatasourceMappingConfiguration:
      properties:
        disabled:
          type: boolean
          example: true
        path:
          type: string
          example: example_value
      type: object
    CacheOptions:
      properties:
        cache_all_safe_requests:
          example: false
          type: boolean
        cache_by_headers:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        cache_control_ttl_header:
          type: string
          example: example_value
        cache_response_codes:
          items:
            type: integer
          type:
          - array
          - 'null'
          example: []
        cache_timeout:
          example: 60
          format: int64
          type: integer
        enable_cache:
          example: true
          type: boolean
        enable_upstream_cache_control:
          example: false
          type: boolean
      type: object
    SignatureConfig:
      properties:
        algorithm:
          type: string
          example: example_value
        allowed_clock_skew:
          type: integer
          example: 10
        error_code:
          type: integer
          example: 10
        error_message:
          type: string
          example: example_value
        header:
          type: string
          example: example_value
        param_name:
          type: string
          example: example_value
        secret:
          type: string
          example: example_value
        use_param:
          type: boolean
          example: true
      type: object
    Provider:
      properties:
        introspection:
          $ref: '#/components/schemas/Introspection'
        jwt:
          $ref: '#/components/schemas/JWTValidation'
      type: object
    MockResponseMeta:
      properties:
        body:
          type: string
          example: example_value
        code:
          type: integer
          example: 10
        disabled:
          type: boolean
          example: true
        headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        ignore_case:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    ProxyConfig:
      properties:
        check_host_against_uptime_tests:
          type: boolean
          example: true
        disable_strip_slash:
          type: boolean
          example: true
        enable_load_balancing:
          type: boolean
          example: true
        listen_path:
          example: /relative-path-examples/
          type: string
        preserve_host_header:
          type: boolean
          example: true
        service_discovery:
          $ref: '#/components/schemas/ServiceDiscoveryConfiguration'
        strip_listen_path:
          example: true
          type: boolean
        target_list:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        target_url:
          example: https://httpbin.org/
          type: string
        transport:
          properties:
            proxy_url:
              type: string
            ssl_ciphers:
              items:
                type: string
              type:
              - array
              - 'null'
            ssl_force_common_name_check:
              type: boolean
            ssl_insecure_skip_verify:
              type: boolean
            ssl_max_version:
              minimum: 0
              type: integer
            ssl_min_version:
              minimum: 0
              type: integer
          type: object
          example: example_value
      type: object
    VersionData:
      properties:
        default_version:
          type: string
          example: example_value
        not_versioned:
          type: boolean
          example: true
        versions:
          additionalProperties:
            $ref: '#/components/schemas/VersionInfo'
          type:
          - object
          - 'null'
          example: example_value
      type: object
    CacheMeta:
      properties:
        cache_key_regex:
          type: string
          example: example_value
        cache_response_codes:
          items:
            type: integer
          type:
          - array
          - 'null'
          example: []
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        timeout:
          format: int64
          type: integer
          example: 10
      type: object
    ValidatePathMeta:
      properties:
        disabled:
          type: boolean
          example: true
        error_response_code:
          type: integer
          example: 10
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        schema:
          additionalProperties: {}
          type:
          - object
          - 'null'
          example: example_value
        schema_b64:
          type: string
          example: example_value
      type: object
    ValidateRequestMeta:
      properties:
        enabled:
          type: boolean
          example: true
        error_response_code:
          type: integer
          example: 10
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    GraphQLFieldConfig:
      properties:
        disable_default_mapping:
          type: boolean
          example: true
        field_name:
          type: string
          example: example_value
        path:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        type_name:
          type: string
          example: example_value
      type: object
    TrackEndpointMeta:
      properties:
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    HardTimeoutMeta:
      properties:
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        timeout:
          type: integer
          example: 10
      type: object
    CircuitBreakerMeta:
      properties:
        disable_half_open_state:
          type: boolean
          example: true
        disabled:
          type: boolean
          example: true
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        return_to_service_after:
          type: integer
          example: 10
        samples:
          format: int64
          type: integer
          example: 10
        threshold_percent:
          type: number
          example: 42.5
      type: object
    GraphQLSupergraphConfig:
      properties:
        disable_query_batching:
          type: boolean
          example: true
        global_headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        merged_sdl:
          type: string
          example: example_value
        subgraphs:
          items:
            $ref: '#/components/schemas/GraphQLSubgraphEntity'
          type:
          - array
          - 'null'
          example: []
        updated_at:
          format: date-time
          type:
          - string
          - 'null'
          example: '2026-01-15T10:30:00Z'
      type: object
    MiddlewareSection:
      properties:
        auth_check:
          $ref: '#/components/schemas/MiddlewareDefinition'
        driver:
          type: string
          example: example_value
        id_extractor:
          $ref: '#/components/schemas/MiddlewareIdExtractor'
        post:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          type:
          - array
          - 'null'
          example: []
        post_key_auth:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          type:
          - array
          - 'null'
          example: []
        pre:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          type:
          - array
          - 'null'
          example: []
        response:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          type:
          - array
          - 'null'
          example: []
      type: object
    DatasourceTypeFieldConfiguration:
      properties:
        data_source:
          $ref: '#/components/schemas/DatasourceSourceConfig'
        field_name:
          type: string
          example: example_value
        mapping:
          $ref: '#/components/schemas/DatasourceMappingConfiguration'
        type_name:
          type: string
          example: example_value
      type: object
    GraphQLSubgraphEntity:
      properties:
        api_id:
          type: string
          example: '500123'
        headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        name:
          type: string
          example: Example Title
        sdl:
          type: string
          example: example_value
        subscription_type:
          type: string
          example: example_value
        url:
          type: string
          example: https://www.example.com
      type: object
    URLRewriteMeta:
      properties:
        disabled:
          type: boolean
          example: true
        match_pattern:
          type: string
          example: example_value
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        rewrite_to:
          type: string
          example: example_value
        triggers:
          items:
            $ref: '#/components/schemas/RoutingTrigger'
          type:
          - array
          - 'null'
          example: []
      type: object
    GraphQLResponseExtensions:
      properties:
        on_error_forwarding:
          type: boolean
          example: true
      type: object
    UptimeTestsConfig:
      properties:
        expire_utime_after:
          type: integer
          example: 10
        recheck_wait:
          type: integer
          example: 10
        service_discovery:
          $ref: '#/components/schemas/ServiceDiscoveryConfiguration'
      type: object
    VersionDefinition:
      properties:
        default:
          type: string
          example: example_value
        enabled:
          type: boolean
          example: true
        fallback_to_default:
          type: boolean
          example: true
        key:
          example: x-api-version
          type: string
        location:
          example: header
          type: string
        name:
          type: string
          example: Example Title
        strip_path:
          type: boolean
          example: true
        strip_versioning_data:
          type: boolean
          example: true
        url_versioning_pattern:
          type: string
          example: https://www.example.com
        versions:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
      type: object
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      type: object
    AuthProviderMeta:
      properties:
        meta:
          additionalProperties: {}
          type:
          - object
          - 'null'
          example: example_value
        name:
          type: string
          example: Example Title
        storage_engine:
          type: string
          example: example_value
      type: object
    MiddlewareIdExtractor:
      properties:
        disabled:
          type: boolean
          example: true
        extract_from:
          type: string
          example: example_value
        extract_with:
          type: string
          example: example_value
        extractor_config:
          additionalProperties: {}
          type:
          - object
          - 'null'
          example: example_value
      type: object
    TransformJQMeta:
      properties:
        filter:
          type: string
          example: example_value
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    NotificationsManager:
      properties:
        oauth_on_keychange_url:
          type: string
          example: https://www.example.com
        shared_secret:
          type: string
          example: example_value
      type: object
    TraceHttpRequest:
      properties:
        body:
          type: string
          example: example_value
        headers:
          $ref: '#/components/schemas/HttpHeader'
        method:
          example: GET
          type: string
        path:
          example: /keyless-test/
          type: string
      type: object
    VersionInfo:
      properties:
        expires:
          type: string
          example: example_value
        extended_paths:
          $ref: '#/components/schemas/ExtendedPathsSet'
        global_headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        global_headers_disabled:
          type: boolean
          example: true
        global_headers_remove:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        global_response_headers:
          additionalProperties:
            type: string
          type:
          - object
          - 'null'
          example: example_value
        global_response_headers_disabled:
          type: boolean
          example: true
        global_response_headers_remove:
          items:
            type: string
          type:
          - array
          - 'null'
          example: []
        global_size_limit:
          format: int64
          type: integer
          example: 10
        ignore_endpoint_case:
          type: boolean
          example: true
        name:
          type: string
          example: Example Title
        override_target:
          type: string
          example: example_value
        paths:
          properties:
            black_list:
              items:
                type: string
              type:
              - array
              - 'null'
            ignored:
              items:
                type: string
              type:
              - array
              - 'null'
            white_list:
              items:
                type: string
              type:
              - array
              - 'null'
          type: object
          example: example_value
        use_extended_paths:
          example: true
          type: boolean
      type: object
    GoPluginMeta:
      properties:
        disabled:
          type: boolean
          example: true
        func_name:
          type: string
          example: example_value
        method:
          type: string
          example: examp

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/openapi/tyk-debug-api-openapi.yml