1. Home
  2. Tyk Dashboard v1.x
  3. Endpoint Designer & Plugins

Endpoint Designer & Plugins

Tyk Endpoint Designer

The endpoint designer is a powerful and versatile way for you to add specific behaviours to your API. By Default, Tyk will proxy all traffic through the listen path that you have defined.

In the case that you want to have specific behaviours applied to a path (for example, header injection), then you can enable the middleware on a path-by-path basis by using matching patterns in the endpoint designer.

Note: you do not need to define your whole API in the editor, only those paths you want to manage. The exception to this is if you are using a white-list, in which case you will need to specify every endpoint as all others will be blocked.

By default, importing an API using Swagger or API Blueprint definitions will generate a white-list.

To get started, click the “Add Endpoint” button, this will give you an empty path definition:

In a new path definition, you can set multiple options, and if you do not specify a specific action for that list (from the plugins drop-down), then saving the path will actually do nothing (and it will vanish).

The options here are:

  • Method: The method you are targeting, can be any valid HTTP method, simply pick one from the drop-down menu
  • Path: The path to target – it is important to exclude aberrant slashes (/) from your path matching, as otherwise the gateway may not match the path correctly. A path can contain wild cards, such as {id}, the actual value in the wildcard is not used (it is translated into a regex), however it is useful to make the path more human readable when editing.
  • Plugin: A path can belong to multiple plug-ins, these plug-ins define the behaviour you want to impose on the matched request. There are many plug-ins, we’ve outlined them in this section, and would suggest looking at the detailed documentation in the main Tyk API Gateway Documentation for detailed information on how these plug-ins function.

Global Settings

In some cases you will want to set global settings that happen to all paths that are managed by Tyk, the “Global Version Settings” section will enable you to perform a common API management task of injecting custom headers into request data.

These headers can also include meta-data that is part of the session object to better qualify the inbound request


At the top of the endpoint designer you can see which version you are currently editing. If you have more than one option, selecting it from the drop-down will load it’s endpoint configuration into the editor.