Tyk Dashboard Admin API
Last updated: 0 minute read.
Tyk Dashboard Admin API 5.3.0
OAS 3.0
/docs/nightly/others/dashboard-admin-swagger.ymlFor Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line.
In order to use the Dashboard Admin API, you'll need to get the admin_secret value from your Tyk Dashboard configurations.
The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful:
admin-auth: <your-secret>
ExportTo make Tyk installations more portable, the Export API enables you to export key configuration objects required to back-up and re-deploy a basic Tyk Pro installation.
To make Tyk installations more portable, the Export API enables you to export key configuration objects required to back-up and re-deploy a basic Tyk Pro installation.
ImportThe import API enables you to add Organisations, APIs and Policies back into a Tyk installation while retaining their base IDs so that they work together.
The import API enables you to add Organisations, APIs and Policies back into a Tyk installation while retaining their base IDs so that they work together.
Single Sign OnThe Dashboard SSO API allows you to implement custom authentication schemes for the Dashboard and Portal. Our Tyk Identity Broker (TIB) internally also uses this API.
The Dashboard SSO API allows you to implement custom authentication schemes for the Dashboard and Portal. Our Tyk Identity Broker (TIB) internally also uses this API.
Dashboard URL ReloadSince the Dashboard can have multiple URLs associated with it. It is possible to force a URL reload by calling an API endpoint of the Dashboard API.
Since the Dashboard can have multiple URLs associated with it. It is possible to force a URL reload by calling an API endpoint of the Dashboard API.
OrganisationsThe organisations API gives the ability to manage your Tyk organisation(s).
The organisations API gives the ability to manage your Tyk organisation(s).
UsersThe admin portion of the users API gives you the ability to manage password reset policies for your Dashboard users.
The admin portion of the users API gives you the ability to manage password reset policies for your Dashboard users.