Introduction Ask Anything

Tyk Gateway API v5.0

{listen_path}-tyk-batch

Run batch request

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-revoke

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-authorize-client

Authorize client

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-cache-{apiID}

Invalidate cache

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-import

tyk-apis-oas-export

download Apis OAS Public

list Apis OAS create Api OAS

list Apis create Api

Tyk Gateway API v5.2

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Developer portal APIs v1.5.0

Organisations and teams-Teams

Orgs and teams/Get teams for an org Orgs and teams/Get a team by ID Orgs and teams/Create a team Orgs and teams/Update a team Orgs and teams/Delete a team

Organisations and teams-Organisations

Orgs and teams/Get all orgs Orgs and teams/Get an org by ID Orgs and teams/Create an org Orgs and teams/Update an org Orgs and teams/Delete an org

API Products and plans-Products

Products/Get all products Products/Get a product by ID Products/Update a product

API Products and plans-Plans

Plans/Get all plans Plans/Get a plan by ID Plans/Update a plan

API Products and plans-APIs included in API Products

Products/Get description of APIs included in an API Product Products/Update description of an API included in an API Product Copy Products/Attach OAS file to an API Products/Detach OAS file to an API Products/Get the OAS file attached to an API

Apps and credentials-Applications

Apps and credentials/Get all apps Apps and credentials/Get an app by ID Apps and credentials/Delete an application Apps and credentials/Create a new app Apps and credentials/Update an app

Apps and credentials-Credentials

Apps and credentials/Get all credentials for an app Apps and credentials/Get a credential by ID Apps and credentials/Delete a credential

Apps and credentials-Access requests

Apps and credentials/Get an access requests by ID Apps and credentials/Get access requests for an application Apps and credentials/Delete an access request Apps and credentials/Create a new access request Access requests/Get all access requests Access requests/Get an access requests by ID Access requests/Get developer for an access request Access requests/Get plan for an access request Access requests/Get application to which the access request belongs to

Apps and credentials-Approving and rejecting access requests

Access requests/Approve an access request Access requests/Reject an access request Access requests/Delete an access request

Users/Get all users Users/Create a new user Users/Get a user by ID Users/Delete a user Users/Update a user

Providers/Get all providers Providers/Get a providers by ID Providers/Delete a provider Providers/Update a provider configuration Providers/Synchronize a provider Providers/Create a new provider

Catalogues/Get all catalogues Catalogues/Get a catalogue by ID Catalogues/Create a new catalogue Catalogues/Update a catalogue Catalogues/Add a new audience to a catalogue Catalogues/Get all audience for a catalogue Catalogues/Remove an audience from a catalogue Catalogues/Get an audience for a catalogue by ID Catalogues/Remove a catalogue

Page and content blocks-Pages

Pages/Get all pages Pages/Get a page by ID Pages/Create a new page Pages/Update a page Pages/Delete a page

Page and content blocks-Content blocks

Pages/Get content blocks for a page Pages/Get content block by ID Pages/Create a new content block for a page Pages/Update a content block Pages/Delete a content block

Get started tutorials for API Products

Products/Get tutorials for an API Product Products/Create a new tutorial page for an API Product Products/Get a tutorial page by ID Products/Update a tutorial page Products/Reorder tutorial pages Products/Delete a tutorial page

Infrastructure APIs

Bootstrap the portal Probes/Liveness probe Probes/Readiness probe Configuration/Get current configuration of the portal

Theme/Get all themes Theme/Upload a theme Theme/Get a themes by ID Theme/Apply theme Theme/Download a theme

Tyk Dashboard API 5.3.3 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Dashboard API v5.3 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Gateway API v4.1

tyk-apis-oas-{api ID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api download Api OAS Public

list Apis OAS create Api OAS download Apis OAS Public import OAS

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

List Certificates Add a certificate Delete Certificate

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{pol ID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients

Create new OAuth client

revoke token revoke all client's tokens Invalidate OAuth refresh token Authorize client

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Tyk Gateway Check the Health of the API get Schema

Run batch request

Tyk Gateway API v3.2.1

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-oauth-clients-create

Create new OAuth client Update OAuth metadata and Policy ID

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

List oAuth clients

tyk-oauth-authorize-client

Authorize client Update OAuth metadata

revoke token revoke all client's tokens Invalidate OAuth refresh token

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Gateway Check the Health of the API

Run batch request

Retrieve information of all the connected data plane nodes.

debug-pprof-profile

CPU Profiling data

debug-pprof-{profileType}

Retrieve information of all the connected data plane nodes.

Check system readiness status

Check liveness status

debug-pprof-profile

CPU Profiling data

debug-pprof-{profileType}

Retrieve current configuration status

Retrieve environment variables

Tyk Dashboard API v3.2.1

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token

Tyk Dashboard API v5.2

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

Tyk Dashboard API v5 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Tyk Gateway API v5.3.3 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.0

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Generate authentication token

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies-search

Search List of Policies

api-portal-policies

Get List of Policies Create Policy Definition

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

api-keys-{keyID}

Create custom key

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-search

Search List of APIs

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

Tyk Gateway API v5.1

{listen_path}-tyk-batch

Run batch request

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-revoke

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-authorize-client

Authorize client

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-cache-{apiID}

Invalidate cache

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-import

tyk-apis-oas-export

download Apis OAS Public

list Apis OAS create Api OAS

list Apis create Api

Tyk Dashboard API v4.1

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{id}

Patch a single OAS API by ID Delete a single OAS API by ID

import OAS download Api OAS Public

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token get Schema

Tyk Gateway API v4.3

tyk-apis-oas-{api ID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api download Api OAS Public

list Apis OAS create Api OAS download Apis OAS Public import OAS

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

List Certificates Add a certificate Delete Certificate

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{pol ID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients

Create new OAuth client

revoke token revoke all client's tokens Invalidate OAuth refresh token Authorize client

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Tyk Gateway Check the Health of the API get Schema

Run batch request

Tyk Gateway API v5 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.1

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Generate authentication token

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies-search

Search List of Policies

api-portal-policies

Get List of Policies Create Policy Definition

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

api-keys-{keyID}

Create custom key

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-data-graphs-data-sources-import

Import a new data source

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-search

Search List of APIs

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

Tyk Gateway API v5.4

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.5

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-dry-run

dry Run Api OAS

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-search

Retrieve user search results Retrieve user search results

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

api-certs-{certID}

Get certificate by ID.Delete certificate by ID.

api-certs-details

List certificates details.

List certificates.Create a certificate in Tyk Org cert store.

certs-dependencies-{certID}

Get certificate dependencies.Delete certificate dependencies.

Tyk Dashboard API v5.4

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-dry-run

dry Run Api OAS

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-search

Retrieve user search results Retrieve user search results

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Dashboard API v4.3

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{id}

Patch a single OAS API by ID Delete a single OAS API by ID

api-apis-oas-{api ID}

list OAS Api Versions download Api OAS Public

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token get Schema

Tyk Gateway API v5.3 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Enterprise Developer Portal Management API v1.8

access_requests-{access_request_id}-approve

Approve an access request

access_requests-{access_request_id}-reject

Reject an access request

access_requests-{access_request_id}

Delete an access request Get an access request's data

access_requests

List all access requests

apps-{app_id}-access-requests-{access-request_id}-credentials-{credential_id}

Delete a credential from an access request Get a credential by its ID

apps-{app_id}-access-requests-{access-request_id}-credentials

List credentials for an access request

apps-{app_id}-access-requests-{access-request_id}

Delete an access request Get an access request's data

apps-{app_id}-access-requests

List all access requests for this application

apps-{app_id}-provision

Create a new access request for this application

Delete an application Get an application's data Update an application

List all developer application that exist in the portal Create a new developer application

catalogues-{catalogue_id}-audiences-{audience_id}

Remove an audience from a catalog List all audiences for this catalogue

catalogues-{catalogue_id}-audiences

List audiences for this catalogue Add a new audience to this catalogue

catalogues-{catalogue_id}

Delete a catalogue Get a catalogue Update a catalogue

List all catalogues Create a new catalogue

Get the portal config

organisations-{organisation_id}-teams-{team_id}

Delete a team from an organisation Get teams for an organisation Update a team for an organisation

organisations-{organisation_id}-teams

List all teams for an organisation Create a new team for an organisation

organisations-{organisation_id}

Delete an organisation Get an organisation Update an organisation

List all developer organisations Create a new developer organisation

pages-{page_id}-content-blocks-{content-block_id}

Delete content blocks from this page Get a content block Update a content block

pages-{page_id}-content-blocks

List all content blocks which are displayed on this page Create a new content block for a page

pages-{page_id}

Delete a page Get a page Update a page

List all content pages Create a new content page

plans-{plan_id}

Get a plan Update a plan

products-{product_id}-api-details-{api-id}

Get description of an API Update description of an API

products-{product_id}-api-details-{api_id}-oas

Download OAS file of an API Update OAS file of an API Delete OAS file of an API

products-{product_id}-api-details

List all APIs included in this API Product

products-{product_id}-docs-{doc_id}

Delete a tutorial page from this API Product Get a tutorial page Update a tutorial page

products-{product_id}-docs-reorder

Change order of tutorial pages

products-{product_id}-docs

List all tutorials for this API Product Create a new tutorial page for this API Product

products-{product_id}-tags-{tag_name}

Delete a tag from this API Product Get a tag from this API Product

products-{product_id}-tags

List all tags for this API Product Attach a tag to this API Product

products-{product_id}-client_types-{client_type_id}

Detach a client type from this API Product Get a client type attached to this API Product

products-{product_id}-client_types

List all client types for this API Product Attach a client type to this API Product

products-{product_id}

Get a product Update a product

List all products

providers-{provider_id}-synchronize

Synchronize API Products and plans with an API Provider

providers-{provider_id}

Delete an API Provider Get an API Provider configuration Update Provider

List all API Providers Create a new API Provider

themes-{theme_id}-activate

Activate a theme

themes-{theme_id}-download

Download a theme

themes-{theme_id}

List all themes

users-{user_id}-custom-attributes-{custom-attribute_id}

Get a user custom attribute Update a user custom attribute Delete a custom attribute

users-{user_id}-custom-attributes

Get extended custom attributes for user

users-{user_id}

Delete a user Get a user Update a user

List all users Create a new user

extended_attributes-{extended_attribute_id}-custom-attributes-{custom_attribute_id}

Delete a custom attribute Get a custom attribute Update a custom attribute

extended_attributes-{extended_attribute_id}-custom-attributes

List all custom attributes for a particular extended model Create a new custom attribute

extended_attributes-{extended_attribute_id}-default-attributes-{default_attribute_id}

Get a default attribute Update default attribute

extended_attributes-{extended_attribute_id}-default-attributes

List all default attributes for a particular extended model

extended_attributes-{extended_attribute_id}

Get an extended model detail

extended_attributes

List all extended models

Tyk Gateway API v5.5

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Introduction Ask Anything

Tyk Gateway API v5.0

{listen_path}-tyk-batch

Run batch request

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-revoke

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-authorize-client

Authorize client

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-cache-{apiID}

Invalidate cache

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-import

tyk-apis-oas-export

download Apis OAS Public

list Apis OAS create Api OAS

list Apis create Api

Tyk Gateway API v5.2

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Developer portal APIs v1.5.0

Organisations and teams-Teams

Orgs and teams/Get teams for an org Orgs and teams/Get a team by ID Orgs and teams/Create a team Orgs and teams/Update a team Orgs and teams/Delete a team

Organisations and teams-Organisations

Orgs and teams/Get all orgs Orgs and teams/Get an org by ID Orgs and teams/Create an org Orgs and teams/Update an org Orgs and teams/Delete an org

API Products and plans-Products

Products/Get all products Products/Get a product by ID Products/Update a product

API Products and plans-Plans

Plans/Get all plans Plans/Get a plan by ID Plans/Update a plan

API Products and plans-APIs included in API Products

Products/Get description of APIs included in an API Product Products/Update description of an API included in an API Product Copy Products/Attach OAS file to an API Products/Detach OAS file to an API Products/Get the OAS file attached to an API

Apps and credentials-Applications

Apps and credentials/Get all apps Apps and credentials/Get an app by ID Apps and credentials/Delete an application Apps and credentials/Create a new app Apps and credentials/Update an app

Apps and credentials-Credentials

Apps and credentials/Get all credentials for an app Apps and credentials/Get a credential by ID Apps and credentials/Delete a credential

Apps and credentials-Access requests

Apps and credentials/Get an access requests by ID Apps and credentials/Get access requests for an application Apps and credentials/Delete an access request Apps and credentials/Create a new access request Access requests/Get all access requests Access requests/Get an access requests by ID Access requests/Get developer for an access request Access requests/Get plan for an access request Access requests/Get application to which the access request belongs to

Apps and credentials-Approving and rejecting access requests

Access requests/Approve an access request Access requests/Reject an access request Access requests/Delete an access request

Users/Get all users Users/Create a new user Users/Get a user by ID Users/Delete a user Users/Update a user

Providers/Get all providers Providers/Get a providers by ID Providers/Delete a provider Providers/Update a provider configuration Providers/Synchronize a provider Providers/Create a new provider

Catalogues/Get all catalogues Catalogues/Get a catalogue by ID Catalogues/Create a new catalogue Catalogues/Update a catalogue Catalogues/Add a new audience to a catalogue Catalogues/Get all audience for a catalogue Catalogues/Remove an audience from a catalogue Catalogues/Get an audience for a catalogue by ID Catalogues/Remove a catalogue

Page and content blocks-Pages

Pages/Get all pages Pages/Get a page by ID Pages/Create a new page Pages/Update a page Pages/Delete a page

Page and content blocks-Content blocks

Pages/Get content blocks for a page Pages/Get content block by ID Pages/Create a new content block for a page Pages/Update a content block Pages/Delete a content block

Get started tutorials for API Products

Products/Get tutorials for an API Product Products/Create a new tutorial page for an API Product Products/Get a tutorial page by ID Products/Update a tutorial page Products/Reorder tutorial pages Products/Delete a tutorial page

Infrastructure APIs

Bootstrap the portal Probes/Liveness probe Probes/Readiness probe Configuration/Get current configuration of the portal

Theme/Get all themes Theme/Upload a theme Theme/Get a themes by ID Theme/Apply theme Theme/Download a theme

Tyk Dashboard API 5.3.3 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Dashboard API v5.3 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Gateway API v4.1

tyk-apis-oas-{api ID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api download Api OAS Public

list Apis OAS create Api OAS download Apis OAS Public import OAS

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

List Certificates Add a certificate Delete Certificate

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{pol ID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients

Create new OAuth client

revoke token revoke all client's tokens Invalidate OAuth refresh token Authorize client

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Tyk Gateway Check the Health of the API get Schema

Run batch request

Tyk Gateway API v3.2.1

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-oauth-clients-create

Create new OAuth client Update OAuth metadata and Policy ID

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

List oAuth clients

tyk-oauth-authorize-client

Authorize client Update OAuth metadata

revoke token revoke all client's tokens Invalidate OAuth refresh token

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Gateway Check the Health of the API

Run batch request

Retrieve information of all the connected data plane nodes.

debug-pprof-profile

CPU Profiling data

debug-pprof-{profileType}

Retrieve information of all the connected data plane nodes.

Check system readiness status

Check liveness status

debug-pprof-profile

CPU Profiling data

debug-pprof-{profileType}

Retrieve current configuration status

Retrieve environment variables

Tyk Dashboard API v3.2.1

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token

Tyk Dashboard API v5.2

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

Tyk Dashboard API v5 LTS

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Tyk Gateway API v5.3.3 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.0

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Generate authentication token

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies-search

Search List of Policies

api-portal-policies

Get List of Policies Create Policy Definition

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

api-keys-{keyID}

Create custom key

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-search

Search List of APIs

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

Tyk Gateway API v5.1

{listen_path}-tyk-batch

Run batch request

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-revoke

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-authorize-client

Authorize client

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-cache-{apiID}

Invalidate cache

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-import

tyk-apis-oas-export

download Apis OAS Public

list Apis OAS create Api OAS

list Apis create Api

Tyk Dashboard API v4.1

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{id}

Patch a single OAS API by ID Delete a single OAS API by ID

import OAS download Api OAS Public

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token get Schema

Tyk Gateway API v4.3

tyk-apis-oas-{api ID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api download Api OAS Public

list Apis OAS create Api OAS download Apis OAS Public import OAS

tyk-apis-{api ID}

get Api update Api delete Api

list Apis create Api

Hot-reload a single node Hot-reload a Tyk group

List Certificates Add a certificate Delete Certificate

tyk-keys-{key ID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{pol ID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-{api ID}-{key Name}

Get OAuth client Delete OAuth client List tokens

tyk-oauth-clients-{api ID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-clients

Create new OAuth client

revoke token revoke all client's tokens Invalidate OAuth refresh token Authorize client

tyk-org/keys-{key ID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

Invalidate cache Check the Health of the Tyk Gateway Check the Health of the API get Schema

Run batch request

Tyk Gateway API v5 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.1

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

Generate authentication token

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies-search

Search List of Policies

api-portal-policies

Get List of Policies Create Policy Definition

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

api-keys-{keyID}

Create custom key

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-data-graphs-data-sources-import

Import a new data source

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-search

Search List of APIs

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

Tyk Gateway API v5.4

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Dashboard API v5.5

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-dry-run

dry Run Api OAS

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-search

Retrieve user search results Retrieve user search results

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

api-certs-{certID}

Get certificate by ID.Delete certificate by ID.

api-certs-details

List certificates details.

List certificates.Create a certificate in Tyk Org cert store.

certs-dependencies-{certID}

Get certificate dependencies.Delete certificate dependencies.

Tyk Dashboard API v5.4

api-portal-policies-search

Search List of Policies

api-portal-policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal-policies

Get List of Policies Create Policy Definition

api-apis-search

Search List of APIs

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-dry-run

dry Run Api OAS

api-apis-oas-{apiID}-categories

get Api Categories update Api Categories

api-apis-oas-{apiID}-versions

list OAS Api Versions

api-apis-oas-{apiID}-export

download Api OAS Public

api-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

api-apis-oas-import

api-apis-oas-export

download Apis OAS Public

api-apis-categories

get All Api Categories

api-apis-{apiID}-access

get Api Access Rights update Api Access Rights

api-apis-{apiID}-keys-{keyID}

Get key Update key Delete key

api-apis-{apiID}-keys

api-apis-keys-basic-{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition

api-activity-keys-{keyHash}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of API Key

api-activity-oauthid-{OAuthClientID}-{startDay}-{startMonth}-{startYear}-{EndDay}-{EndMonth}-{EndYear}

Analytics of Oauth Client ID

api-keys-{keyID}

Create custom key

api-org-permissions

List additional permissions Modify additional permissions

api-org-permission

Update OPA Rules

Generate authentication token

api-users-search

Retrieve user search results Retrieve user search results

api-users-{USER_ID}-actions-reset

Set User Password

api-users-{USER_ID}-actions-key-reset

Reset current Dashboard session for specified user Delete User

api-users-{USER_ID}

Get User Update User

List Users Add User

api-data-graphs-data-sources-import

Import a new data source

api-examples-{location}

Get details of a single example API definition

Get a list of example API definitions

api-system-stats

Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.

api-assets-{assetID}

Retrieve an asset.Update an asset by ID.Delete an asset by ID.

Retrieve list of assets Create an asset

Tyk Dashboard API v4.3

api-portal/policies-{id}

Get a single Policy by ID Update Policy Definition Delete a single Policy by ID

api-portal/policies

Get List of Policies Create Policy Definition Search List of Policies

Get a single API by ID Update API Definition Delete a single API by ID

api-apis-oas-{id}

Patch a single OAS API by ID Delete a single OAS API by ID

api-apis-oas-{api ID}

list OAS Api Versions download Api OAS Public

api-apis-{api ID}/keys-{key ID}

Get key Update key Delete key

api-apis-{api ID}/keys

api-apis-keys/basic/{username}

Create a Basic Auth User Update a Basic Auth User Get a Basic Auth User Delete a Basic Auth User

Get List of APIs Create API Definition Search List of APIs

Analytics of API Key Analytics of Oauth Client ID

Create a key Create custom key

api-org-permissions

List additional permissions Modify additional permissions

List OPA Rules Update OPA Rules

api-users-{USER ID}-actions-key/reset

Reset current Dashboard session for specified user Delete User

api-users-{USER ID}-actions

Set User Password

api-users-{USER ID}

Get User Update User

List Users Add User

Generate authentication token get Schema

Tyk Gateway API v5.3 LTS

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Tyk Enterprise Developer Portal Management API v1.8

access_requests-{access_request_id}-approve

Approve an access request

access_requests-{access_request_id}-reject

Reject an access request

access_requests-{access_request_id}

Delete an access request Get an access request's data

access_requests

List all access requests

apps-{app_id}-access-requests-{access-request_id}-credentials-{credential_id}

Delete a credential from an access request Get a credential by its ID

apps-{app_id}-access-requests-{access-request_id}-credentials

List credentials for an access request

apps-{app_id}-access-requests-{access-request_id}

Delete an access request Get an access request's data

apps-{app_id}-access-requests

List all access requests for this application

apps-{app_id}-provision

Create a new access request for this application

Delete an application Get an application's data Update an application

List all developer application that exist in the portal Create a new developer application

catalogues-{catalogue_id}-audiences-{audience_id}

Remove an audience from a catalog List all audiences for this catalogue

catalogues-{catalogue_id}-audiences

List audiences for this catalogue Add a new audience to this catalogue

catalogues-{catalogue_id}

Delete a catalogue Get a catalogue Update a catalogue

List all catalogues Create a new catalogue

Get the portal config

organisations-{organisation_id}-teams-{team_id}

Delete a team from an organisation Get teams for an organisation Update a team for an organisation

organisations-{organisation_id}-teams

List all teams for an organisation Create a new team for an organisation

organisations-{organisation_id}

Delete an organisation Get an organisation Update an organisation

List all developer organisations Create a new developer organisation

pages-{page_id}-content-blocks-{content-block_id}

Delete content blocks from this page Get a content block Update a content block

pages-{page_id}-content-blocks

List all content blocks which are displayed on this page Create a new content block for a page

pages-{page_id}

Delete a page Get a page Update a page

List all content pages Create a new content page

plans-{plan_id}

Get a plan Update a plan

products-{product_id}-api-details-{api-id}

Get description of an API Update description of an API

products-{product_id}-api-details-{api_id}-oas

Download OAS file of an API Update OAS file of an API Delete OAS file of an API

products-{product_id}-api-details

List all APIs included in this API Product

products-{product_id}-docs-{doc_id}

Delete a tutorial page from this API Product Get a tutorial page Update a tutorial page

products-{product_id}-docs-reorder

Change order of tutorial pages

products-{product_id}-docs

List all tutorials for this API Product Create a new tutorial page for this API Product

products-{product_id}-tags-{tag_name}

Delete a tag from this API Product Get a tag from this API Product

products-{product_id}-tags

List all tags for this API Product Attach a tag to this API Product

products-{product_id}-client_types-{client_type_id}

Detach a client type from this API Product Get a client type attached to this API Product

products-{product_id}-client_types

List all client types for this API Product Attach a client type to this API Product

products-{product_id}

Get a product Update a product

List all products

providers-{provider_id}-synchronize

Synchronize API Products and plans with an API Provider

providers-{provider_id}

Delete an API Provider Get an API Provider configuration Update Provider

List all API Providers Create a new API Provider

themes-{theme_id}-activate

Activate a theme

themes-{theme_id}-download

Download a theme

themes-{theme_id}

List all themes

users-{user_id}-custom-attributes-{custom-attribute_id}

Get a user custom attribute Update a user custom attribute Delete a custom attribute

users-{user_id}-custom-attributes

Get extended custom attributes for user

users-{user_id}

Delete a user Get a user Update a user

List all users Create a new user

extended_attributes-{extended_attribute_id}-custom-attributes-{custom_attribute_id}

Delete a custom attribute Get a custom attribute Update a custom attribute

extended_attributes-{extended_attribute_id}-custom-attributes

List all custom attributes for a particular extended model Create a new custom attribute

extended_attributes-{extended_attribute_id}-default-attributes-{default_attribute_id}

Get a default attribute Update default attribute

extended_attributes-{extended_attribute_id}-default-attributes

List all default attributes for a particular extended model

extended_attributes-{extended_attribute_id}

Get an extended model detail

extended_attributes

List all extended models

Tyk Gateway API v5.5

tyk-apis-oas-{apiID}-versions

list OAS Api Versions

tyk-apis-oas-{apiID}-export

download Api OAS Public

tyk-apis-oas-{apiID}

list Api OAS update Api OAS Patch a single OAS API by ID delete OAS Api

tyk-apis-oas-export

download Apis OAS Public

tyk-apis-oas-import

list Apis OAS create Api OAS

tyk-apis-{apiID}-versions

list Api Versions

tyk-apis-{apiID}

get Api update Api delete Api

list Apis create Api

tyk-cache-{apiID}

Invalidate cache

tyk-reload-group

Hot-reload a Tyk group

Hot-reload a single node

Check the Health of the Tyk Gateway

List Certificates Add a certificate Delete Certificate

tyk-keys-{keyID}

Get a Key Update Key Create Custom Key / Import Key Delete Key

List Keys Create a key

tyk-policies-{polID}

Get a Policy Update a Policy Delete a Policy

List Policies Create a Policy

tyk-oauth-clients-create

Create new OAuth client

tyk-oauth-clients-{apiID}-{keyName}-tokens

tyk-oauth-clients-{apiID}-{keyName}

Get OAuth client Delete OAuth client

tyk-oauth-clients-{apiID}

Update OAuth metadata and Policy ID List oAuth clients

tyk-oauth-revoke

tyk-oauth-revoke_all

revoke all client's tokens

tyk-oauth-refresh-{keyName}

Invalidate OAuth refresh token

tyk-oauth-authorize-client

Authorize client

tyk-org-keys-{keyID}

Get an Organisation Key Create an organisation key Update Organisation Key Delete Organisation Key

List Organisation Keys

{listen_path}-tyk-batch

Run batch request

Home Tyk Dashboard API v5.2api-apis-search

api-apis-search

Number of APIs: 1

Search List of APIs GET {{baseUrl}}/api/apis/search?q=<string>

Create Policy Definition

Search List of APIs