Request Termination

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

• Returning a fixed response for a health check or status endpoint that requires no backend logic.
• Retiring a deprecated endpoint with an informative error response.
• Returning a maintenance message while an upstream service is offline.
• Implementing complex response logic or aggregation that would otherwise require a dedicated microservice.

​

Approaches

​

Mock Response

​

How It Works

• Tyk OAS: the mock response fires near the end of the request-processing chain, after authentication, rate limiting, and request transforms. The request is fully authenticated before the response is generated. Analytics records are created as normal.
• Tyk Classic: the mock response fires at the start of the request-processing chain, before authentication. Credentials are not required to receive the response, and no analytics records are created.

​

Configuration

​

Tyk OAS

"operations": {
  "getBooksHealth": {
    "mockResponse": {
      "enabled": true,
      "code": 200,
      "body": "{\"status\": \"ok\"}",
      "headers": [
        { "name": "Content-Type", "value": "application/json" }
      ]
    }
  }
}

• example - a single sample value for a specific content type and response code
• examples - a named map of sample values; use exampleName in fromOASExamples to select one, or leave exampleName unset to use the first entry (sorted by key).
• schema - a JSON schema for the response body; Tyk uses any example values on individual schema properties, and falls back to type defaults ("string", 0, true) for properties with no example.

"operations": {
  "anythingget": {
    "mockResponse": {
      "enabled": true,
      "fromOASExamples": {
        "enabled": true,
        "code": 200,
        "contentType": "text/plain",
        "exampleName": "preview-example"
      }
    }
  }
}

1. Add an endpoint - From the API Designer, add an endpoint for the path and method to configure.
2. Select the Mock Response middleware - Select ADD MIDDLEWARE and choose Mock Response.
3. Configure the response:
   • To provide the response directly, select Manually configure mock response and set the HTTP status code, content type, response body, and any headers.
   • To generate from the OpenAPI description, select Use mock response from Open API Specification and choose the desired response code and content type from the drop-down.
4. Save the API - Select UPDATE MIDDLEWARE, then SAVE API.

​

Tyk Classic

"extended_paths": {
  "white_list": [
    {
      "path": "/health",
      "method": "",
      "ignore_case": false,
      "method_actions": {
        "GET": {
          "action": "reply",
          "code": 200,
          "data": "{\"status\": \"ok\"}",
          "headers": {
            "Content-Type": "application/json"
          }
        }
      }
    }
  ]
}

1. Add an endpoint - From the Endpoint Designer, add an endpoint and select the Allow List (or Block List / Ignore Authentication) plugin to register the path.
2. Add the mock response plugin - Select the Mock response plugin on the same endpoint.
3. Configure the response - Set the HTTP status code, headers, and body. Select ADD to add each header.
4. Save the API - Select Save or Create.

​

Tyk Operator

​

Response Selection

• X-Tyk-Accept-Example-Code selects the response object.
• Accept selects the media type within that response.
• X-Tyk-Accept-Example-Name selects a named entry within the media type’s examples map.

​

Defaults

• Response code - the value of fromOASExamples.code, defaulting to 200 if not set.
• Content type - the value of fromOASExamples.contentType, defaulting to application/json if not set.
• Example name - the value of fromOASExamples.exampleName, if set. If not set, no name is used and selection falls through to the priority order below.

​

Selection Priority

1. Direct example value - if the media type declares a single example value (not an examples map), that value is returned. The X-Tyk-Accept-Example-Name header and fromOASExamples.exampleName are both ignored in this case.
2. Named entry from examples - if an example name is set (via fromOASExamples.exampleName or the X-Tyk-Accept-Example-Name header), Tyk looks up that name in the media type’s examples map. If the name is not found, Tyk returns HTTP 404.
3. First entry alphabetically from examples - if no example name is set and the media type has an examples map, Tyk sorts the keys alphabetically and returns the first non-nil entry. This selection is deterministic from Tyk Gateway 5.8 onwards. In earlier versions, Tyk iterated directly over the map and the selection was non-deterministic.
4. Schema-derived example - if no example or examples values are present, Tyk generates a body from the media type’s JSON schema, using any example values on individual properties and falling back to type defaults ("string", 0, true) for properties with no example.

​

Error Responses

​

Virtual Endpoint

​

Custom Plugins

• Go Plugins
• Rich Plugins (gRPC, Python, Lua)
• Plugin Types

​

Worked Example

"operations": {
  "getLegacyBookDownload": {
    "mockResponse": {
      "enabled": true,
      "code": 410,
      "body": "This endpoint has been retired. Download books using GET /books/{category}/{id}?download=true with a valid subscriber token.",
      "headers": [
        { "name": "Content-Type", "value": "text/plain" },
        { "name": "Deprecation", "value": "true" }
      ]
    }
  }
}

"extended_paths": {
  "white_list": [
    {
      "path": "/{category}/{id}/download",
      "method": "",
      "ignore_case": false,
      "method_actions": {
        "GET": {
          "action": "reply",
          "code": 410,
          "data": "This endpoint has been retired. Download books using GET /books/{category}/{id}?download=true with a valid subscriber token.",
          "headers": {
            "Content-Type": "text/plain",
            "Deprecation": "true"
          }
        }
      }
    }
  ]
}