Tyk Debug API

openapi: 3.0.0
info:
  title: Tyk Dashboard Admin Additional Permissions Debug API
  version: 5.3.0
  description: 'For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.


    In order to use the Dashboard Admin API, you''ll need to get the `admin_secret` value from your Tyk Dashboard configurations.


    The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:


    ```

    admin-auth: <your-secret>

    ```'
servers:
- url: http://localhost/
- url: https://localhost/
security:
- ApiKeyAuth: []
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 ======\nGET / HTTP/1.1\r\nHost: httpbin.org\r\n\r\n\n====== 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
  /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
  /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
components:
  schemas:
    GraphQLProxyConfig:
      properties:
        auth_headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        features:
          $ref: '#/components/schemas/GraphQLProxyFeaturesConfig'
        request_headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        request_headers_rewrite:
          additionalProperties:
            $ref: '#/components/schemas/RequestHeadersRewriteConfig'
          nullable: true
          type: object
          example: example_value
        subscription_type:
          type: string
          example: example_value
        use_response_extensions:
          $ref: '#/components/schemas/GraphQLResponseExtensions'
      type: object
    MiddlewareDefinition:
      properties:
        disabled:
          type: boolean
          example: true
        name:
          example: PreMiddlewareFunction
          type: string
        path:
          type: string
          example: example_value
        raw_body_only:
          example: false
          type: boolean
        require_session:
          example: false
          type: boolean
      type: object
    TransformJQMeta:
      properties:
        filter:
          type: string
          example: example_value
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
      type: object
    ServiceDiscoveryConfiguration:
      properties:
        cache_disabled:
          type: boolean
          example: true
        cache_timeout:
          type: integer
          example: 10
        data_path:
          type: string
          example: example_value
        endpoint_returns_list:
          type: boolean
          example: true
        parent_data_path:
          type: string
          example: example_value
        port_data_path:
          type: string
          example: example_value
        query_endpoint:
          type: string
          example: example_value
        target_path:
          type: string
          example: example_value
        use_discovery_service:
          type: boolean
          example: true
        use_nested_query:
          type: boolean
          example: true
        use_target_list:
          type: boolean
          example: true
      type: object
    GlobalRateLimit:
      properties:
        disabled:
          type: boolean
          example: true
        per:
          type: number
          example: 42.5
        rate:
          type: number
          example: 42.5
      type: object
    UptimeTests:
      properties:
        check_list:
          items:
            $ref: '#/components/schemas/HostCheckObject'
          nullable: true
          type: array
          example: []
        config:
          $ref: '#/components/schemas/UptimeTestsConfig'
      type: object
    HostCheckObject:
      properties:
        body:
          type: string
          example: example_value
        commands:
          items:
            $ref: '#/components/schemas/CheckCommand'
          nullable: true
          type: array
          example: []
        enable_proxy_protocol:
          type: boolean
          example: true
        headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        method:
          type: string
          example: example_value
        protocol:
          type: string
          example: example_value
        timeout:
          type: integer
          example: 10
        url:
          type: string
          example: https://www.example.com
      type: object
    Provider:
      properties:
        introspection:
          $ref: '#/components/schemas/Introspection'
        jwt:
          $ref: '#/components/schemas/JWTValidation'
      type: object
    Scopes:
      properties:
        jwt:
          $ref: '#/components/schemas/ScopeClaim'
        oidc:
          $ref: '#/components/schemas/ScopeClaim'
      type: object
    SessionProviderMeta:
      properties:
        meta:
          additionalProperties: {}
          nullable: true
          type: object
          example: example_value
        name:
          type: string
          example: Example Title
        storage_engine:
          type: string
          example: example_value
      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
          nullable: true
          type: object
          example: example_value
      type: object
    RequestSigningMeta:
      properties:
        algorithm:
          type: string
          example: example_value
        certificate_id:
          type: string
          example: '500123'
        header_list:
          items:
            type: string
          nullable: true
          type: array
          example: []
        is_enabled:
          type: boolean
          example: true
        key_id:
          type: string
          example: '500123'
        secret:
          type: string
          example: example_value
        signature_header:
          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
    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
          nullable: true
          type: string
          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'
          nullable: true
          type: array
          example: []
        version:
          enum:
          - ''''
          - '1'
          - '2'
          type: string
          example: ''''
      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
    CheckCommand:
      properties:
        message:
          type: string
          example: example_value
        name:
          type: string
          example: Example Title
      type: object
    GraphQLFieldConfig:
      properties:
        disable_default_mapping:
          type: boolean
          example: true
        field_name:
          type: string
          example: example_value
        path:
          items:
            type: string
          nullable: true
          type: array
          example: []
        type_name:
          type: string
          example: example_value
      type: object
    CacheOptions:
      properties:
        cache_all_safe_requests:
          example: false
          type: boolean
        cache_by_headers:
          items:
            type: string
          nullable: true
          type: array
          example: []
        cache_control_ttl_header:
          type: string
          example: example_value
        cache_response_codes:
          items:
            type: integer
          nullable: true
          type: array
          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
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      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
    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'
          nullable: true
          type: array
          example: []
      type: object
    DatasourceSourceConfig:
      properties:
        data_source_config:
          example: example_value
        kind:
          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: {}
          nullable: true
          type: object
          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
          nullable: true
          type: array
          example: []
        target_url:
          example: https://httpbin.org/
          type: string
        transport:
          properties:
            proxy_url:
              type: string
            ssl_ciphers:
              items:
                type: string
              nullable: true
              type: array
            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
    RoutingTrigger:
      properties:
        'on':
          enum:
          - all
          - any
          type: string
          example: all
        options:
          $ref: '#/components/schemas/RoutingTriggerOptions'
        rewrite_to:
          type: string
          example: example_value
      type: object
    GoPluginMeta:
      properties:
        disabled:
          type: boolean
          example: true
        func_name:
          type: string
          example: example_value
        method:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        plugin_path:
          type: string
          example: example_value
      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
    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
    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
    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
          nullable: true
          type: object
          example: example_value
      type: object
    VersionInfo:
      properties:
        expires:
          type: string
          example: example_value
        extended_paths:
          $ref: '#/components/schemas/ExtendedPathsSet'
        global_headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        global_headers_disabled:
          type: boolean
          example: true
        global_headers_remove:
          items:
            type: string
          nullable: true
          type: array
          example: []
        global_response_headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        global_response_headers_disabled:
          type: boolean
          example: true
        global_response_headers_remove:
          items:
            type: string
          nullable: true
          type: array
          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
              nullable: true
              type: array
            ignored:
              items:
                type: string
              nullable: true
              type: array
            white_list:
              items:
                type: string
              nullable: true
              type: array
          type: object
          example: example_value
        use_extended_paths:
          example: true
          type: boolean
      type: object
    GraphQLSubgraphEntity:
      properties:
        api_id:
          type: string
          example: '500123'
        headers:
          additionalProperties:
            type: string
          nullable: true
          type: object
          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
    VersionData:
      properties:
        default_version:
          type: string
          example: example_value
        not_versioned:
          type: boolean
          example: true
        versions:
          additionalProperties:
            $ref: '#/components/schemas/VersionInfo'
          nullable: true
          type: object
          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
    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
    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
    OpenIDOptions:
      properties:
        providers:
          items:
            $ref: '#/components/schemas/OIDProviderConfig'
          nullable: true
          type: array
          example: []
        segregate_by_client:
          type: boolean
          example: true
      type: object
    AuthProviderMeta:
      properties:
        meta:
          additionalProperties: {}
          nullable: true
          type: object
          example: example_value
        name:
          type: string
          example: Example Title
        storage_engine:
          type: string
          example: example_value
      type: object
    TraceResponse:
      properties:
        logs:
          example: '{"level":"warning","msg":"Legacy path detected! Upgrade to extended....'
          type: string
        message:
          example: ok
          type: string
        response:
          example: "====== Request ======\nGET / HTTP/1.1\r\nHost: httpbin.org\r\n\r\n\n====== Response..."
          type: string
      type: object
    GraphQLTypeFields:
      properties:
        fields:
          items:
            type: string
          nullable: true
          type: array
          example: []
        type:
          type: string
          example: example_value
      type: object
    OIDProviderConfig:
      properties:
        client_ids:
          additionalProperties:
            type: string
          nullable: true
          type: object
          example: example_value
        issuer:
          type: string
          example: example_value
      type: object
    ExternalOAuth:
      properties:
        enabled:
          type: boolean
          example: true
        providers:
          items:
            $ref: '#/components/schemas/Provider'
          nullable: true
          type: array
          example: []
      type: object
    TraceRequest:
      properties:
        request:
          $ref: '#/components/schemas/TraceHttpRequest'
        spec:
          $ref: '#/components/schemas/APIDefinition'
      type: object
    IntrospectionCache:
      properties:
        enabled:
          type: boolean
          example: true
        timeout:
          format: int64
          type: integer
          example: 10
      type: object
    PersistGraphQLMeta:
      properties:
        method:
          type: string
          example: example_value
        operation:
          type: string
          example: example_value
        path:
          type: string
          example: example_value
        variables:
          additionalProperties: {}
          nullable: true
          type: object
          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
    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
    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
    ResponseProcessor:
      properties:
        name:
          type: string
          example: Example Title
        options:
          example: example_value
      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'
          nullable: true
          type: array
          example: []
        post_key_auth:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          nullable: true
          type: array
          example: []
        pre:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          nullable: true
          type: array
          example: []
        response:
          items:
            $ref: '#/components/schemas/MiddlewareDefinition'
          nullable: true
          type: array
          example: []
      type: object
    DatasourceMappingConfiguration:
      properties:
        disabled:
          type: boolean
          example: true
        path:
          type: string
          example: example_value
      type: object
    GraphQLSubgraphConfig:
      properties:
        sdl:
          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
    ExtendedPathsSet:
      properties:
        advance_cache_config:
          items:
            $ref: '#/components/schemas/CacheMeta'
          type: array
          example: []
        black_list:
          items:
            $ref: '#/components/schemas/EndPointMeta'
          type: array
          example: []
        cache:
          items:
            type: string
          type: array
          example: []
        circuit_breakers:
          items:
            $ref: '#/components/schemas/CircuitBreakerMeta'
          type: array
          example: []
        do_not_track_endpoints:
          items:
            $ref: '#/components/schemas/TrackEndpointMeta'
          type: array
          example: []
        go_plugin:
          items:
            $ref: '#/components/schemas/GoPluginMeta'
          type: array
          example: []
        hard_timeouts:
          items:
            $ref: '#/components/schemas/HardTimeoutMeta'
          type: array
          example: []
        ignored:
          items:
            $ref: '#/components/schemas/EndPointMeta'
          type: array
          example: []
        internal:
          items:
            $ref: '#/components/schemas/InternalMeta'
          type: array
          example: []
        method_transforms:
          items:
            $ref: '#/components/schemas/MethodTransformMeta'
          type: array
          example: []
        mock_response:
          items:
            $ref: '#/components/schemas/MockResponseMeta'
          type: array
          example: []
        persist_graphql:
          items:
            $ref: '#/components/schemas/PersistGraphQLMeta'
          nullable: true
          type: array
          example: []
        rate_limit:
          items:
            $ref: '#/components/schemas/RateLimitMeta'
          nullable: true
          type: array
          example: []
        size_limits:
          items:
            $ref: '#/components/schemas/RequestSizeMeta'
          type: array
          example: []
        track_endpoints:
          items:
            $ref: '#/components/schemas/TrackEndpointMeta'
          type: array
          example: []
        transform:
          items:
            $ref: '#/components/schemas/TemplateMeta'
          type: array
          example: []
        transform_headers:
          items:
            $ref: '#/components/schemas/HeaderInjectionMeta'
          type: array
          example: []
        transform_jq:


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