Skip to main content
The Tyk Dashboard API manages the APIs, Policies, keys, users and organisations that Tyk Dashboard stores. Tyk Dashboard sends these changes to your Tyk Gateways.
If you use Tyk Dashboard, use only the Tyk Dashboard API. Do not call the Tyk Gateway API directly. Tyk Dashboard manages your Tyk Gateways.

​
Authentication

Send your Tyk Dashboard API Access Credentials in the authorization header of each request:
To find your credentials, open your user profile in Tyk Dashboard. For more information, see Manage Tyk Dashboard Users.

​
Access control

Each key, API and user belongs to an organisation. A user can manage only the resources of their own organisation. You can give each user Read, Write or Deny access to each section of the Tyk Dashboard API. For more information, see User permissions. The availability of role-based access control (RBAC) depends on your licence.

​
Pagination

Some list endpoints return results in pages. Use the p query parameter to select a page:
  • p=1 returns the first page. This is the default.
  • p=0 returns all items. If there are many items, this request can decrease the performance of Tyk Dashboard.
The default page size is 10. To change it, set page_size in tyk_analytics.conf. A larger page size can decrease the performance of Tyk Dashboard.
The response includes the number of pages in the pages field:

​
GraphQL API

Tyk Dashboard also has a GraphQL API. Tyk Dashboard uses it for keys.