/tyk/apis and /api/apis listings. This page documents every endpoint in both APIs: their parameters, request and response shapes, validation behaviour, and the differences between the two interfaces.
For the full OpenAPI specifications of the Gateway API and Dashboard API, see Tyk APIs.
Tyk Gateway API extensions
The Tyk Gateway API is the admin interface exposed directly by Tyk Gateway. MCP management endpoints are accessible at/tyk/mcps and require the gateway’s admin secret in the X-Tyk-Authorization header.
Changes made via the Gateway API take effect only after a gateway reload. The MCP endpoints write the proxy definition to disk and return immediately; they do not trigger an automatic reload.
Authentication: X-Tyk-Authorization: {gateway-secret}
Base URL: {gateway-host} (typically http://localhost:8080)
List MCP proxies
Returns all MCP OAS definitions loaded on this gateway instance. Standard Tyk OAS APIs are excluded from this response.
Response:
200 OK
Get an MCP proxy
Returns the full Tyk OAS API definition for a single MCP proxy.
Path parameters
Response headers
Response:
200 OK
Create an MCP proxy
Creates a new MCP proxy from a Tyk OAS API definition. The request body must be a valid OpenAPI 3.0.3 document containing anx-tyk-api-gateway extension.
Query parameters
Request body: Minimum viable MCP proxy definition
id is provided in x-tyk-api-gateway.info, the gateway generates one.
Response: 200 OK
Update an MCP proxy
Replaces the definition of an existing MCP proxy in full. Partial updates are not supported; provide the complete Tyk OAS API definition in the request body.
The
x-tyk-api-gateway.info.id field in the request body must match the {apiID} path parameter. A mismatch returns 400 Bad Request.
Response: 200 OK
Delete an MCP proxy
Removes an MCP proxy definition from the gateway.
If the deleted proxy is a versioned child, its entry is removed from the base proxy’s version map. If it is a base proxy with existing versions, those children remain but lose their parent reference.
Response:
200 OK
Hot reload
Changes made via the Gateway API are written to disk but are not applied to live traffic until the gateway reloads. After any create, update, or delete operation, issue a reload:X-Tyk-Authorization header.
Tyk Dashboard API extensions
The Tyk Dashboard API is the management interface exposed by Tyk Dashboard. It proxies operations to connected gateway instances and triggers reloads automatically, so you don’t need to issue a manual reload after Dashboard API operations. The Dashboard API accepts both JSON and YAML request bodies for create and update operations. Authentication: Dashboard user API key (retrieved from your user profile in the Dashboard) Base URL:{dashboard-host} (typically http://localhost:3000)
List MCP proxies
Returns all MCP proxies managed by this Dashboard instance, with pagination metadata.
Response:
200 OK
pages field contains the total number of pages available.
Get an MCP proxy
Returns the full Tyk OAS API definition for a single MCP proxy.
Response:
200 OK
Returns the full Tyk OAS API definition. See Get an MCP proxy: Gateway API for the response shape.
Error responses
Create an MCP proxy
Creates a new MCP proxy from a Tyk OAS API definition. The Dashboard API accepts both JSON and YAML.
Query parameters
Example request
200 OK
Update an MCP proxy
Replaces the definition of an existing MCP proxy in full.
Example request
200 OK
Delete an MCP proxy
Removes an MCP proxy and triggers a gateway reload.
Example request
200 OK
List versions of an MCP proxy
Returns all versioned children of a base MCP proxy.
The
{apiId} must refer to a base proxy, not a versioned child. Calling this endpoint on a child proxy returns 422 Unprocessable Entity.
Response: 200 OK
Get the MCP definition schema
Returns the JSON Schema that Tyk uses to validate MCP OAS definitions. Use this to validate definitions client-side before submitting them to the API.
Query parameters
Response:
200 OK
Returns a JSON Schema document describing the valid structure of a Tyk OAS MCP definition.
Policy API extensions
MCP policies are managed through the standard Tyk policy endpoints; there are no dedicated MCP policy routes. The existing endpoints accept and validate MCP-specific fields inside eachaccess_rights entry. Tyk validates that these fields are only used on policies whose access rights target MCP proxies.
For a conceptual explanation of what the policy fields do and how to configure access tiers, see MCP proxy policies.
Gateway API
Authentication:X-Tyk-Authorization: {gateway-secret}
Success responses
Dashboard API
Authentication:Authorization: {dashboard-api-key}
The Dashboard API triggers a gateway reload automatically on create, update, and delete. The Gateway API requires a manual reload via
/tyk/reload or /tyk/reload/group.
MCP-specific fields in access rights
The MCP-specific fields sit inside each entry in theaccess_rights object, alongside the standard limit and versions fields.
mcp_primitives entry
mcp_access_rights object
json_rpc_methods entry
json_rpc_methods_access_rights object
Example policy request
The following creates a policy that restricts a consumer to read-only JSON-RPC methods, limits them to two specific tools, and applies a per-primitive rate limit:Policy validation for MCP
When a policy is created or updated, Tyk validates the MCP-specific fields:- MCP fields on non-MCP APIs: if
mcp_primitives,mcp_access_rights,json_rpc_methods, orjson_rpc_methods_access_rightsare set against an API ID that is not an MCP proxy, the request is rejected with400 Bad Request. - REST fields on MCP proxies: fields specific to REST APIs (
allowed_urls,endpoints,field_access_rights) are rejected when set against an MCP proxy ID. - Primitive type values: the
typefield in eachmcp_primitivesentry must betool,resource, orprompt. Any other value is rejected.
MCP proxy isolation
MCP proxies are managed separately from standard Tyk OAS APIs throughout the API surface:GET /tyk/apisandGET /api/apisdo not include MCP proxies in their responses.GET /tyk/mcpsandGET /api/mcpsonly return MCP proxies; standard OAS APIs do not appear.- Create and update operations on
/tyk/mcpsor/api/mcpsreject definitions that are not valid MCP proxies. - Get and delete operations on
/tyk/mcps/{id}or/api/mcps/{id}return404or400if the API ID refers to a non-MCP definition.
Validation
Both APIs apply the same validation rules when creating or updating an MCP proxy.Required structure
Every MCP proxy definition must be a valid OpenAPI 3.0.3 document containing anx-tyk-api-gateway vendor extension at the root level. Definitions without this extension are rejected with 400 Bad Request.
MCP schema validation
The definition is validated against Tyk’s MCP JSON schema. This schema enforces the structure of thex-tyk-api-gateway extension for MCP proxies (including the mcpTools, mcpResources, and mcpPrompts middleware maps) before any further processing.
Authentication metadata
Ifx-tyk-api-gateway.server.authentication.securitySchemes[name].oauth2.protectedResourceMetadata is present and enabled, Tyk validates the PRM configuration. For MCP proxies specifically, at least one entry in authorizationServers is required.
Middleware restrictions
Some middleware options are silently ignored when configured on MCP primitives (entries inmcpTools, mcpResources, or mcpPrompts). The schema accepts these fields for forward compatibility, but Tyk does not apply them at runtime:
Global middleware settings that are also not supported for MCP OAS definitions: