Tyk

Tyk Config API

The Config API from Tyk — 1 operation(s) for config.

GitHub OpenAPI

Operations 1

GET /config Tyk Retrieve Current Configuration Status #

Documentation

📖
Documentation
https://tyk.io/docs/tyk-apis/
📖
Documentation
https://tyk.io/docs/tyk-dashboard-api
📖
Documentation
https://tyk.io/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/openapi/tyk-config-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/TykTechnologies/tyk
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-analytics
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-sink

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-schema/tyk-gateway-access-definition-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-gateway-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/graphql/tyk-graphql.md
🔗
ChangeLog
https://tyk.io/docs/developer-support/release-notes/dashboard
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-mdcb-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tyk-config-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tyk-config-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@tyk.io
    name: Tyk Technologies
    url: https://tyk.io/contact
  version: 1.0.0
  title: Tyk MDCB Data Planes and Diagnostics Config API
  description: 'This API provides operations for monitoring Data Planes connected to MDCB and accessing diagnostic data.  It includes endpoints for retrieving connected data plane details, performing health checks,  and accessing Go''s built-in pprof diagnostics for advanced performance profiling.

    '
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: localhost:8181
      description: Your MDCB host
security:
- api_key: []
tags:
- name: Config
paths:
  /config:
    get:
      summary: Tyk Retrieve Current Configuration Status
      description: 'Returns the current configuration status of the system.


        Example curl command:

        ```

        curl -X GET \

        http://localhost:8181/config \

        -H ''X-Tyk-Authorization: your-secret-key''

        ```

        '
      operationId: configGet
      parameters:
      - in: header
        name: X-Tyk-Authorization
        description: Secret value set in sink.conf
        required: true
        schema:
          type: string
        example: your-secret-key
      responses:
        '200':
          description: Successful retrieval of the current configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigStatus'
        '401':
          description: Forbidden access due to invalid or missing administrative key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Config
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          example: Attempted administrative access with invalid or missing key!
    ConfigStatus:
      type: object
      properties:
        listen_port:
          type: integer
          example: 9090
        healthcheck_port:
          type: integer
          example: 8180
        http_port:
          type: integer
          example: 8180
        enable_http_profiler:
          type: boolean
          example: false
        server_options:
          type: object
          properties:
            use_ssl:
              type: boolean
              example: false
            certificate:
              type: object
              properties:
                cert_file:
                  type: string
                  example: ./server.crt
                key_file:
                  type: string
                  example: ./server.key
            min_version:
              type: integer
              example: 0
            ssl_ciphers:
              type:
              - string
              - 'null'
            ssl_certificates:
              type:
              - string
              - 'null'
          example: example_value
        http_server_options:
          type: object
          properties:
            use_ssl:
              type: boolean
              example: false
            certificate:
              type: object
              properties:
                cert_file:
                  type: string
                  example: ''
                key_file:
                  type: string
                  example: ''
            min_version:
              type: integer
              example: 0
            ssl_ciphers:
              type:
              - string
              - 'null'
            ssl_certificates:
              type:
              - string
              - 'null'
          example: example_value
        security:
          type: object
          properties:
            private_certificate_encoding_secret:
              type: string
              example: ''
            enable_http_secure_endpoints:
              type: boolean
              example: true
            secret:
              type: string
              example: ''
          example: example_value
        storage:
          type: object
          properties:
            type:
              type: string
              example: redis
            host:
              type: string
              example: localhost
            port:
              type: integer
              example: 6379
            master_name:
              type: string
              example: ''
            sentinel_password:
              type: string
              example: ''
            username:
              type: string
              example: ''
            password:
              type: string
              example: ''
            database:
              type: integer
              example: 0
            optimisation_max_idle:
              type: integer
              example: 0
            optimisation_max_active:
              type: integer
              example: 0
            enable_cluster:
              type: boolean
              example: false
            hosts:
              type:
              - string
              - 'null'
            addrs:
              type:
              - string
              - 'null'
            redis_use_ssl:
              type: boolean
              example: false
            redis_ssl_insecure_skip_verify:
              type: boolean
              example: false
            debug:
              type: boolean
              example: false
            timeout:
              type: integer
              example: 0
            use_ssl:
              type: boolean
              example: false
            ssl_insecure_skip_verify:
              type: boolean
              example: false
            ca_file:
              type: string
              example: ''
            cert_file:
              type: string
              example: ''
            key_file:
              type: string
              example: ''
            max_version:
              type: string
              example: ''
            min_version:
              type: string
              example: ''
          example: example_value
        analytics:
          type: object
          properties:
            type:
              type: string
              example: mongo
            connection_string:
              type: string
              example: ''
            table_sharding:
              type: boolean
              example: false
            batch_size:
              type: integer
              example: 0
            postgres:
              type: object
              properties:
                prefer_simple_protocol:
                  type: boolean
                  example: false
            mysql:
              type: object
              properties:
                default_string_size:
                  type: integer
                  example: 0
                disable_datetime_precision:
                  type: boolean
                  example: false
                dont_support_rename_index:
                  type: boolean
                  example: false
                dont_support_rename_column:
                  type: boolean
                  example: false
                skip_initialize_with_version:
                  type: boolean
                  example: false
            mongo_url:
              type: string
              example: ''
            mongo_use_ssl:
              type: boolean
              example: false
            mongo_ssl_insecure_skip_verify:
              type: boolean
              example: false
            mongo_ssl_allow_invalid_hostnames:
              type: boolean
              example: false
            mongo_ssl_ca_file:
              type: string
              example: ''
            mongo_ssl_pem_keyfile:
              type: string
              example: ''
            mongo_session_consistency:
              type: string
              example: ''
            mongo_batch_size:
              type: integer
              example: 0
            driver:
              type: string
              example: mongo-go
            mongo_direct_connection:
              type: boolean
              example: false
          example: example_value
        hash_keys:
          type: boolean
          example: true
        session_timeout:
          type: integer
          example: 0
        forward_analytics_to_pump:
          type: boolean
          example: false
        enable_multiple_analytics_keys:
          type: boolean
          example: false
        dont_store_selective:
          type: boolean
          example: false
        dont_store_aggregate:
          type: boolean
          example: false
        org_session_expiration:
          type: integer
          example: 60
        org_session_cleanup:
          type: integer
          example: 60
        license:
          type: string
          example: ''
        aggregates_ignore_tags:
          type:
          - string
          - 'null'
          example: example_value
        track_all_paths:
          type: boolean
          example: false
        store_analytics_per_minute:
          type: boolean
          example: false
        ignore_tag_prefix_list:
          type:
          - string
          - 'null'
          example: example_value
        threshold_len_tag_list:
          type: integer
          example: 1000
        omit_analytics_index_creation:
          type: boolean
          example: false
        enable_separate_analytics_store:
          type: boolean
          example: false
        analytics_storage:
          type: object
          properties:
            type:
              type: string
              example: ''
            host:
              type: string
              example: ''
            port:
              type: integer
              example: 0
            master_name:
              type: string
              example: ''
            sentinel_password:
              type: string
              example: ''
            username:
              type: string
              example: ''
            password:
              type: string
              example: ''
            database:
              type: integer
              example: 0
            optimisation_max_idle:
              type: integer
              example: 0
            optimisation_max_active:
              type: integer
              example: 0
            enable_cluster:
              type: boolean
              example: false
            hosts:
              type:
              - string
              - 'null'
            addrs:
              type:
              - string
              - 'null'
            redis_use_ssl:
              type: boolean
              example: false
            redis_ssl_insecure_skip_verify:
              type: boolean
              example: false
            debug:
              type: boolean
              example: false
            timeout:
              type: integer
              example: 0
            use_ssl:
              type: boolean
              example: false
            ssl_insecure_skip_verify:
              type: boolean
              example: false
            ca_file:
              type: string
              example: ''
            cert_file:
              type: string
              example: ''
            key_file:
              type: string
              example: ''
            max_version:
              type: string
              example: ''
            min_version:
              type: string
              example: ''
          example: example_value
        log_level:
          type: string
          example: info
        enable_key_logging:
          type: boolean
          example: false
        sync_worker_config:
          type: object
          properties:
            enabled:
              type: boolean
              example: true
            hash_keys:
              type: boolean
              example: true
            max_batch_size:
              type: integer
              example: 1000
            time_between_batches:
              type: integer
              example: 3
            max_workers:
              type: integer
              example: 1000
            warmup_time:
              type: integer
              example: 0
            group_key_ttl:
              type: integer
              example: 30
          example: example_value
        enable_ownership:
          type: boolean
          example: false
  securitySchemes:
    api_key:
      in: header
      name: X-Tyk-Authorization
      type: apiKey