Tyk v2.2 Documentation Components

HomeTyk v2.2 Documentation ComponentsConcept: Gateway API

Concept: Gateway API

The Tyk Gateway REST API is the primary means for integrating your application with the Tyk API Gateway system. This API is very small, and has no granular permissions system. It is intended to be used purely for internal automation and integration. Under no circumstances be access granted to this API to outside parties.

The Tyk Gateway API is capable of:

  • Managing session objects (token generation)
  • Managing and listing policies
  • Managing and listing API Definitions (only when not using the dashboard)
  • Hot reloads / reloading a cluster configuration
  • OAuth client creation (only when not using the dashboard)

In order to use the REST API, you’ll need to set the secret parameter in your tyk.conf file.

The shared secret you set should then be sent along as a header with each REST API Request in order for it to be successful:

x-tyk-authorization: 352d20ee67be67f6340b4c0605b044bc4

The Tyk Gateway API is subsumed by the Tyk dashboard API in Pro installations.

Was this article helpful to you? Yes No