KrakenD

opencollection: 1.0.0
info:
  name: KrakenD Service API
  version: 2.9.0
items:
- info:
    name: Health
    type: folder
  items:
  - info:
      name: KrakenD Health check
      type: http
    http:
      method: GET
      url: http://localhost:8080/__health
    docs: Returns the health status of the KrakenD instance. Automatically available when KrakenD is running. Returns a 200
      status code when the gateway is healthy.
- info:
    name: Debug
    type: folder
  items:
  - info:
      name: KrakenD Debug endpoint
      type: http
    http:
      method: GET
      url: http://localhost:8080/__debug/:path
      params:
      - name: path
        value: ''
        type: path
        description: Any sub-path for debugging purposes.
    docs: Acts as a fake backend that echoes request details in the server logs at DEBUG level. Useful for inspecting the
      interaction between the gateway and backends. Must be enabled with the -d flag or debug_endpoint configuration option.
  - info:
      name: KrakenD Debug endpoint (POST)
      type: http
    http:
      method: POST
      url: http://localhost:8080/__debug/:path
      params:
      - name: path
        value: ''
        type: path
        description: Any sub-path for debugging purposes.
      body:
        type: json
        data: '{}'
    docs: POST variant of the debug endpoint. Echoes request body and headers in the server logs.
  - info:
      name: KrakenD Echo endpoint
      type: http
    http:
      method: GET
      url: http://localhost:8080/__echo/
    docs: Returns details about the incoming request, including headers and query parameters. Useful for testing and debugging.
      Must be enabled in the configuration.
- info:
    name: Metrics
    type: folder
  items:
  - info:
      name: KrakenD Extended metrics
      type: http
    http:
      method: GET
      url: http://localhost:8080/__stats/
    docs: Returns extended runtime metrics for the KrakenD instance including router, proxy, and backend statistics. This
      endpoint runs on a separate port (default 8090) and requires the telemetry/metrics extra_config to be enabled. Metrics
      are refreshed based on the configured collection_time interval.
bundled: true