Qodex.ai

Tyk Gateway API v3.2.1

Number of APIs: 33

The Tyk Gateway 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.

See Tyk Docs for full Tyk documentation.

Warning: Under no circumstances should outside parties be granted access to this API.

The Tyk Gateway API is capable of:

  • Managing session objects (key generation)
  • 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 Gateway 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 Gateway API Request in order for it to be successful:

x-tyk-authorization:

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

  1. tyk-apis-{api ID} - get Api GET {{baseUrl}}/tyk/apis/:apiID

  2. tyk-apis-{api ID} - update Api PUT {{baseUrl}}/tyk/apis/:apiID

  3. tyk-apis-{api ID} - delete Api DELETE {{baseUrl}}/tyk/apis/:apiID

  4. tyk-apis - list Apis GET {{baseUrl}}/tyk/apis

  5. tyk-reload - Hot-reload a single node GET {{baseUrl}}/tyk/reload/?block=true

  6. tyk-oauth-clients-{api ID}-{key Name} - Get OAuth client GET {{baseUrl}}/tyk/oauth/clients/:apiID/:keyName

  7. tyk-reload - Hot-reload a Tyk group GET {{baseUrl}}/tyk/reload/group

  8. tyk-keys-{key ID} - Get a Key GET {{baseUrl}}/tyk/keys/:keyID

  9. tyk-keys-{key ID} - Update Key PUT {{baseUrl}}/tyk/keys/:keyID?suppress_reset=1

  10. tyk-keys-{key ID} - Create Custom Key / Import Key POST {{baseUrl}}/tyk/keys/:keyID?suppress_reset=1