Qodex.ai

Tyk Gateway API v5.0

Number of APIs: 51

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.

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 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 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: <your-secret>

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

  1. tyk-policies - Create a Policy POST {{baseUrl}}/tyk/policies

  2. tyk-org-keys-{keyID} - Get an Organisation Key GET {{baseUrl}}/tyk/org/keys/:keyID

  3. {listen_path}-tyk-batch - Run batch request POST {{baseUrl}}/:listen_path/tyk/batch

  4. tyk-schema - get Schema GET {{baseUrl}}/tyk/schema?oasVersion=<string>

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

  6. tyk-policies-{polID} - Get a Policy GET {{baseUrl}}/tyk/policies/:polID

  7. tyk-oauth-clients-{apiID}-{keyName} - Get OAuth client GET {{baseUrl}}/tyk/oauth/clients/:apiID/:keyName

  8. tyk-policies-{polID} - Update a Policy PUT {{baseUrl}}/tyk/policies/:polID

  9. tyk-policies-{polID} - Delete a Policy DELETE {{baseUrl}}/tyk/policies/:polID

  10. tyk-policies - List Policies GET {{baseUrl}}/tyk/policies