Login 24/7 Support Community tyk.io

Tyk Self-Managed

Gateway & API Sharding

Tyk Gateway has a very powerful functionality that allows you to selectively choose which APIs are to be loaded on which Gateways.

Imagine the case where you have two sets of APIs, Internal & External. You want to prevent your Internal APIs from being accessed or visible outside your protected network. Well, sharding makes it extremely easy to configure your Tyk Gateways from the Dashboard.


1. Configure a Gateway as a shard

Setting up a gateway to be a shard, or a zone, is very easy. All you do is tell the node in the tyk.conf file what tags to respect and that it is segmented:

"db_app_conf_options": {
  "node_is_segmented": true,
  "tags": ["private-gw", "edge"]

Tags are always treated as OR conditions, so this node will pick up all APIs that are marked as private-gw or edge.


In order to expose more details about the Gateway to the Dashboard, you can now configure the edge_endpoints section in the tyk-analytics.conf, and the Dashboard UI will pick that up and present you a list of Gateways you can chose from when creating an API.

2. Tag an API for a shard using the Dashboard

To add an API Tag to a an API configuration in the Dashboard, Select Edit from your API options, and select the Advanced Options tab:

Advanced options tab location

Then scroll down to the Segment Tags section:

Segement tags section

In this section, set the tag name you want to apply, and click Add.

When you save the API, the tags will become immediately active, and if any Gateways are configured to only load tagged API Definitions then this configuration will only be loaded by the relevant Gateway.

Exposed Gateway tags to Dashboard UI

From version 3.2.2 of the Tyk Dashboard, if edge_endpoints are being configured in tyk-analytics.conf, your Dashboard will automatically pick that list up for you, and display it in the UI when you create your API.

List of available Gateways

Once you select one or more Gateways, the Segment Tags section will be automatically prefilled with the tag values from the edge_endpoints configuration.

List of segment tags

Also, for every Gateway selected, there will be an API URL presented at the top of the page, within the Core Settings tab.

List of API URLs

Target an API Definition via JSON

In your API definition, add a tags section to the root of the API Definition:

"tags": ["private-gw"]

This will also set the tags for the API and when API requests are made through this Gateway, these tags will be transferred in to the analytics data set.

API Tagging with On-Premises

API Sharding with On-Premises is very flexible, but it behaves a little differently to sharding with Tyk Multi-Cloud. The key difference is that with Tyk Multi-Cloud you can have multiple isolated environments with their own databases all sharing the same configurations and keys by setting the group_id option in the Gateway slave options, but with Tyk On-Premises the zoning is limited to tags only, and must share a single Redis database.

To isolate On-Premises installations across data centers you will need to use our Multi Data Center Bridge component. This system powers the functionality of Tyk Multi-Cloud in our cloud and is available to our Enterprise customers as an add-on.