# Tyk Documentation ## Docs - [Advanced Communication Protocols](https://tyk.io/docs/advanced-configuration/other-protocols.md): How to configure advanced communication protocols - [Server Sent Events Proxy](https://tyk.io/docs/advanced-configuration/sse-proxy.md): Describe how you can use Tyk as a simple Server Sent Events Proxy - [Looping](https://tyk.io/docs/advanced-configuration/transform-traffic/looping.md): Learn how to use looping in Tyk's URL Rewriting to redirect requests internally within the gateway for improved performance and flexibility. - [Transformation Use Case: SOAP To REST](https://tyk.io/docs/advanced-configuration/transform-traffic/soap-rest.md): How to transform SOAP API to REST API in Tyk - [Websockets](https://tyk.io/docs/advanced-configuration/websockets.md): How to use websockets in Tyk - [Manage Apps in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/admin-apps.md): How to manage user-created applications in Tyk AI Studio as a Studio Administrator. - [Tutorial: Create an AI CLI App with NodeJS and Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/ai-cli-app.md): Learn how to use your Tyk AI Studio App credentials to build a simple command-line interface (CLI) application with NodeJS. - [AI Portal in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/ai-portal.md): How AI Portal works? - [Create an App in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/ai-portal-app.md): How to create and manage your applications in Tyk AI Studio as an AI Developer. - [AI Studio (Control Plane) Component](https://tyk.io/docs/ai-management/ai-studio/ai-studio.md): Overview of the AI Studio component in Tyk AI Studio's architecture, its features, and its role in the hub-and-spoke design - [Tyk AI Studio Environment Variables](https://tyk.io/docs/ai-management/ai-studio/ai-studio-env.md): Environment variables and configuration options for Tyk AI Studio. - [Tyk AI Studio API](https://tyk.io/docs/ai-management/ai-studio/ai-studio-swagger.md): Tyk AI Studio API - [AI Studio User Personas](https://tyk.io/docs/ai-management/ai-studio/ai-studio-user.md): Overview of the user personas in Tyk AI Studio: Technical and Non-technical users. - [Analytics & Monitoring in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/analytics.md): How to configure analytics in Tyk AI Studio? - [Tyk AI Studio Architecture](https://tyk.io/docs/ai-management/ai-studio/architecture.md): Overview of Tyk AI Studio's architecture, components, and design principles - [Budget Control in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/budgeting.md): How to configure budgets in Tyk AI Studio? - [Manage LLM Call Settings in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/call-settings.md): How to configure default call settings for Large Language Models (LLMs) in Tyk AI Studio, including parameters like temperature, max tokens, and more. - [Catalogs in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/catalogs.md): How to manage catalogs in AI Studio? - [Chat Interface](https://tyk.io/docs/ai-management/ai-studio/chat-interface.md): How AI Studios Chat Interface works? - [Manage Chats in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/chats.md): Chats are customized interfaces that allow users to have one-on-one conversations with specific LLM providers, tools, and data source based on their needs. Access is tailored to the user's group, ensuring relevant and secure interactions. - [Getting Started with Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/configuration.md): In this guide, we will walk through the initial configuration steps after deploying Tyk AI Studio, including logging in, connecting an LLM provider, and starting your first chat. - [What is AI Studio?](https://tyk.io/docs/ai-management/ai-studio/core-concepts.md): Introduction to Tyk AI Studio, comprehensive AI management platform - [Manage Data Sources in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/datasources-rag.md): Learn how to configure and manage Data Sources in Tyk AI Studio to enable Retrieval-Augmented Generation (RAG), connecting LLMs to external knowledge bases and vector stores. - [Install Tyk AI Studio on Kubernetes](https://tyk.io/docs/ai-management/ai-studio/deployment-k8s.md): Installation guide for the Tyk AI Studio on Kubernetes - [Tyk Edge Gateway Environment Variables](https://tyk.io/docs/ai-management/ai-studio/edge-gateway-env.md): Environment variables and configuration options for Tyk Edge Gateway. - [Filters and Middleware](https://tyk.io/docs/ai-management/ai-studio/filters.md): How to use Filters and Middleware in Tyk AI Studio? - [Install Tyk AI Studio on Linux](https://tyk.io/docs/ai-management/ai-studio/installation/linux.md): Installation guide for the Tyk AI Studio on Linux - [NATS JetStream Configuration for Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/installation/nats.md): How to configure NATS JetStream as the message queue backend for Tyk AI Studio? - [Installation Options for Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/installation/overview.md): Explore the different installation options for Tyk AI Studio, including Docker, Kubernetes, and Linux. - [LLM Management](https://tyk.io/docs/ai-management/ai-studio/llm-management.md): How to manage Large Language Models (LLMs) in Tyk AI Studio, including configuration, pricing, and budgeting. - [Manage Edge Gateway for Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/manage-edge-gateway.md): Understand how to manage and monitor Edge Gateways in Tyk AI Studio, including configuration synchronization and admin actions. - [Model Prices Management in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/model-prices.md): How to manage Large Language Model (LLM) pricing in Tyk AI Studio, including setting costs for input/output tokens and cache usage. - [Tyk AI Studio Model Router](https://tyk.io/docs/ai-management/ai-studio/model-router.md): Overview of Tyk AI Studio's model routing capabilities - [Notification in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/notifications.md): How to configure notifications in Tyk AI Studio? - [Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/overview.md): AI Management for Platform Teams with Tyk AI Studio, a comprehensive platform for managing and deploying AI LLMs and chats - [Tyk AI Studio Plugin Best Practices](https://tyk.io/docs/ai-management/ai-studio/plugins/best-practices.md): Production-ready patterns, performance optimization, and security guidelines for Tyk AI Studio plugins using the Unified Plugin SDK. - [Tyk AI Studio Custom Endpoint Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/custom-endpoints.md): Learn how to register and serve arbitrary HTTP endpoints on the Edge Gateway using Custom Endpoint plugins for use cases like OAuth providers and webhooks. - [Tyk AI Studio Plugin Deployment Options](https://tyk.io/docs/ai-management/ai-studio/plugins/deployment.md): Explore the three plugin deployment methods supported by Tyk AI Studio: local filesystem, remote gRPC, and OCI registry. - [Tyk AI Studio Plugin Development Workflow](https://tyk.io/docs/ai-management/ai-studio/plugins/development-workflow.md): A guide to develop and test Tyk AI Studio plugins locally using file:// paths and the reload API for instant iteration. - [Tyk AI Studio Edge Gateway Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/edge-gateway.md): Learn how to use Edge Gateway plugins to provide middleware hooks in the LLM proxy request/response pipeline for custom authentication, transformation, and data collection. - [Tyk AI Studio Plugin Edge to Control Communication](https://tyk.io/docs/ai-management/ai-studio/plugins/edge-to-control.md): Understand the Edge-to-Control communication system that allows plugins running on Edge Gateway instances to send data back to plugins on the AI Studio control plane. - [Tyk AI Studio Example Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/examples.md): A comprehensive reference of working plugin examples in the Tyk AI Studio repository, demonstrating real-world patterns for different plugin capabilities. - [Tyk AI Studio Plugin Manifests](https://tyk.io/docs/ai-management/ai-studio/plugins/manifests.md): How to define plugin manifests for Tyk AI Studio plugins? - [Object Hooks Plugin in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/plugins/object-hooks.md): Learn how to use Object Hooks plugins in Tyk AI Studio to intercept and modify requests and responses for specific AI providers and models. - [Tyk AI Studio Plugin Overview](https://tyk.io/docs/ai-management/ai-studio/plugins/overview.md): An overview of Tyk AI Studio's plugin system, featuring the Unified Plugin SDK, plugin capabilities, architecture, and deployment options. - [AI Portal UI Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/portal-ui.md): Learn how to extend the AI Portal with custom user-facing pages, forms, and dashboards using Portal UI plugins. - [Tyk AI Studio Resource Provider Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/resource-types.md): Learn how to register custom resource types that integrate into the App creation flow, participate in privacy scoring, and work with group-based access control. - [Tyk AI Studio Plugin SDK](https://tyk.io/docs/ai-management/ai-studio/plugins/sdk.md): Comprehensive guide to the Tyk AI Studio Plugin SDK, including capabilities, interfaces, and development patterns for building plugins that run in both AI Studio and Edge Gateway contexts. - [Tyk AI Studio Service API Reference](https://tyk.io/docs/ai-management/ai-studio/plugins/service-api.md): A comprehensive reference for the Tyk AI Studio Service API, providing management capabilities for plugins to interact with the platform, including KV storage, logging, and management APIs. - [AI Studio Agent Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/studio-agent.md): Learn how to build conversational AI experiences in the Chat Interface using Agent plugins, which can wrap LLMs, add custom logic, and integrate external services. - [AI Studio UI Plugins](https://tyk.io/docs/ai-management/ai-studio/plugins/studio-ui.md): How to build AI Studio UI plugins to extend the admin dashboard with custom interfaces, dashboards, and management tools using the Unified Plugin SDK. - [Edge Gateway (Data Plane) Component](https://tyk.io/docs/ai-management/ai-studio/proxy.md): Explore Edge Gateway component of Tyk AI Studio, including architecture, configuration synchronization, and management - [Install Tyk AI Studio on Docker](https://tyk.io/docs/ai-management/ai-studio/quickstart.md): Installation guide for the Tyk AI Studio on Docker - [Manage Secrets in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/secrets.md): How to configure secret management in Tyk AI Studio? - [SSO Integration](https://tyk.io/docs/ai-management/ai-studio/sso.md): How to configure SSO in Tyk AI Studio? - [AI Studio Administrator](https://tyk.io/docs/ai-management/ai-studio/studio-admin.md): Overview of the AI Studio Administrator persona in Tyk AI Studio - [Manage Teams in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/teams.md): Understand how to use Teams in Tyk AI Studio to organize users and manage role-based access control (RBAC) for LLM providers, data sources, and tools. - [Telemetry for Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/telemetry.md): How to configure telemetry in Tyk AI Studio? - [Manage Tools in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/tools.md): Discover how to extend LLM capabilities in Tyk AI Studio by integrating external APIs and services using the Tool System and OpenAPI specifications. - [User Management & RBAC](https://tyk.io/docs/ai-management/ai-studio/user-management.md): How to configure user management in Tyk AI Studio? - [Manage Users in Tyk AI Studio](https://tyk.io/docs/ai-management/ai-studio/users.md): Learn how to create and manage Users in Tyk AI Studio, including configuring roles, access permissions, and API keys for administrators, developers, and end-users. - [Natural-language interaction with your APIs (API to MCP)](https://tyk.io/docs/ai-management/mcps/api-to-mcp.md): Enable AI assistants to safely and dynamically interact with your existing APIs using Tyk's API to MCP tooling. - [Natural-language interaction with Tyk Dashboard (API to MCP)](https://tyk.io/docs/ai-management/mcps/dashboard-api-to-mcp.md): Talk to Tyk Dashboard like a person using AI tools - [Tyk MCPs](https://tyk.io/docs/ai-management/mcps/overview.md): A comprehensive guide to Model Context Protocol (MCP) servers in Tyk and how they extend AI capabilities. - [Natural-language interaction with Tyk Docs (MCP)](https://tyk.io/docs/ai-management/mcps/tyk-docs-mcp.md): Talk to Tyk documentation like a person using AI tools. Use Docs MCP to enable AI assistants to search and retrieve information from Tyk documentation. - [AI management](https://tyk.io/docs/ai-management/overview.md): An overview of Tyk's AI management solutions, including AI Studio for governance and deployment, and Model Context Protocol (MCP) servers for secure AI integrations. - [How to install Tyk in Air-Gapped Deployments](https://tyk.io/docs/api-management/air-gapped-deployment.md): How to deploy Tyk in air-gapped or network-restricted environments using private container registries and local package mirrors - [API Versioning](https://tyk.io/docs/api-management/api-versioning.md): Create and manage multiple versions of an API - [Basic Authentication](https://tyk.io/docs/api-management/authentication/basic-authentication.md): How to configure basic authentication in Tyk? - [Authentication Token](https://tyk.io/docs/api-management/authentication/bearer-token.md): How to use Authentication Tokens to Secure APIs - [Certificate Authentication](https://tyk.io/docs/api-management/authentication/certificate-auth.md): Authenticate using just an mTLS client certificate - [Custom Authentication](https://tyk.io/docs/api-management/authentication/custom-auth.md): How to implement custom authentication in Tyk using Go plugins, Python CoProcess, and JSVM plugins. - [JWT Authorization](https://tyk.io/docs/api-management/authentication/jwt-authorization.md): Tyk Gateway's JWT Authorization process extracts user identity and applies security policies based on JWT claims for API access control. - [JWT Claim Validation](https://tyk.io/docs/api-management/authentication/jwt-claim-validation.md): Tyk Gateway's JWT Claim Validation enables fine-grained access control by validating registered and custom claims in JSON Web Tokens. - [JWT Quick Start: Securing APIs with Auth0 or Keycloak](https://tyk.io/docs/api-management/authentication/jwt-quick-start.md): Learn how to secure your Tyk OAS APIs using JWT authentication with Auth0 or Keycloak as identity providers. - [JWT Signature Validation](https://tyk.io/docs/api-management/authentication/jwt-signature-validation.md): How to validate JWT signatures in Tyk API Gateway. - [JWT Split Token](https://tyk.io/docs/api-management/authentication/jwt-split-token.md): Learn how to implement JWT Split Token flow in Tyk to enhance security by separating JWT components and storing sensitive data server-side. - [OAuth 2.0](https://tyk.io/docs/api-management/authentication/oauth-2.md): How to configure OAuth 2.0 in Tyk? - [Tyk Automations Tools](https://tyk.io/docs/api-management/automations.md): Tyk Tools that help with automating deployment and API Management operations - [Tyk Operator - API Management in Kubernetes](https://tyk.io/docs/api-management/automations/operator.md): Kubernetes native API management using Tyk Operator - [Tyk Sync - Synchronize Tyk Environment With GitHub](https://tyk.io/docs/api-management/automations/sync.md): How to synchronize Tyk configuration with Github using Tyk Sync - [Batch Processing](https://tyk.io/docs/api-management/batch-processing.md): Make multiple API requests in a single HTTP call using Batch Requests - [TLS and Certificate Management](https://tyk.io/docs/api-management/certificates.md): Transport Layer Security and Tyk Certificate Store - [Client Authentication and Authorization](https://tyk.io/docs/api-management/client-authentication.md): Learn how to apply the most appropriate authentication method to secure access your APIs with Tyk. Here you will find everything there is to know about authenticating and authorizing API clients with Tyk. - [Configure Audit Logs in Tyk Cloud](https://tyk.io/docs/api-management/cloud/audit-logs.md): Learn how to set up and manage audit logs in Tyk Cloud Control Plane deployments. - [Collecting Tyk Gateway Logs with OpenTelemetry Collector on Kubernetes](https://tyk.io/docs/api-management/collecting-gateway-logs-otel-kubernetes.md): Step-by-step guide for platform engineers to collect Tyk Gateway logs using the OpenTelemetry Collector Filelog Receiver and ship them to Elasticsearch on Kubernetes. - [Custom Authentication with Proxy Identify Provider](https://tyk.io/docs/api-management/custom-auth-with-proxy-identity-provider.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [Manage the Tyk Dashboard](https://tyk.io/docs/api-management/dashboard-configuration.md): How to manage users, teams, permissions, RBAC in Tyk Dashboard - [Universal Data Graph](https://tyk.io/docs/api-management/data-graph.md): How to Configure data graph - [Enable and View Audit Logs in Tyk Dashboard](https://tyk.io/docs/api-management/enable-audit-logs-dashboard.md): Learn how to enable audit logging in Tyk Dashboard using database storage and view audit logs through the Dashboard UI. - [Tyk Streams – Manage Event-Driven APIs](https://tyk.io/docs/api-management/event-driven-apis.md): Introduction to Tyk Streams - [Tyk Identity Broker - Integrate Social Logins, IDPs, LDAP and Custom Authentication](https://tyk.io/docs/api-management/external-service-integration.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [Configuring Tyk Gateway](https://tyk.io/docs/api-management/gateway-config-introduction.md): Explain the concept of Tyk API definition and the different types Tyk offers - [Managing Tyk Classic API Definition](https://tyk.io/docs/api-management/gateway-config-managing-classic.md): How to manage Tyk Classic API definition - [Working with Tyk OAS APIs](https://tyk.io/docs/api-management/gateway-config-managing-oas.md): How to work with Tyk OAS APIs - [Tyk Classic API Definition](https://tyk.io/docs/api-management/gateway-config-tyk-classic.md): How to configure Tyk Classic API Definition - [Tyk OAS](https://tyk.io/docs/api-management/gateway-config-tyk-oas.md): How to configure Tyk OAS API Definition - [Gateway Events](https://tyk.io/docs/api-management/gateway-events.md): Introduction to Gateway Events - [GraphQL](https://tyk.io/docs/api-management/graphql.md): How to configure GraphQL - [GraphQL Schema Types](https://tyk.io/docs/api-management/graphql/graphql-schema-types.md): Understanding GraphQL schema types and how they work with Tyk - [Implementing TLS with Tyk](https://tyk.io/docs/api-management/implement-tls.md): Secure access to APIs and Tyk components - [Logging in Tyk](https://tyk.io/docs/api-management/logs.md): Learn different types of logs in Tyk, how to configure them and how to integrate with third-party log management tools for effective API observability. - [Metrics in Tyk](https://tyk.io/docs/api-management/logs-metrics.md): Learn how to configure metrics in Tyk for effective API observability, including integration with third-party tools. - [API Observability](https://tyk.io/docs/api-management/manage-apis/api-operations/api-observability.md): Explains how to achieve API observability through Open Telemetry signals such as traces, metrics and logs - [API Creation Methods](https://tyk.io/docs/api-management/manage-apis/deploy-apis/deploy-apis-overview.md): Different ways to create and manage APIs in Tyk - [Tyk Multi Data Center Bridge (MDCB): Centralized API Governance Across Distributed Environments](https://tyk.io/docs/api-management/mdcb.md): How to configure Multi Data Center Bridge - [Migrating from Tyk Classic APIs](https://tyk.io/docs/api-management/migrate-from-tyk-classic.md): API Migration: Converting Tyk Classic APIs to Tyk OAS Format - [Manage Multiple Environments](https://tyk.io/docs/api-management/multiple-environments.md): How to Manage Multiple Environments - [Performance Monitoring](https://tyk.io/docs/api-management/performance-monitoring.md): How to analyze Tyk Performance - [Custom Plugins Advance Configuration](https://tyk.io/docs/api-management/plugins/advance-config.md): Explore advanced configuration options for custom plugins in Tyk, including CICD automation, OpenTelemetry instrumentation, and gRPC server health checks in Kubernetes. - [Golang Plugins](https://tyk.io/docs/api-management/plugins/golang.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Javascript Plugins](https://tyk.io/docs/api-management/plugins/javascript.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Custom Plugins](https://tyk.io/docs/api-management/plugins/overview.md): Learn how to extend Tyk's capabilities using custom plugins to enhance API functionality. - [Plugin Types](https://tyk.io/docs/api-management/plugins/plugin-types.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Rich Plugins](https://tyk.io/docs/api-management/plugins/rich-plugins.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Security Policy and Access Keys](https://tyk.io/docs/api-management/policies.md): How to create and use policies and access keys in Tyk - [Rate Limiting](https://tyk.io/docs/api-management/rate-limit.md): Overview of Rate Limiting with the Tyk Gateway - [Request Quotas](https://tyk.io/docs/api-management/request-quotas.md): Overview of Rate Quotas with the Tyk Gateway - [Request Throttling](https://tyk.io/docs/api-management/request-throttling.md): What is Request Throttling in Tyk Gateway? - [Caching Responses](https://tyk.io/docs/api-management/response-caching.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Security Best Practices](https://tyk.io/docs/api-management/security-best-practices.md): Guide on API management and security best practices, including authentication, authorization, resource protection, governance, and OWASP threat mitigation with Tyk. - [Security Features](https://tyk.io/docs/api-management/security-features.md): Guide on API management and security best practices, including authentication, authorization, resource protection, governance, and OWASP threat mitigation with Tyk. - [Single Sign On (SS0) with LDAP](https://tyk.io/docs/api-management/single-sign-on-ldap.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [Single Sign On (SS0) with OpenID Connect (OIDC)](https://tyk.io/docs/api-management/single-sign-on-oidc.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [Single Sign On (SS0) with SAML](https://tyk.io/docs/api-management/single-sign-on-saml.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [SSO with Social Identity Providers](https://tyk.io/docs/api-management/single-sign-on-social-idp.md): Learn how to integrate external services with Tyk API Gateway. Discover how to use middleware plugins, webhooks, and service discovery to extend your API functionality and connect with third-party systems. - [Tyk Streams Configuration](https://tyk.io/docs/api-management/stream-config.md): How to configure Tyk Streams - [Tyk Streams End-to-End Example](https://tyk.io/docs/api-management/streams-end-to-end-example.md): A comprehensive end-to-end example of Tyk Streams implementation - [Tyk Sync Quick Start Guide](https://tyk.io/docs/api-management/sync/quick-start.md): Quick start guide for Tyk Sync to synchronize API configurations with Tyk Dashboard - [Automate API Configuration Management with Tyk Sync](https://tyk.io/docs/api-management/sync/use-cases.md): Learn how to automate API configuration management using Tyk Sync and GitHub Actions. - [Distributed Tracing with Tyk](https://tyk.io/docs/api-management/traces.md): Learn how to configure distributed tracing in Tyk for enhanced API observability, including integration with OpenTelemetry and third-party tracing tools. - [Transform Traffic by using Tyk Middleware](https://tyk.io/docs/api-management/traffic-transformation.md): Learn how to transform API traffic using Tyk's middleware capabilities. - [Allow List](https://tyk.io/docs/api-management/traffic-transformation/allow-list.md): How to configure Allow List traffic transformation middleware in Tyk - [Block List](https://tyk.io/docs/api-management/traffic-transformation/block-list.md): How to configure Block List traffic transformation middleware in Tyk - [Do Not Track](https://tyk.io/docs/api-management/traffic-transformation/do-not-track.md): How to configure Do Not Track traffic transformation middleware in Tyk - [Go Templates](https://tyk.io/docs/api-management/traffic-transformation/go-templates.md): How to configure Go Templates traffic transformation middleware in Tyk - [Ignore Authentication](https://tyk.io/docs/api-management/traffic-transformation/ignore-authentication.md): How to configure Ignore Authentication traffic transformation middleware in Tyk - [Internal Endpoint](https://tyk.io/docs/api-management/traffic-transformation/internal-endpoint.md): How to configure Internal Endpoint traffic transformation middleware in Tyk - [JQ Transforms](https://tyk.io/docs/api-management/traffic-transformation/jq-transforms.md): How to configure JQ Transforms traffic transformation middleware in Tyk - [Mock Response](https://tyk.io/docs/api-management/traffic-transformation/mock-response.md): How to configure Mock Response traffic transformation middleware in Tyk - [Request Body](https://tyk.io/docs/api-management/traffic-transformation/request-body.md): How to configure Request Body traffic transformation middleware in Tyk - [Request Context Variables](https://tyk.io/docs/api-management/traffic-transformation/request-context-variables.md): How to configure Request Context Variables traffic transformation middleware in Tyk - [Request Headers](https://tyk.io/docs/api-management/traffic-transformation/request-headers.md): How to configure Request Headers traffic transformation middleware in Tyk - [Request Method](https://tyk.io/docs/api-management/traffic-transformation/request-method.md): How to configure Request Method traffic transformation middleware in Tyk - [Request Size Limits](https://tyk.io/docs/api-management/traffic-transformation/request-size-limits.md): How to configure Request Size Limits traffic transformation middleware in Tyk - [Request Validation](https://tyk.io/docs/api-management/traffic-transformation/request-validation.md): How to configure Request Validation traffic transformation middleware in Tyk - [Response Body](https://tyk.io/docs/api-management/traffic-transformation/response-body.md): How to configure Response Body traffic transformation middleware in Tyk - [Response Headers](https://tyk.io/docs/api-management/traffic-transformation/response-headers.md): How to configure Response Headers traffic transformation middleware in Tyk - [Virtual Endpoints](https://tyk.io/docs/api-management/traffic-transformation/virtual-endpoints.md): How to configure Virtual Endpoints traffic transformation middleware in Tyk - [Troubleshooting and Debugging](https://tyk.io/docs/api-management/troubleshooting-debugging.md): Tyk troubleshooting and debugging gateway, streams, pump, dashboard - [Tyk Pump - Export Metrics to Persistent Datastore](https://tyk.io/docs/api-management/tyk-pump.md): How to configure Tyk Pump - [Upstream Authentication](https://tyk.io/docs/api-management/upstream-authentication.md): Authenticating Tyk Gateway with upstream services - [Upstream Authentication using Auth Token](https://tyk.io/docs/api-management/upstream-authentication/auth-token.md): How to authenticate upstream service using auth token - [Upstream Authentication using Basic Auth](https://tyk.io/docs/api-management/upstream-authentication/basic-auth.md): How to authenticate upstream service basic authentication - [Upstream Authentication using Mutual TLS](https://tyk.io/docs/api-management/upstream-authentication/mtls.md): How to authenticate upstream service using mutual tls - [Upstream Authentication using OAuth](https://tyk.io/docs/api-management/upstream-authentication/oauth.md): How to authenticate upstream service using oauth - [Upstream Authentication using Request Signing](https://tyk.io/docs/api-management/upstream-authentication/request-signing.md): How to authenticate upstream service using request signing - [User management with Tyk Dashboard](https://tyk.io/docs/api-management/user-management.md): How to manage users, teams, permissions, rbac in Tyk Dashboard - [Approve an access request](https://tyk.io/docs/api-reference/access-requests/approve-an-access-request.md): This endpoint triggers approval of an access request. A call to this API will trigger creation of credentials in a gateway or an Identity Provider - [Delete an access request](https://tyk.io/docs/api-reference/access-requests/delete-an-access-request.md): This endpoint deletes an access request. If an access request is approved, its credentials will be revoked and removed from a gateway or an identity provider - [Get an access request's data](https://tyk.io/docs/api-reference/access-requests/get-an-access-requests-data.md): Get an access request's data - [List all access requests](https://tyk.io/docs/api-reference/access-requests/list-all-access-requests.md): List all access requests that exist in the portal - [Reject an access request](https://tyk.io/docs/api-reference/access-requests/reject-an-access-request.md): Reject an access request - [Add/Delete/Update additional permission.](https://tyk.io/docs/api-reference/additional-permissions/adddeleteupdate-additional-permission.md): Whenever you want to add/update/delete an additional permission, just send back the updated list of permissions, through this PUT request to the API. For example if you initially had two additional permissions e.g ```{additional_permissions: {api_developer: API Developer, api_manager: API Manager}}`… - [List additional permissions.](https://tyk.io/docs/api-reference/additional-permissions/list-additional-permissions.md): This API returns by default the initial set of additional permissions defined in your Tyk Dashboard configuration, under `security.additional_permissions`. Once you update the permissions via the API, they will be stored at organisation level. - [Analytics of API Key.](https://tyk.io/docs/api-reference/analytics/analytics-of-api-key.md): It returns analytics of the endpoints of all APIs called a key between start and end date. - [Analytics of Oauth Client ID.](https://tyk.io/docs/api-reference/analytics/analytics-of-oauth-client-id.md): Returns activity of all endpoints which used the given OAuth client between the given time range. - [Get app interactions over time](https://tyk.io/docs/api-reference/analytics/get-app-interactions-over-time.md): Get the number of LLM interactions for a specific app over time - [Get budget usage for a specific app](https://tyk.io/docs/api-reference/analytics/get-budget-usage-for-a-specific-app.md): Get the current budget usage for a specific app - [Get chat interactions for a specific chat](https://tyk.io/docs/api-reference/analytics/get-chat-interactions-for-a-specific-chat.md): Get the number of interactions for a specific chat over time - [Get chat records per day](https://tyk.io/docs/api-reference/analytics/get-chat-records-per-day.md): Get the total number of chat records per day for a given time period - [Get chat records per user](https://tyk.io/docs/api-reference/analytics/get-chat-records-per-user.md): Get the total number of chat records per user for a given time period - [Get cost analysis](https://tyk.io/docs/api-reference/analytics/get-cost-analysis.md): Get the total cost per day for a given time period - [Get current monthly budget usage for apps and LLMs](https://tyk.io/docs/api-reference/analytics/get-current-monthly-budget-usage-for-apps-and-llms.md): Returns usage of monthly budgets for apps and LLMs, with optional date range for total cost - [Get most used LLM models](https://tyk.io/docs/api-reference/analytics/get-most-used-llm-models.md): Get the usage count for each LLM model - [Get proxy logs for a specific app](https://tyk.io/docs/api-reference/analytics/get-proxy-logs-for-a-specific-app.md): Get paginated proxy logs for a specific app - [Get proxy logs for a specific LLM](https://tyk.io/docs/api-reference/analytics/get-proxy-logs-for-a-specific-llm.md): Get paginated proxy logs for a specific LLM by joining with chat records - [Get token usage and cost data with flexible filtering](https://tyk.io/docs/api-reference/analytics/get-token-usage-and-cost-data-with-flexible-filtering.md): Get token usage and cost data filtered by vendor, LLM ID, app ID, and interaction type - [Get token usage and cost for a specific app](https://tyk.io/docs/api-reference/analytics/get-token-usage-and-cost-for-a-specific-app.md): Get the token usage and total cost for a specific app over time - [Get token usage for a specific app](https://tyk.io/docs/api-reference/analytics/get-token-usage-for-a-specific-app.md): Get the token usage for a specific app over time - [Get token usage per app](https://tyk.io/docs/api-reference/analytics/get-token-usage-per-app.md): Get the total token usage for each app - [Get token usage per user](https://tyk.io/docs/api-reference/analytics/get-token-usage-per-user.md): Get the total token usage for each user - [Get tool calls per day](https://tyk.io/docs/api-reference/analytics/get-tool-calls-per-day.md): Get the total number of tool calls per day for a given time period - [Get tool operations usage over time for a specific tool](https://tyk.io/docs/api-reference/analytics/get-tool-operations-usage-over-time-for-a-specific-tool.md): Get the usage count for each operation of a specific tool over time - [Get tool usage statistics](https://tyk.io/docs/api-reference/analytics/get-tool-usage-statistics.md): Get the usage count for each tool - [Get total cost per vendor and model](https://tyk.io/docs/api-reference/analytics/get-total-cost-per-vendor-and-model.md): Get the total cost per vendor and model for a given time period, including currency - [Get unique users per day](https://tyk.io/docs/api-reference/analytics/get-unique-users-per-day.md): Get the number of unique users per day - [Get usage statistics for a specific model](https://tyk.io/docs/api-reference/analytics/get-usage-statistics-for-a-specific-model.md): Get the usage statistics for a specific model over time - [Get usage statistics for a specific vendor](https://tyk.io/docs/api-reference/analytics/get-usage-statistics-for-a-specific-vendor.md): Get the usage statistics for a specific vendor over time - [Add a new specification to this Documentation Product](https://tyk.io/docs/api-reference/api-documentation-for-api-products/add-a-new-specification-to-this-documentation-product.md): Add a new specification to this Documentation Product - [Delete a specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/delete-a-specification.md): Delete a specification from this Documentation Product - [Delete GraphQL schema file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/delete-graphql-schema-file-of-an-api.md): Remove GraphQL schema file from an API - [Delete OAS file of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/delete-oas-file-of-a-specification.md): Remove OAS file from a Specification - [Delete OAS file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/delete-oas-file-of-an-api.md): Remove OAS file from an API - [Delete Specification with GraphQL schema](https://tyk.io/docs/api-reference/api-documentation-for-api-products/delete-specification-with-graphql-schema.md): Delete a Specification that contains a GraphQL schema. This removes the entire SpecDetails object. - [Download GraphQL schema file of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/download-graphql-schema-file-of-a-specification.md): Download a GraphQL schema file for a specific Specification in a Documentation Product - [Download GraphQL schema file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/download-graphql-schema-file-of-an-api.md): Download a GraphQL schema file for a specific API in a Product - [Download OAS file of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/download-oas-file-of-a-specification.md): Download an OAS spec as a file for a specific Specification in a Documentation Product - [Download OAS file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/download-oas-file-of-an-api.md): Download an OAS spec as a file for a specific API in a Product - [Get description of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/get-description-of-a-specification.md): Get description of a Specification - [Get description of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/get-description-of-an-api.md): Get description of an API - [List all APIs included in this API Product](https://tyk.io/docs/api-reference/api-documentation-for-api-products/list-all-apis-included-in-this-api-product.md): List all APIs included in this API Product - [List all Specification details included in this Documentation Product](https://tyk.io/docs/api-reference/api-documentation-for-api-products/list-all-specification-details-included-in-this-documentation-product.md): List all Specification details included in this Documentation Product - [Update description of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/update-description-of-a-specification.md): Update description of a Specification including name, OAS URL and alias - [Update description of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/update-description-of-an-api.md): Update description of an API including name, OAS URL and description - [Update OAS file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/update-oas-file-of-an-api.md): Update an OAS file for an API inside an API Product - [Upload GraphQL schema file of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/upload-graphql-schema-file-of-a-specification.md): Upload a GraphQL schema file for a Specification inside a Documentation Product - [Upload GraphQL schema file of an API](https://tyk.io/docs/api-reference/api-documentation-for-api-products/upload-graphql-schema-file-of-an-api.md): Upload a GraphQL schema file for an API inside an API Product - [Upload GraphQL SDL for Documentation Product](https://tyk.io/docs/api-reference/api-documentation-for-api-products/upload-graphql-sdl-for-documentation-product.md): Upload and link a GraphQL SDL file to a documentation-only product. The uploaded file must be a valid GraphQL schema (with extension `.graphql`, `.gql`, or `.json`) and is stored as the latest schema for the product. Only works for documentation-only products. - [Upload OAS file of a Specification](https://tyk.io/docs/api-reference/api-documentation-for-api-products/upload-oas-file-of-a-specification.md): Upload an OAS file for a Specification inside a Documentation Product - [Create an API](https://tyk.io/docs/api-reference/apis/create-an-api.md): Create API. A single Tyk node can have its API Definitions queried, deleted and updated remotely. This functionality enables you to remotely update your Tyk definitions without having to manage the files manually. - [Create API Definition](https://tyk.io/docs/api-reference/apis/create-api-definition.md): Create an API Definition in Tyk Classic API format. Note that the response includes the newly created Tyk Classic API Definition containing the unique identifier for the APIs (`api_id`). You can provide a value for the `api_id` in the request body, otherwise Tyk will automatically generate a value… - [Delete a single API by ID](https://tyk.io/docs/api-reference/apis/delete-a-single-api-by-id.md): Delete an API by ID - [Deleting an API definition with ID.](https://tyk.io/docs/api-reference/apis/deleting-an-api-definition-with-id.md): Deleting an API definition will remove the file from the file store, the API definition will NOT be unloaded, a separate reload request will need to be made to disable the API endpoint. - [Get a list of example API definitions.](https://tyk.io/docs/api-reference/apis/get-a-list-of-example-api-definitions.md): Returns a list of all example API definitions available in "repository.json" file defined in "x-tyk-examples-index" header. If the header is not provided, Tyk will use the default value of this header which is `tyk-examples` repo. - [Get a single API by ID](https://tyk.io/docs/api-reference/apis/get-a-single-api-by-id.md): Get an API by ID - [Get API access rights (users and userGroups)](https://tyk.io/docs/api-reference/apis/get-api-access-rights-users-and-usergroups.md): This will return APIAccessManagementPayload that has two lists containing users and user groups that have access to an API. - [Get API Categories](https://tyk.io/docs/api-reference/apis/get-api-categories.md): Get a list of all the defined API categories and the number(count) of APIs that are in each category. - [Get API definition with it's ID.](https://tyk.io/docs/api-reference/apis/get-api-definition-with-its-id.md): Get API definition from Tyk Gateway. - [Get API Groups.](https://tyk.io/docs/api-reference/apis/get-api-groups.md): This will return a map/hashmap with categories as keys and the key values will be a list that contains all the APIIDs that belong to that category. - [Get API URLs](https://tyk.io/docs/api-reference/apis/get-api-urls.md): This will return your API BasePath(your API listen path) ,Host(your API domain or gateway hostname ) and API URL (full url to your API upstream which is a combination of the protocol the API uses (e.g http)+ host name(e.g tyk.io) and the API listen_path ) - [Get details of a single example API definition.](https://tyk.io/docs/api-reference/apis/get-details-of-a-single-example-api-definition.md): Get the details of a single API definition, details include full name, location in the repository, description, features and min tyk version. - [Get List of APIs](https://tyk.io/docs/api-reference/apis/get-list-of-apis.md): Get List of APIs.By default the returned apis will be sorted by created_at field in descending order but this can be changed via sort query parameter.The apis returned are paginated - [Invalidate cache for given API ID.](https://tyk.io/docs/api-reference/apis/invalidate-cache-for-given-api-id.md): Invalidate JWKS cache for the given API. - [Listing versions of an API.](https://tyk.io/docs/api-reference/apis/listing-versions-of-an-api.md): Listing versions of an API. - [Search List of APIs](https://tyk.io/docs/api-reference/apis/search-list-of-apis.md): This will return a list of APIs whose names matches the provided q query parameter.If q is not sent all APIs will be returned.The returned results are paginated. - [Update API access rights (users and userGroups)](https://tyk.io/docs/api-reference/apis/update-api-access-rights-users-and-usergroups.md): This will update the user group and users that have access to an API.The userIds and userGroup sent will entirely replace the existing userIds IDs and userGroup ids. - [Update API Definition](https://tyk.io/docs/api-reference/apis/update-api-definition.md): Update an API Definition. api_id can be updated for On-Premise installations, but it cannot be updated when the Dashboard resides in Tyk Cloud. Updates to api_id in Tyk Cloud will be ignored. - [Updating an API definition with its ID.](https://tyk.io/docs/api-reference/apis/updating-an-api-definition-with-its-id.md): Updating an API definition uses the same signature and object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`. - [Create a Custom Credential](https://tyk.io/docs/api-reference/applications-and-credentials/create-a-custom-credential.md): Create a new custom credential for a specific application. - [Create a new access request for this application](https://tyk.io/docs/api-reference/applications-and-credentials/create-a-new-access-request-for-this-application.md): Create a new access request for this application - [Create a new developer application](https://tyk.io/docs/api-reference/applications-and-credentials/create-a-new-developer-application.md): Create a new developer application - [Delete a credential from an access request](https://tyk.io/docs/api-reference/applications-and-credentials/delete-a-credential-from-an-access-request.md): This endpoint deletes credentials for an access request and removes an API key from the gateway or an OAuth2.0 client from the Identity Provider - [Delete a Custom Credential](https://tyk.io/docs/api-reference/applications-and-credentials/delete-a-custom-credential.md): Delete a specific custom credential for a specific application. - [Delete an access request](https://tyk.io/docs/api-reference/applications-and-credentials/delete-an-access-request.md): This endpoint deletes an access request. If this access request was approved and has any credenitals attached to it then all of them will be removed and revoked in a gateway on an identity provider - [Delete an application](https://tyk.io/docs/api-reference/applications-and-credentials/delete-an-application.md): Delete an application. The application, all its access requests and credentials will be removed. Also, it will trigger removal of all credentials that belong to this application from a gateway and/or Identity Provider - [Get a credential by its ID](https://tyk.io/docs/api-reference/applications-and-credentials/get-a-credential-by-its-id.md): Get a credential by its ID - [Get a Custom Credential](https://tyk.io/docs/api-reference/applications-and-credentials/get-a-custom-credential.md): Retrieve a specific custom credential by its ID. - [Get an access request's data](https://tyk.io/docs/api-reference/applications-and-credentials/get-an-access-requests-data.md): Get an access request's data - [Get an application's data](https://tyk.io/docs/api-reference/applications-and-credentials/get-an-applications-data.md): Get an application's data - [List all access requests for this application](https://tyk.io/docs/api-reference/applications-and-credentials/list-all-access-requests-for-this-application.md): List all access requests for this application - [List all developer application that exist in the portal](https://tyk.io/docs/api-reference/applications-and-credentials/list-all-developer-application-that-exist-in-the-portal.md): List all developer applications - [List credentials for an access request](https://tyk.io/docs/api-reference/applications-and-credentials/list-credentials-for-an-access-request.md): List credentials from a specific access request for this app - [List Custom Credentials](https://tyk.io/docs/api-reference/applications-and-credentials/list-custom-credentials.md): Retrieve a list of custom credentials for a specific application. - [Rotate credentials](https://tyk.io/docs/api-reference/applications-and-credentials/rotate-credentials.md): Rotate the credentials that belong to an access request for a specific application. The new credentials will replace the existing ones. - [Update a Custom Credential](https://tyk.io/docs/api-reference/applications-and-credentials/update-a-custom-credential.md): Update an existing custom credential for a specific application. - [Update an application](https://tyk.io/docs/api-reference/applications-and-credentials/update-an-application.md): This endpoint updates an application's data such as its name, description, redirect URI and the user to whom this application belongs - [Activate app credential](https://tyk.io/docs/api-reference/apps/activate-app-credential.md): Activate the credential associated with an app - [Add a tool to an app](https://tyk.io/docs/api-reference/apps/add-a-tool-to-an-app.md): Associate a tool with an app - [Count all apps](https://tyk.io/docs/api-reference/apps/count-all-apps.md): Get the total number of apps - [Count apps by user ID](https://tyk.io/docs/api-reference/apps/count-apps-by-user-id.md): Get the total number of apps for a specific user - [Create a new app](https://tyk.io/docs/api-reference/apps/create-a-new-app.md): Create a new app with the provided information - [Deactivate app credential](https://tyk.io/docs/api-reference/apps/deactivate-app-credential.md): Deactivate the credential associated with an app - [Delete an app](https://tyk.io/docs/api-reference/apps/delete-an-app.md): Delete an app by its ID - [Get an app by ID](https://tyk.io/docs/api-reference/apps/get-an-app-by-id.md): Get details of an app by its ID - [Get app by name](https://tyk.io/docs/api-reference/apps/get-app-by-name.md): Get details of an app by its name - [Get apps by user ID](https://tyk.io/docs/api-reference/apps/get-apps-by-user-id.md): Get a list of apps for a specific user - [Get tools for an app](https://tyk.io/docs/api-reference/apps/get-tools-for-an-app.md): Retrieve all tools associated with a specific app - [List all apps](https://tyk.io/docs/api-reference/apps/list-all-apps.md): Get a list of all apps, optionally filtered by search term - [Remove a tool from an app](https://tyk.io/docs/api-reference/apps/remove-a-tool-from-an-app.md): Disassociate a tool from an app - [Reset app budget](https://tyk.io/docs/api-reference/apps/reset-app-budget.md): Reset the budget period for an app by setting start date to today - [Search apps](https://tyk.io/docs/api-reference/apps/search-apps.md): Search for apps based on a search term - [Update an app](https://tyk.io/docs/api-reference/apps/update-an-app.md): Update an existing app's information - [Create an asset](https://tyk.io/docs/api-reference/assets/create-an-asset.md): Create an asset that you can use as a blueprint from which you can create a new Tyk OAS API definition. - [Delete an asset by ID.](https://tyk.io/docs/api-reference/assets/delete-an-asset-by-id.md): Remove an asset ID. - [Retrieve an asset.](https://tyk.io/docs/api-reference/assets/retrieve-an-asset.md): Retrieve an asset by ID. - [Retrieve list of assets.](https://tyk.io/docs/api-reference/assets/retrieve-list-of-assets.md): Retrieves all types of assets with optional kind filter. - [Update an asset by ID.](https://tyk.io/docs/api-reference/assets/update-an-asset-by-id.md): Update an asset by ID.You cannot update _id (database ID assigned by tyk) - [List audit logs](https://tyk.io/docs/api-reference/auditlogs/list-audit-logs.md): Retrieve audit logs from database - [Retrieve single audit log](https://tyk.io/docs/api-reference/auditlogs/retrieve-single-audit-log.md): Retrieve a single audit log from database by ID - [Create a nonce token for SSO authentication](https://tyk.io/docs/api-reference/auth/create-a-nonce-token-for-sso-authentication.md): Create a nonce token that can be used for SSO authentication - [Forgot password](https://tyk.io/docs/api-reference/auth/forgot-password.md): Request a password reset - [Get current user with entitlements](https://tyk.io/docs/api-reference/auth/get-current-user-with-entitlements.md): Get the details of the currently logged-in user including their entitlements - [Handle SSO authentication with a nonce token](https://tyk.io/docs/api-reference/auth/handle-sso-authentication-with-a-nonce-token.md): Process SSO authentication using a nonce token, validate user, and establish a session - [Handle the callback from an identity provider](https://tyk.io/docs/api-reference/auth/handle-the-callback-from-an-identity-provider.md): Handle the callback from an identity provider after authentication - [Handle the SAML metadata request for an identity provider](https://tyk.io/docs/api-reference/auth/handle-the-saml-metadata-request-for-an-identity-provider.md): Handle the SAML metadata request for an identity provider - [Handle TIB authentication](https://tyk.io/docs/api-reference/auth/handle-tib-authentication.md): Handle authentication through a TIB profile - [Login user](https://tyk.io/docs/api-reference/auth/login-user.md): Authenticate a user and return a session token - [Logout user](https://tyk.io/docs/api-reference/auth/logout-user.md): Log out the current user - [Register user](https://tyk.io/docs/api-reference/auth/register-user.md): Register a new user - [Resend verification email](https://tyk.io/docs/api-reference/auth/resend-verification-email.md): Resend the email verification link - [Reset password](https://tyk.io/docs/api-reference/auth/reset-password.md): Reset user's password using a token - [Validate reset token](https://tyk.io/docs/api-reference/auth/validate-reset-token.md): Validate a password reset token without attempting to reset the password. Use this endpoint - [Verify email](https://tyk.io/docs/api-reference/auth/verify-email.md): Verify user's email using a token - [Create a Basic Auth User.](https://tyk.io/docs/api-reference/basic-authentication/create-a-basic-auth-user.md): Create a Basic Auth user with the username specified in the path {username}. Note you have to send password via(the basic_auth_data.password field) in the request body. - [Run batch request.](https://tyk.io/docs/api-reference/batch-requests/run-batch-request.md): Endpoint to run batch request. - [Get branding settings](https://tyk.io/docs/api-reference/branding/get-branding-settings.md): Get current branding settings (public endpoint for frontend config) - [Get custom favicon](https://tyk.io/docs/api-reference/branding/get-custom-favicon.md): Serve the custom favicon file (public endpoint) - [Get custom logo](https://tyk.io/docs/api-reference/branding/get-custom-logo.md): Serve the custom logo file (public endpoint) - [Reset branding to defaults](https://tyk.io/docs/api-reference/branding/reset-branding-to-defaults.md): Reset all branding settings to default values (admin only) - [Update branding settings](https://tyk.io/docs/api-reference/branding/update-branding-settings.md): Update branding settings (admin only) - [Upload favicon](https://tyk.io/docs/api-reference/branding/upload-favicon.md): Upload a custom favicon (admin only, ICO/PNG, max 100KB) - [Upload logo](https://tyk.io/docs/api-reference/branding/upload-logo.md): Upload a custom logo (admin only, PNG/JPG/SVG, max 2MB) - [Invalidate cache.](https://tyk.io/docs/api-reference/cache-invalidation/invalidate-cache.md): Invalidate cache for the given API. - [Add a new audience to this catalogue](https://tyk.io/docs/api-reference/catalogue-audiences/add-a-new-audience-to-this-catalogue.md): Add a new audience to this catalogue. Please note that if the catalog's visibility is set to 'public', the audiences will be ignored - [List all audiences for this catalogue](https://tyk.io/docs/api-reference/catalogue-audiences/list-all-audiences-for-this-catalogue.md): List all audiences for this catalogue - [List audiences for this catalogue](https://tyk.io/docs/api-reference/catalogue-audiences/list-audiences-for-this-catalogue.md): List audiences that have access to this catalogue. Each audience is a team that belongs to a specific organisation - [Remove an audience from a catalog](https://tyk.io/docs/api-reference/catalogue-audiences/remove-an-audience-from-a-catalog.md): Remove an audience from this catalog. Please note that if the catalog's visibility is set to 'public', the audiences will be ignored - [Add an LLM to a catalogue](https://tyk.io/docs/api-reference/catalogues/add-an-llm-to-a-catalogue.md): Add an LLM to a specific catalogue - [Add LLM to catalogue](https://tyk.io/docs/api-reference/catalogues/add-llm-to-catalogue.md): Add an LLM to a specific catalogue (Enterprise Edition only) - [Create a new catalogue](https://tyk.io/docs/api-reference/catalogues/create-a-new-catalogue.md): Create a new LLM catalogue (Enterprise Edition only) - [Create a new catalogue](https://tyk.io/docs/api-reference/catalogues/create-a-new-catalogue-1.md): Create a new catalogue with the provided information - [Delete a catalogue](https://tyk.io/docs/api-reference/catalogues/delete-a-catalogue.md): Delete a catalogue by its ID - [Delete catalogue](https://tyk.io/docs/api-reference/catalogues/delete-catalogue.md): Delete a specific LLM catalogue (Enterprise Edition only) - [Get a catalogue](https://tyk.io/docs/api-reference/catalogues/get-a-catalogue.md): Get a catalogue - [Get a catalogue by ID](https://tyk.io/docs/api-reference/catalogues/get-a-catalogue-by-id.md): Get details of a catalogue by its ID - [Get catalogue by ID](https://tyk.io/docs/api-reference/catalogues/get-catalogue-by-id.md): Get details of a specific LLM catalogue (Enterprise Edition only) - [List all catalogues](https://tyk.io/docs/api-reference/catalogues/list-all-catalogues.md): Get a list of all catalogues with their associated LLM names - [List catalogue LLMs](https://tyk.io/docs/api-reference/catalogues/list-catalogue-llms.md): Get all LLMs in a specific catalogue (Enterprise Edition only) - [List catalogues](https://tyk.io/docs/api-reference/catalogues/list-catalogues.md): Get all LLM catalogues (Enterprise Edition only) - [List LLMs in a catalogue](https://tyk.io/docs/api-reference/catalogues/list-llms-in-a-catalogue.md): Get a list of all LLMs in a specific catalogue - [Remove an LLM from a catalogue](https://tyk.io/docs/api-reference/catalogues/remove-an-llm-from-a-catalogue.md): Remove an LLM from a specific catalogue - [Remove LLM from catalogue](https://tyk.io/docs/api-reference/catalogues/remove-llm-from-catalogue.md): Remove an LLM from a specific catalogue (Enterprise Edition only) - [Search catalogues](https://tyk.io/docs/api-reference/catalogues/search-catalogues.md): Search LLM catalogues (Enterprise Edition only) - [Search catalogues by name](https://tyk.io/docs/api-reference/catalogues/search-catalogues-by-name.md): Search LLM catalogues by name prefix (Enterprise Edition only) - [Search catalogues by name](https://tyk.io/docs/api-reference/catalogues/search-catalogues-by-name-1.md): Search for catalogues using a name stub - [Search catalogues by name stub](https://tyk.io/docs/api-reference/catalogues/search-catalogues-by-name-stub.md): Search for catalogues using a name stub - [Update a catalogue](https://tyk.io/docs/api-reference/catalogues/update-a-catalogue.md): Update an existing catalogue's information - [Update catalogue](https://tyk.io/docs/api-reference/catalogues/update-catalogue.md): Update an existing LLM catalogue (Enterprise Edition only) - [Create a certificate in Tyk org cert store.](https://tyk.io/docs/api-reference/certificates/create-a-certificate-in-tyk-org-cert-store.md): Upload new SSL certificate in PEM format (you should upload as a file). If the certificate should have a private key, convert both the public certificate and the associated private key to PEM format and concatenate them to a single file. You can only upload one certificate at a time. - [Delete Certificate.](https://tyk.io/docs/api-reference/certificates/delete-certificate.md): Delete certificate by their ID. - [Delete Certificate dependencies.](https://tyk.io/docs/api-reference/certificates/delete-certificate-dependencies.md): This endpoint will remove the certificates from any APIs that contains it as an upstream certificates or as a client certificate. It will also remove any key that uses this certificate. - [Get Certificate Dependencies.](https://tyk.io/docs/api-reference/certificates/get-certificate-dependencies.md): This will return the API IDs and API names of all APIs that uses this certificates as either upstream certificates or as client certificates. - [Get single certificate with ID.](https://tyk.io/docs/api-reference/certificates/get-single-certificate-with-id.md): Get a single certificate details with the certificate's ID. - [List all certificates details.](https://tyk.io/docs/api-reference/certificates/list-all-certificates-details.md): Return a list that contains certificates and their full details. - [List APIs lined to a certificate](https://tyk.io/docs/api-reference/certificates/list-apis-lined-to-a-certificate.md): Fetch APIs linked to a certificate - [List Certificates.](https://tyk.io/docs/api-reference/certificates/list-certificates.md): Return list of certificates. If you send the mode query parameter with the value `detailed` the certificates returned will have more information (Will contains all certs basic details). To retrieve a list with complete certificate details use [this endpoint](#operation/listDetailedCertificates). If… - [Add a certificate.](https://tyk.io/docs/api-reference/certs/add-a-certificate.md): Add a certificate to the Tyk Gateway. - [Delete certificate.](https://tyk.io/docs/api-reference/certs/delete-certificate.md): Delete certificate by ID. - [List certificates.](https://tyk.io/docs/api-reference/certs/list-certificates.md): List all certificates in the Tyk Gateway. - [Return one certificate or list multiple certificates in the Tyk Gateway given a comma separated list of cert IDs.](https://tyk.io/docs/api-reference/certs/return-one-certificate-or-list-multiple-certificates-in-the-tyk-gateway-given-a-comma-separated-list-of-cert-ids.md): Note that the certID path parameter can take a list of certIDs separated with commas (e.g /tyk/certs/certIDOne,certIDTwo). If you send a single certID it will return a single CertificateMeta object otherwise if you send more than two certIDs is will return an array of certificateMeta objects. - [Create a new chat history record](https://tyk.io/docs/api-reference/chat-history/create-a-new-chat-history-record.md): Create a new chat history record with the given input - [Delete a chat history record](https://tyk.io/docs/api-reference/chat-history/delete-a-chat-history-record.md): Delete a chat history record by its ID - [Get a chat history record](https://tyk.io/docs/api-reference/chat-history/get-a-chat-history-record.md): Get a chat history record by its ID - [List chat history records](https://tyk.io/docs/api-reference/chat-history/list-chat-history-records.md): List chat history records for a given user - [Update the name of a chat history record](https://tyk.io/docs/api-reference/chat-history/update-the-name-of-a-chat-history-record.md): Update the name of a chat history record for the authenticated user - [Create a new app for the authenticated user](https://tyk.io/docs/api-reference/common/create-a-new-app-for-the-authenticated-user.md): Create a new app associated with the authenticated user, checking for catalogue access and privacy score compatibility - [Delete an app owned by the authenticated user](https://tyk.io/docs/api-reference/common/delete-an-app-owned-by-the-authenticated-user.md): Delete an app if it's owned by the authenticated user - [Get accessible data sources for the authenticated user](https://tyk.io/docs/api-reference/common/get-accessible-data-sources-for-the-authenticated-user.md): Get the list of data sources accessible to the authenticated user - [Get accessible LLMs for the authenticated user](https://tyk.io/docs/api-reference/common/get-accessible-llms-for-the-authenticated-user.md): Get the list of LLMs accessible to the authenticated user - [Get accessible tools for the authenticated user](https://tyk.io/docs/api-reference/common/get-accessible-tools-for-the-authenticated-user.md): Get the list of tools accessible to the authenticated user based on their group memberships - [Get apps for the authenticated user](https://tyk.io/docs/api-reference/common/get-apps-for-the-authenticated-user.md): Get the list of apps created by the authenticated user - [Get chat history records for a user](https://tyk.io/docs/api-reference/common/get-chat-history-records-for-a-user.md): Get the chat history records for a specific user - [Get datasources in a data catalogue](https://tyk.io/docs/api-reference/common/get-datasources-in-a-data-catalogue.md): Get the list of datasources in a data catalogue by catalogue ID, excluding sensitive information - [Get default tools and datasource for a specific chat](https://tyk.io/docs/api-reference/common/get-default-tools-and-datasource-for-a-specific-chat.md): Get the default tools and datasource configured for a specific chat with redacted sensitive information - [Get details of a specific app for the authenticated user](https://tyk.io/docs/api-reference/common/get-details-of-a-specific-app-for-the-authenticated-user.md): Get the details of a specific app, including its credential, for the authenticated user - [Get LLMs in a catalogue](https://tyk.io/docs/api-reference/common/get-llms-in-a-catalogue.md): Get the list of LLMs in a catalogue by catalogue ID, excluding sensitive information - [Get messages for a session](https://tyk.io/docs/api-reference/common/get-messages-for-a-session.md): Get paginated messages for a given session ID, ordered from oldest to newest - [Check if compliance features are available](https://tyk.io/docs/api-reference/compliance/check-if-compliance-features-are-available.md): Returns whether compliance monitoring is available (Enterprise Edition) - [Export compliance data](https://tyk.io/docs/api-reference/compliance/export-compliance-data.md): Export compliance data in CSV format - [Get access issues](https://tyk.io/docs/api-reference/compliance/get-access-issues.md): Get authentication and authorization failures - [Get app risk profile](https://tyk.io/docs/api-reference/compliance/get-app-risk-profile.md): Get detailed compliance profile for a single app - [Get budget alerts](https://tyk.io/docs/api-reference/compliance/get-budget-alerts.md): Get apps/LLMs approaching or exceeding budget limits - [Get compliance errors](https://tyk.io/docs/api-reference/compliance/get-compliance-errors.md): Get error metrics by vendor - [Get compliance summary](https://tyk.io/docs/api-reference/compliance/get-compliance-summary.md): Get high-level compliance metrics for the dashboard - [Get high risk apps](https://tyk.io/docs/api-reference/compliance/get-high-risk-apps.md): Get apps ranked by compliance risk - [Get individual violation records](https://tyk.io/docs/api-reference/compliance/get-individual-violation-records.md): Get individual violation records with full details for drill-down view - [Get policy violations](https://tyk.io/docs/api-reference/compliance/get-policy-violations.md): Get filter blocks and model access violations - [Retrieve current configuration status](https://tyk.io/docs/api-reference/configuration/retrieve-current-configuration-status.md): Returns the current configuration status of the system. You can optionally filter for a specific configuration field. - [Retrieve environment variables](https://tyk.io/docs/api-reference/configuration/retrieve-environment-variables.md): Returns environment variables of the system. You can optionally filter for a specific configuration field. - [Activate a credential](https://tyk.io/docs/api-reference/credentials/activate-a-credential.md): Activate a credential by its ID - [Create a new credential](https://tyk.io/docs/api-reference/credentials/create-a-new-credential.md): Create a new credential - [Deactivate a credential](https://tyk.io/docs/api-reference/credentials/deactivate-a-credential.md): Deactivate a credential by its ID - [Delete a credential](https://tyk.io/docs/api-reference/credentials/delete-a-credential.md): Delete a credential by its ID - [Get a credential by ID](https://tyk.io/docs/api-reference/credentials/get-a-credential-by-id.md): Get details of a credential by its ID - [Get a credential by Key ID](https://tyk.io/docs/api-reference/credentials/get-a-credential-by-key-id.md): Get details of a credential by its Key ID - [List active credentials](https://tyk.io/docs/api-reference/credentials/list-active-credentials.md): Get a list of all active credentials - [List all credentials](https://tyk.io/docs/api-reference/credentials/list-all-credentials.md): Get a list of all credentials - [Update a credential](https://tyk.io/docs/api-reference/credentials/update-a-credential.md): Update an existing credential's information - [Create a new custom attribute](https://tyk.io/docs/api-reference/custom-attributes/create-a-new-custom-attribute.md): Create a new custom attribute for the extended model - [Delete a custom attribute](https://tyk.io/docs/api-reference/custom-attributes/delete-a-custom-attribute.md): Delete a custom attribute from this extended model - [Get a custom attribute](https://tyk.io/docs/api-reference/custom-attributes/get-a-custom-attribute.md): Get a custom attribute for a particular extended model - [Get a default attribute](https://tyk.io/docs/api-reference/custom-attributes/get-a-default-attribute.md): Get a default attribute for a particular extended model - [Get an extended model detail](https://tyk.io/docs/api-reference/custom-attributes/get-an-extended-model-detail.md): Get an extended attribute detail - [List all custom attributes for a particular extended model](https://tyk.io/docs/api-reference/custom-attributes/list-all-custom-attributes-for-a-particular-extended-model.md): Get a list of custom attributes for an extended model - [List all default attributes for a particular extended model](https://tyk.io/docs/api-reference/custom-attributes/list-all-default-attributes-for-a-particular-extended-model.md): Get attributes added to this extended model by default - [List all extended models](https://tyk.io/docs/api-reference/custom-attributes/list-all-extended-models.md): List all extended models for custom attributes - [Update a custom attribute](https://tyk.io/docs/api-reference/custom-attributes/update-a-custom-attribute.md): Update a custom attribute for a particular extended model - [Update default attribute](https://tyk.io/docs/api-reference/custom-attributes/update-default-attribute.md): Update a default attribute for a particular extended model to include it in the credential metadata - [Reloads dashboard urls](https://tyk.io/docs/api-reference/dashboard-url-reload/reloads-dashboard-urls.md): Reloads dashboard urls - [Add a datasource to a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/add-a-datasource-to-a-data-catalogue.md): Add a datasource to a specific data catalogue - [Add a tag to a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/add-a-tag-to-a-data-catalogue.md): Add a tag to a specific data catalogue - [Add datasource to data catalogue](https://tyk.io/docs/api-reference/data-catalogues/add-datasource-to-data-catalogue.md): Add a datasource to a specific data catalogue (Enterprise Edition only) - [Add tag to data catalogue](https://tyk.io/docs/api-reference/data-catalogues/add-tag-to-data-catalogue.md): Add a tag to a specific data catalogue (Enterprise Edition only) - [Create a new data catalogue](https://tyk.io/docs/api-reference/data-catalogues/create-a-new-data-catalogue.md): Create a new data catalogue (Enterprise Edition only) - [Create a new data catalogue](https://tyk.io/docs/api-reference/data-catalogues/create-a-new-data-catalogue-1.md): Create a new data catalogue with the provided information - [Delete a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/delete-a-data-catalogue.md): Delete a data catalogue by its ID - [Delete data catalogue](https://tyk.io/docs/api-reference/data-catalogues/delete-data-catalogue.md): Delete a specific data catalogue (Enterprise Edition only) - [Get a data catalogue by ID](https://tyk.io/docs/api-reference/data-catalogues/get-a-data-catalogue-by-id.md): Get details of a data catalogue by its ID - [Get data catalogue by ID](https://tyk.io/docs/api-reference/data-catalogues/get-data-catalogue-by-id.md): Get details of a specific data catalogue (Enterprise Edition only) - [Get data catalogues by datasource](https://tyk.io/docs/api-reference/data-catalogues/get-data-catalogues-by-datasource.md): Get all data catalogues containing a specific datasource (Enterprise Edition only) - [Get data catalogues by datasource](https://tyk.io/docs/api-reference/data-catalogues/get-data-catalogues-by-datasource-1.md): Get a list of data catalogues associated with a specific datasource - [Get data catalogues by tag](https://tyk.io/docs/api-reference/data-catalogues/get-data-catalogues-by-tag.md): Get all data catalogues with a specific tag (Enterprise Edition only) - [Get data catalogues by tag](https://tyk.io/docs/api-reference/data-catalogues/get-data-catalogues-by-tag-1.md): Get a list of data catalogues associated with a specific tag - [List all data catalogues](https://tyk.io/docs/api-reference/data-catalogues/list-all-data-catalogues.md): Get a list of all data catalogues - [List data catalogues](https://tyk.io/docs/api-reference/data-catalogues/list-data-catalogues.md): Get all data catalogues (Enterprise Edition only) - [Remove a datasource from a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/remove-a-datasource-from-a-data-catalogue.md): Remove a datasource from a specific data catalogue - [Remove a tag from a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/remove-a-tag-from-a-data-catalogue.md): Remove a tag from a specific data catalogue - [Remove datasource from data catalogue](https://tyk.io/docs/api-reference/data-catalogues/remove-datasource-from-data-catalogue.md): Remove a datasource from a specific data catalogue (Enterprise Edition only) - [Remove tag from data catalogue](https://tyk.io/docs/api-reference/data-catalogues/remove-tag-from-data-catalogue.md): Remove a tag from a specific data catalogue (Enterprise Edition only) - [Search data catalogues](https://tyk.io/docs/api-reference/data-catalogues/search-data-catalogues.md): Search data catalogues (Enterprise Edition only) - [Search data catalogues](https://tyk.io/docs/api-reference/data-catalogues/search-data-catalogues-1.md): Search for data catalogues using a query string - [Update a data catalogue](https://tyk.io/docs/api-reference/data-catalogues/update-a-data-catalogue.md): Update an existing data catalogue's information - [Update data catalogue](https://tyk.io/docs/api-reference/data-catalogues/update-data-catalogue.md): Update an existing data catalogue (Enterprise Edition only) - [Retrieve information of all the connected data plane nodes.](https://tyk.io/docs/api-reference/data-planes/retrieve-information-of-all-the-connected-data-plane-nodes.md): Provides a list of all the data plane nodes connected to MDCB. Data plane nodes are Tyk Gateways that make your APIs available to your consumers. MDCB offers centralised management of your data plane nodes. This endpoint offers metadata and status for all connected data plane nodes, allowing for mon… - [Add FileStore to Datasource](https://tyk.io/docs/api-reference/datasources/add-filestore-to-datasource.md): Add a FileStore to a specific Datasource - [Clone a datasource](https://tyk.io/docs/api-reference/datasources/clone-a-datasource.md): Creates a copy of an existing datasource including all API keys (server-side clone) - [Create a new datasource](https://tyk.io/docs/api-reference/datasources/create-a-new-datasource.md): Create a new datasource with the provided information - [Delete a datasource](https://tyk.io/docs/api-reference/datasources/delete-a-datasource.md): Delete a datasource by its ID - [Get a datasource by ID](https://tyk.io/docs/api-reference/datasources/get-a-datasource-by-id.md): Get details of a datasource by its ID - [Get datasources by tag](https://tyk.io/docs/api-reference/datasources/get-datasources-by-tag.md): Get a list of datasources associated with a specific tag - [List all datasources](https://tyk.io/docs/api-reference/datasources/list-all-datasources.md): Get a list of all datasources - [Process file embeddings for a datasource](https://tyk.io/docs/api-reference/datasources/process-file-embeddings-for-a-datasource.md): Process and create embeddings for all files in a datasource - [Remove FileStore from Datasource](https://tyk.io/docs/api-reference/datasources/remove-filestore-from-datasource.md): Remove a FileStore from a specific Datasource - [Search datasources](https://tyk.io/docs/api-reference/datasources/search-datasources.md): Search for datasources using a query string - [Update a datasource](https://tyk.io/docs/api-reference/datasources/update-a-datasource.md): Update an existing datasource's information - [CPU Profiling data](https://tyk.io/docs/api-reference/debug/cpu-profiling-data.md): Returns CPU profiling data. Available only when HTTPProfile is enabled in sink.conf. - [pprof data](https://tyk.io/docs/api-reference/debug/pprof-data.md): Serves various pprof data like heap, goroutine, threadcreate, block, and so on. The `{profileType}` path parameter can accept various profiling types as well as more complex patterns. Available only when HTTPProfile is enabled in sink.conf. - [Test a Tyk Classic or Tyk OAS API definition.](https://tyk.io/docs/api-reference/debug/test-a-tyk-classic-or-tyk-oas-api-definition.md): Used to test API definition by sending sample request and analysing output of both response and logs. - [Delete edge instance](https://tyk.io/docs/api-reference/edges/delete-edge-instance.md): Remove an edge instance registration - [Get edge instance by ID](https://tyk.io/docs/api-reference/edges/get-edge-instance-by-id.md): Get details of a specific edge instance - [Get edge reload operations](https://tyk.io/docs/api-reference/edges/get-edge-reload-operations.md): Get list of active reload operations - [List edge instances](https://tyk.io/docs/api-reference/edges/list-edge-instances.md): Get a list of registered edge instances with optional namespace filtering - [Reload all edge gateways](https://tyk.io/docs/api-reference/edges/reload-all-edge-gateways.md): Trigger a configuration reload for all edge gateways across all namespaces - [Trigger edge reload](https://tyk.io/docs/api-reference/edges/trigger-edge-reload.md): Trigger a configuration reload on a specific edge instance - [Download export file (Enterprise)](https://tyk.io/docs/api-reference/exports/download-export-file-enterprise.md): Downloads the exported proxy logs JSON file - [Get export status (Enterprise)](https://tyk.io/docs/api-reference/exports/get-export-status-enterprise.md): Retrieves the status of a proxy log export job - [Start a proxy log export (Enterprise)](https://tyk.io/docs/api-reference/exports/start-a-proxy-log-export-enterprise.md): Initiates a background job to export proxy logs for an app or LLM - [Create a new filestore entry](https://tyk.io/docs/api-reference/filestore/create-a-new-filestore-entry.md): Create a new filestore entry with an uploaded file - [Delete a filestore entry](https://tyk.io/docs/api-reference/filestore/delete-a-filestore-entry.md): Delete a filestore entry by its ID - [Get a filestore entry by ID](https://tyk.io/docs/api-reference/filestore/get-a-filestore-entry-by-id.md): Get details of a filestore entry by its ID - [Get all filestore entries](https://tyk.io/docs/api-reference/filestore/get-all-filestore-entries.md): Get a list of all filestore entries with pagination - [Search filestore entries](https://tyk.io/docs/api-reference/filestore/search-filestore-entries.md): Search for filestore entries by filename or description - [Update a filestore entry](https://tyk.io/docs/api-reference/filestore/update-a-filestore-entry.md): Update an existing filestore entry's information - [Create a new filter](https://tyk.io/docs/api-reference/filters/create-a-new-filter.md): Create a new filter with the given input data - [Delete a filter](https://tyk.io/docs/api-reference/filters/delete-a-filter.md): Delete a filter by its ID - [Get a filter by ID](https://tyk.io/docs/api-reference/filters/get-a-filter-by-id.md): Get a filter's details by its ID - [List all filters](https://tyk.io/docs/api-reference/filters/list-all-filters.md): Get a list of all filters - [Test a filter script](https://tyk.io/docs/api-reference/filters/test-a-filter-script.md): Execute a filter script with test input to validate behavior - [Update a filter](https://tyk.io/docs/api-reference/filters/update-a-filter.md): Update an existing filter's details - [Add a catalogue to a group](https://tyk.io/docs/api-reference/groups/add-a-catalogue-to-a-group.md): Add a catalogue to a specific group - [Add a data catalogue to a group](https://tyk.io/docs/api-reference/groups/add-a-data-catalogue-to-a-group.md): Add a data catalogue to a specific group - [Add a tool catalogue to a group](https://tyk.io/docs/api-reference/groups/add-a-tool-catalogue-to-a-group.md): Add a tool catalogue to a specific group - [Add a user to a group](https://tyk.io/docs/api-reference/groups/add-a-user-to-a-group.md): Add a user to a specific group - [Add data catalogue to group](https://tyk.io/docs/api-reference/groups/add-data-catalogue-to-group.md): Add a data catalogue to a specific group (Enterprise Edition only) - [Add LLM catalogue to group](https://tyk.io/docs/api-reference/groups/add-llm-catalogue-to-group.md): Add an LLM catalogue to a specific group (Enterprise Edition only) - [Add tool catalogue to group](https://tyk.io/docs/api-reference/groups/add-tool-catalogue-to-group.md): Add a tool catalogue to a specific group (Enterprise Edition only) - [Add user to group](https://tyk.io/docs/api-reference/groups/add-user-to-group.md): Add a user to a specific group (Enterprise Edition only) - [Create a new group](https://tyk.io/docs/api-reference/groups/create-a-new-group.md): Create a new group (Enterprise Edition only) - [Create a new group](https://tyk.io/docs/api-reference/groups/create-a-new-group-1.md): Create a new group with the provided information - [Delete a group](https://tyk.io/docs/api-reference/groups/delete-a-group.md): Delete a group by its ID - [Delete group](https://tyk.io/docs/api-reference/groups/delete-group.md): Delete a specific group (Enterprise Edition only) - [Get a group by ID](https://tyk.io/docs/api-reference/groups/get-a-group-by-id.md): Get details of a group by its ID - [Get group by ID](https://tyk.io/docs/api-reference/groups/get-group-by-id.md): Get details of a specific group (CE: Returns Default group only) - [Get groups for a user](https://tyk.io/docs/api-reference/groups/get-groups-for-a-user.md): Get a list of all groups a specific user belongs to - [Get user's groups](https://tyk.io/docs/api-reference/groups/get-users-groups.md): Get all groups for a specific user (CE: Returns Default group only) - [List all groups](https://tyk.io/docs/api-reference/groups/list-all-groups.md): Get a list of all groups - [List catalogues in a group](https://tyk.io/docs/api-reference/groups/list-catalogues-in-a-group.md): Get a list of all catalogues in a specific group - [List data catalogues in a group](https://tyk.io/docs/api-reference/groups/list-data-catalogues-in-a-group.md): Get a list of all data catalogues in a specific group - [List group data catalogues](https://tyk.io/docs/api-reference/groups/list-group-data-catalogues.md): Get all data catalogues for a specific group (Enterprise Edition only) - [List group LLM catalogues](https://tyk.io/docs/api-reference/groups/list-group-llm-catalogues.md): Get all LLM catalogues for a specific group (Enterprise Edition only) - [List group tool catalogues](https://tyk.io/docs/api-reference/groups/list-group-tool-catalogues.md): Get all tool catalogues for a specific group (Enterprise Edition only) - [List group users](https://tyk.io/docs/api-reference/groups/list-group-users.md): Get all users in a specific group (Enterprise Edition only) - [List groups](https://tyk.io/docs/api-reference/groups/list-groups.md): Get all groups (CE: Returns Default group only) - [List tool catalogues in a group](https://tyk.io/docs/api-reference/groups/list-tool-catalogues-in-a-group.md): Get a list of all tool catalogues in a specific group - [List users in a group](https://tyk.io/docs/api-reference/groups/list-users-in-a-group.md): Get a list of all users in a specific group - [Remove a catalogue from a group](https://tyk.io/docs/api-reference/groups/remove-a-catalogue-from-a-group.md): Remove a catalogue from a specific group - [Remove a data catalogue from a group](https://tyk.io/docs/api-reference/groups/remove-a-data-catalogue-from-a-group.md): Remove a data catalogue from a specific group - [Remove a tool catalogue from a group](https://tyk.io/docs/api-reference/groups/remove-a-tool-catalogue-from-a-group.md): Remove a tool catalogue from a specific group - [Remove a user from a group](https://tyk.io/docs/api-reference/groups/remove-a-user-from-a-group.md): Remove a user from a specific group - [Remove data catalogue from group](https://tyk.io/docs/api-reference/groups/remove-data-catalogue-from-group.md): Remove a data catalogue from a specific group (Enterprise Edition only) - [Remove LLM catalogue from group](https://tyk.io/docs/api-reference/groups/remove-llm-catalogue-from-group.md): Remove an LLM catalogue from a specific group (Enterprise Edition only) - [Remove tool catalogue from group](https://tyk.io/docs/api-reference/groups/remove-tool-catalogue-from-group.md): Remove a tool catalogue from a specific group (Enterprise Edition only) - [Remove user from group](https://tyk.io/docs/api-reference/groups/remove-user-from-group.md): Remove a user from a specific group (Enterprise Edition only) - [Update a group](https://tyk.io/docs/api-reference/groups/update-a-group.md): Update an existing group's information - [Update group](https://tyk.io/docs/api-reference/groups/update-group.md): Update an existing group (Enterprise Edition only) - [Update group catalogues](https://tyk.io/docs/api-reference/groups/update-group-catalogues.md): Bulk update all catalogues (LLM, data, tool) for a group (Enterprise Edition only) - [Update group catalogues](https://tyk.io/docs/api-reference/groups/update-group-catalogues-1.md): Update the catalogues in a specific group - [Update group users](https://tyk.io/docs/api-reference/groups/update-group-users.md): Bulk update users in a specific group (Enterprise Edition only) - [Update group users](https://tyk.io/docs/api-reference/groups/update-group-users-1.md): Update the users in a specific group - [Check the health of the Tyk Gateway.](https://tyk.io/docs/api-reference/health-checking/check-the-health-of-the-tyk-gateway.md): From v2.7.5 you can now rename the `/hello` endpoint by using the `health_check_endpoint_name` option. - [Check liveness status](https://tyk.io/docs/api-reference/health/check-liveness-status.md): Provides the liveness status of the service. - [Check system readiness status](https://tyk.io/docs/api-reference/health/check-system-readiness-status.md): Assesses the readiness of the system and its critical components. This endpoint determines if the system is prepared to handle requests by evaluating the status of essential services and dependencies. - [Health Check](https://tyk.io/docs/api-reference/health/health-check.md): Returns OK if the service is up and running. - [Hot-reload a group of Tyk nodes.](https://tyk.io/docs/api-reference/hot-reload/hot-reload-a-group-of-tyk-nodes.md): To reload a whole group of Tyk nodes (without using the Dashboard or host manager). You can send an API request to a single node, this node will then send a notification through the pub/sub infrastructure to all other listening nodes (including the host manager if it is being used to manage Nginx) w… - [Hot-reload a single node.](https://tyk.io/docs/api-reference/hot-reload/hot-reload-a-single-node.md): Tyk is capable of reloading configurations without having to stop serving requests. This means that API configurations can be added at runtime, or even modified at runtime and those rules applied immediately without any downtime. - [Import APIs](https://tyk.io/docs/api-reference/import/import-apis.md): The import APIs operates on lists of APIs. - [Import organisations](https://tyk.io/docs/api-reference/import/import-organisations.md): The organisation object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organisation and it’s APIs, Policies and API Tokens. - [Import Policies](https://tyk.io/docs/api-reference/import/import-policies.md): The import Policies operates on lists of Policies. - [Invalidate cache for given API ID.](https://tyk.io/docs/api-reference/jwk-cache-invalidation/invalidate-cache-for-given-api-id.md): Invalidate JWK cache for the given API. - [Invalidate JWK cache for all APIs](https://tyk.io/docs/api-reference/jwk-cache-invalidation/invalidate-jwk-cache-for-all-apis.md): Invalidate JWK cache for all APIs. - [Create a key.](https://tyk.io/docs/api-reference/keys/create-a-key.md): Creates a key. - [Create a key.](https://tyk.io/docs/api-reference/keys/create-a-key-1.md): Create a key. - [Create custom key.](https://tyk.io/docs/api-reference/keys/create-custom-key.md): Creates a key with a custom key ID. - [Create custom key / Import key](https://tyk.io/docs/api-reference/keys/create-custom-key-import-key.md): You can use this endpoint to import existing keys into Tyk or to create a new custom key. - [Delete a key.](https://tyk.io/docs/api-reference/keys/delete-a-key.md): Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available. - [Delete key.](https://tyk.io/docs/api-reference/keys/delete-key.md): Deleting a key will remove it permanently from the system. - [Delete key with API ID and key ID.](https://tyk.io/docs/api-reference/keys/delete-key-with-api-id-and-key-id.md): Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available. - [Get a key with ID.](https://tyk.io/docs/api-reference/keys/get-a-key-with-id.md): Get session info about the specified key. Should return up to date rate limit and quota usage numbers. - [Get key Details.](https://tyk.io/docs/api-reference/keys/get-key-details.md): Get the details of a key. - [Get key details with API ID and key ID.](https://tyk.io/docs/api-reference/keys/get-key-details-with-api-id-and-key-id.md): Fetches the key that grant access to the API with the ID {apiID} and key ID {keyID}. - [List All the keys.](https://tyk.io/docs/api-reference/keys/list-all-the-keys.md): Return a paginated list of keys. - [List All the Keys info.](https://tyk.io/docs/api-reference/keys/list-all-the-keys-info.md): List all the keys and all the keys details. If `q` query parameter is passed it will only return keys whose key ID contain the passed text. - [List keys.](https://tyk.io/docs/api-reference/keys/list-keys.md): List all the API keys. - [List keys by API.](https://tyk.io/docs/api-reference/keys/list-keys-by-api.md): Lists keys that grant access to the API with the ID {apiID}. - [Search keys by API.](https://tyk.io/docs/api-reference/keys/search-keys-by-api.md): Lists keys that grant access to the API with the ID {apiID}. When q query parameter is passed it will only return keys that contains the string sent by q. - [Set policies for a hashed key.](https://tyk.io/docs/api-reference/keys/set-policies-for-a-hashed-key.md): This will set policies to a hashed key. - [This will validate a key definition.](https://tyk.io/docs/api-reference/keys/this-will-validate-a-key-definition.md): This will check if the body of a key definition is valid. And return a response with how the key would look like if you create it. - [Update key.](https://tyk.io/docs/api-reference/keys/update-key.md): Update a key with it's id. - [With API ID and key ID.](https://tyk.io/docs/api-reference/keys/with-api-id-and-key-id.md): You can also manually add keys to Tyk using your own key-generation algorithm. It is recommended if using this approach to ensure that the OrgID being used in the API Definition and the key data is blank so that Tyk does not try to prepend or manage the key in any way. - [Create new LLM settings](https://tyk.io/docs/api-reference/llm-settings/create-new-llm-settings.md): Create new LLM settings with the provided information - [Delete LLM settings](https://tyk.io/docs/api-reference/llm-settings/delete-llm-settings.md): Delete LLM settings by its ID - [Get LLM settings by ID](https://tyk.io/docs/api-reference/llm-settings/get-llm-settings-by-id.md): Get details of LLM settings by its ID - [List all LLM settings](https://tyk.io/docs/api-reference/llm-settings/list-all-llm-settings.md): Get a list of all LLM settings - [Search LLM settings by model name](https://tyk.io/docs/api-reference/llm-settings/search-llm-settings-by-model-name.md): Search for LLM settings using a model name stub - [Update LLM settings](https://tyk.io/docs/api-reference/llm-settings/update-llm-settings.md): Update existing LLM settings information - [Create a new LLM](https://tyk.io/docs/api-reference/llms/create-a-new-llm.md): Create a new LLM with the provided information - [Delete an LLM](https://tyk.io/docs/api-reference/llms/delete-an-llm.md): Delete an LLM by its ID - [Get an LLM by ID](https://tyk.io/docs/api-reference/llms/get-an-llm-by-id.md): Get details of an LLM by its ID - [Get LLM plugin configuration](https://tyk.io/docs/api-reference/llms/get-llm-plugin-configuration.md): Get the configuration override for a specific plugin-LLM association - [Get LLM plugins](https://tyk.io/docs/api-reference/llms/get-llm-plugins.md): Get plugins associated with an LLM - [Get LLMs by maximum privacy score](https://tyk.io/docs/api-reference/llms/get-llms-by-maximum-privacy-score.md): Get a list of LLMs with privacy score less than or equal to the specified value - [Get LLMs by minimum privacy score](https://tyk.io/docs/api-reference/llms/get-llms-by-minimum-privacy-score.md): Get a list of LLMs with privacy score greater than or equal to the specified value - [Get LLMs by privacy score range](https://tyk.io/docs/api-reference/llms/get-llms-by-privacy-score-range.md): Get a list of LLMs with privacy score within the specified range - [List all LLMs](https://tyk.io/docs/api-reference/llms/list-all-llms.md): Get a list of all LLMs - [Search LLMs by name](https://tyk.io/docs/api-reference/llms/search-llms-by-name.md): Search for LLMs using a name stub - [Update an LLM](https://tyk.io/docs/api-reference/llms/update-an-llm.md): Update an existing LLM's information - [Update LLM plugin configuration](https://tyk.io/docs/api-reference/llms/update-llm-plugin-configuration.md): Update the configuration override for a specific plugin-LLM association - [Update LLM plugins](https://tyk.io/docs/api-reference/llms/update-llm-plugins.md): Update plugin associations for an LLM - [Migrate APIs from Tyk Classic to Tyk OAS format.](https://tyk.io/docs/api-reference/migrateoas/migrate-apis-from-tyk-classic-to-tyk-oas-format.md): Migrate APIs from Tyk Classic to Tyk OAS format. The endpoint supports different migration modes including dry run, staging, promotion and direct migration. - [Create a new model price](https://tyk.io/docs/api-reference/model-prices/create-a-new-model-price.md): Create a new model price with the provided information - [Delete a model price](https://tyk.io/docs/api-reference/model-prices/delete-a-model-price.md): Delete a model price by its ID - [Get a model price by ID](https://tyk.io/docs/api-reference/model-prices/get-a-model-price-by-id.md): Get details of a model price by its ID - [Get all model prices](https://tyk.io/docs/api-reference/model-prices/get-all-model-prices.md): Get a list of all model prices - [Get model prices by vendor](https://tyk.io/docs/api-reference/model-prices/get-model-prices-by-vendor.md): Get a list of model prices for a specific vendor - [Update a model price](https://tyk.io/docs/api-reference/model-prices/update-a-model-price.md): Update an existing model price's information without recalculating historical costs - [Update a model price and recalculate historical costs](https://tyk.io/docs/api-reference/model-prices/update-a-model-price-and-recalculate-historical-costs.md): Get a model price by its name, creating it with default values if it doesn't exist Update an existing model price's information and recalculate all historical chat record costs - [Update a model price and recalculate historical costs](https://tyk.io/docs/api-reference/model-prices/update-a-model-price-and-recalculate-historical-costs-1.md): Get a model price by its name, creating it with default values if it doesn't exist Update an existing model price's information and recalculate all historical chat record costs - [Create a new model router](https://tyk.io/docs/api-reference/model-routers/create-a-new-model-router.md): Create a new model router with pools, vendors, and mappings (Enterprise only) - [Delete a model router](https://tyk.io/docs/api-reference/model-routers/delete-a-model-router.md): Delete a model router by ID (Enterprise only) - [Get a model router by ID](https://tyk.io/docs/api-reference/model-routers/get-a-model-router-by-id.md): Get details of a model router by its ID (Enterprise only) - [List all model routers](https://tyk.io/docs/api-reference/model-routers/list-all-model-routers.md): Get a paginated list of all model routers (Enterprise only) - [Toggle model router active status](https://tyk.io/docs/api-reference/model-routers/toggle-model-router-active-status.md): Enable or disable a model router (Enterprise only) - [Update a model router](https://tyk.io/docs/api-reference/model-routers/update-a-model-router.md): Update an existing model router's information (Enterprise only) - [Get namespace edges](https://tyk.io/docs/api-reference/namespaces/get-namespace-edges.md): Get all edges in a namespace (Enterprise Edition only) - [Get reload operation status](https://tyk.io/docs/api-reference/namespaces/get-reload-operation-status.md): Get status of a specific reload operation - [List namespaces](https://tyk.io/docs/api-reference/namespaces/list-namespaces.md): List all namespaces (Enterprise Edition only) - [Reload namespace](https://tyk.io/docs/api-reference/namespaces/reload-namespace.md): Trigger reload for all edges in a namespace (Enterprise Edition only) - [Convert child API to base API.](https://tyk.io/docs/api-reference/oas-apis/convert-child-api-to-base-api.md): Convert a child API version into the new base API. This operation: - Moves all versioning/routing configuration from the current base API to the new base API - Converts the original base API into a child of the new base API - Preserves all version identifiers and default version settings - [Create OAS API.](https://tyk.io/docs/api-reference/oas-apis/create-oas-api.md): Create an API Definition in Tyk OAS API format. Note that the response includes the newly created Tyk OAS API Definition containing the unique identifier for the API (`ID`). You can provide a value for `ID` in the request body, otherwise Tyk will automatically generate a value. - [Delete OAS API.](https://tyk.io/docs/api-reference/oas-apis/delete-oas-api.md): Deleting an API definition will remove the file from the file store. The API definition will not be unloaded and a separate reload request will need to be made to disable the API endpoint. - [Dry Run OAS.](https://tyk.io/docs/api-reference/oas-apis/dry-run-oas.md): Generate a Tyk OAS API definition without saving it to the Dashboard database. This endpoint is used to produce a Tyk OAS API definition without creating the API proxy itself. This provides a dry run functionality for Tyk OAS API creation, showing what would be created in the Dashboard given the set… - [Export OAS API.](https://tyk.io/docs/api-reference/oas-apis/export-oas-api.md): Download API definition in OAS format (only APIs saved in OAS format). When you set the mode query parameter to public the OAS spec exported will exclude the x-tyk-api-gateway part. When mode query parameter is empty or is set to any other value apart from public then the exported OAS spec will incl… - [Get OAS API details.](https://tyk.io/docs/api-reference/oas-apis/get-oas-api-details.md): Get a single API definition in OAS format. - [Get OAS API server URLs.](https://tyk.io/docs/api-reference/oas-apis/get-oas-api-server-urls.md): Get the Tyk generated server URLs for a Tyk OAS API. This endpoint returns structured URL information including decomposed components (protocol, domain, listen path, version path, query parameters, and headers) for all server URLs that Tyk generates for the API. - [Get OAS API's Categories.](https://tyk.io/docs/api-reference/oas-apis/get-oas-apis-categories.md): Get a list of the API categories associated with the specified API. - [Import OAS.](https://tyk.io/docs/api-reference/oas-apis/import-oas.md): For use with an existing OpenAPI document that you want to expose via your Tyk Gateway.
Create a new Tyk OAS API from an OpenAPI document in JSON or YAML format (without x-tyk-api-gateway extension).
The payload can contain either a fully fledged OpenAPI document or a URL pointing to an O… - [List OAS API versions.](https://tyk.io/docs/api-reference/oas-apis/list-oas-api-versions.md): List all the versions of an OAS API. - [Patch a single OAS API by ID.](https://tyk.io/docs/api-reference/oas-apis/patch-a-single-oas-api-by-id.md): Update a Tyk OAS API. You can use this endpoint to update the OAS part of your Tyk OAS API definition. This endpoint allows you to configure the Tyk OAS extension based on the query parameters provided (similar to import). - [Update OAS API.](https://tyk.io/docs/api-reference/oas-apis/update-oas-api.md): Updating an API definition uses the same signature object as a `POST`. It will first ensure that the API ID being updated is the same as in the `PUT` object.
Updating will completely replace the file descriptor and will not change an API definition that has already been loaded. The hot-reload e… - [Update OAS API categories.](https://tyk.io/docs/api-reference/oas-apis/update-oas-api-categories.md): Update the list of API categories associated with the specified API. - [Create a new OAuth2.0 client.](https://tyk.io/docs/api-reference/oauth/create-a-new-oauth20-client.md): Client apps are created dynamically, the only parameter required to create a new client app with Tyk is to specify the redirect URI, this is used as part of the client authentication and cannot be edited later. Please note that if you don't attach a policy to the OAuth client you will need to provid… - [Create new OAuth client](https://tyk.io/docs/api-reference/oauth/create-new-oauth-client.md): Any OAuth keys must be generated with the help of a client ID. These need to be pre-registered with Tyk before they can be used (in a similar vein to how you would register your app with Twitter before attempting to ask user permissions using their API).

Creating OAuth… - [Delete OAuth client.](https://tyk.io/docs/api-reference/oauth/delete-oauth-client.md): You can delete an OAuth client using this endpoint. Please note that tokens issued with the client ID will still be valid until they expire. - [Get API IDs for APIS that use the specified client_id(appID) for OAuth](https://tyk.io/docs/api-reference/oauth/get-api-ids-for-apis-that-use-the-specified-client_idappid-for-oauth.md): Get all API IDs for APIs that have use_oauth2 enabled and use the client_id (appID) specified in the path parameter for OAuth2. You can use the org_id query parameter to specify from which organization you want the API IDs to be returned. To return APIs from all organizations, send org_id as an empt… - [Get OAuth client](https://tyk.io/docs/api-reference/oauth/get-oauth-client.md): Get OAuth client details tied to an api - [Get OAuth Consent Details](https://tyk.io/docs/api-reference/oauth/get-oauth-consent-details.md): Retrieves details for an OAuth consent request. Requires user authentication. - [Get single OAuth client details.](https://tyk.io/docs/api-reference/oauth/get-single-oauth-client-details.md): Get single OAuth client details with its client ID. - [Invalidate OAuth refresh token](https://tyk.io/docs/api-reference/oauth/invalidate-oauth-refresh-token.md): It is possible to invalidate refresh tokens in order to manage OAuth client access more robustly. - [List OAuth client tokens.](https://tyk.io/docs/api-reference/oauth/list-oauth-client-tokens.md): This endpoint allows you to retrieve a list of all current tokens and their expiry date for a provided API ID and OAuth client ID. - [List OAuth clients.](https://tyk.io/docs/api-reference/oauth/list-oauth-clients.md): Return all the auth 2 clients that have been registered with you tyk instance - [List tokens for a provided API ID and OAuth-client ID](https://tyk.io/docs/api-reference/oauth/list-tokens-for-a-provided-api-id-and-oauth-client-id.md): This endpoint allows you to retrieve a list of all current tokens and their expiry date for a provided API ID and OAuth-client ID .If page query parameter is sent the tokens will be paginated. This endpoint will work only for newly created tokens.

You can control… - [OAuth Authorization Endpoint](https://tyk.io/docs/api-reference/oauth/oauth-authorization-endpoint.md): Handles user authorization requests for OAuth clients. - [OAuth Authorization Server Metadata](https://tyk.io/docs/api-reference/oauth/oauth-authorization-server-metadata.md): Provides metadata about the OAuth authorization server. - [OAuth Token Endpoint](https://tyk.io/docs/api-reference/oauth/oauth-token-endpoint.md): Exchanges an authorization code for an access token. - [Purge lapsed OAuth tokens](https://tyk.io/docs/api-reference/oauth/purge-lapsed-oauth-tokens.md): Purge all lapsed OAuth token - [Purge OAuth tokens.](https://tyk.io/docs/api-reference/oauth/purge-oauth-tokens.md): Purge OAuth tokens. - [Register OAuth Client](https://tyk.io/docs/api-reference/oauth/register-oauth-client.md): Register a new OAuth client application. Public endpoint (auth will be added later). - [Revoke all client's tokens](https://tyk.io/docs/api-reference/oauth/revoke-all-clients-tokens.md): Revoke all the tokens for a given oauth client - [revoke token](https://tyk.io/docs/api-reference/oauth/revoke-token.md): revoke a single token - [Rotate the oath client secret](https://tyk.io/docs/api-reference/oauth/rotate-the-oath-client-secret.md): Generate a new secret - [Submit OAuth Consent](https://tyk.io/docs/api-reference/oauth/submit-oauth-consent.md): Submits user's consent decision (approve/deny) for an OAuth request. - [Update OAuth metadata,redirecturi,description and Policy ID](https://tyk.io/docs/api-reference/oauth/update-oauth-metadataredirecturidescription-and-policy-id.md): Allows you to update the metadata,redirecturi,description and Policy ID for an OAuth client. - [Create a new client type of an OAuth2.0 Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/create-a-new-client-type-of-an-oauth20-identity-provider.md): Create a new client type of an OAuth2.0 Identity Provider - [Delete a client type for an OAuth2.0 Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/delete-a-client-type-for-an-oauth20-identity-provider.md): Delete a client type for an OAuth2.0 Identity Provider. If the client type is used in any API Products, the endpoint will return 400 error. - [Delete an OAuth2.0 Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/delete-an-oauth20-identity-provider.md): Delete an OAuth2.0 provider. The OAuth2.0 provider and all related client types will be removed. If the provider is used in any API Products, the endpoint will return 400 error. - [Get a client type's data](https://tyk.io/docs/api-reference/oauth20-providers/get-a-client-types-data.md): Get a client type's data - [Get an Identity Provider's data](https://tyk.io/docs/api-reference/oauth20-providers/get-an-identity-providers-data.md): Get an OAuth2.0 provider's data - [List all client types for an OAuth2.0 Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/list-all-client-types-for-an-oauth20-identity-provider.md): List all client types for an OAuth2.0 provider - [List all OAuth2.0 Identity providers that are registered in the portal](https://tyk.io/docs/api-reference/oauth20-providers/list-all-oauth20-identity-providers-that-are-registered-in-the-portal.md): List all OAuth2.0 providers - [Register a new OAuth2.0 Identity Provider in the portal](https://tyk.io/docs/api-reference/oauth20-providers/register-a-new-oauth20-identity-provider-in-the-portal.md): Create a new OAuth2.0 provider - [Update a client type for an Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/update-a-client-type-for-an-identity-provider.md): Update a client type configuration such as its name, allowed grant types, allowed response types, and so on. Any existing credentials with this client type won't be updated, new and pending access requests with this client type will assume the new settings. - [Update an OAuth2.0 Identity Provider](https://tyk.io/docs/api-reference/oauth20-providers/update-an-oauth20-identity-provider.md): Update the OAuth2.0 provider configuration such its name, type, well-known endpoint URL, and the initial access token. Any existing credentials with this provider won't be updated, new and pending access requests with this provider will assume the new settings. - [List OPA rules.](https://tyk.io/docs/api-reference/open-policy-agent/list-opa-rules.md): List your organisation OPA rules. - [Update OPA rules.](https://tyk.io/docs/api-reference/open-policy-agent/update-opa-rules.md): Modify your OPA rules. - [Retrieve notifications](https://tyk.io/docs/api-reference/organisation-notifications/retrieve-notifications.md): Retrieve all notifications that have been issued for a specific Tyk Organisation. - [Create an organisation key](https://tyk.io/docs/api-reference/organisation-quotas/create-an-organisation-key.md): This work similar to Keys API except that Key ID is always equals Organisation ID - [Delete Key](https://tyk.io/docs/api-reference/organisation-quotas/delete-key.md): Deleting a key will remove all limits from organisation. It does not affects regular keys created within organisation. - [Get an Organisation Key](https://tyk.io/docs/api-reference/organisation-quotas/get-an-organisation-key.md): Get session info about specified organisation key. Should return up to date rate limit and quota usage numbers. - [List Organisation Keys](https://tyk.io/docs/api-reference/organisation-quotas/list-organisation-keys.md): You can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set 'rate' or 'per' to zer… - [Update Organisation Key](https://tyk.io/docs/api-reference/organisation-quotas/update-organisation-key.md): This work similar to Keys API except that Key ID is always equals Organisation ID - [Create a new developer organisation](https://tyk.io/docs/api-reference/organisations/create-a-new-developer-organisation.md): Create a new developer organisation - [Create an Organisation](https://tyk.io/docs/api-reference/organisations/create-an-organisation.md): Create an Organisation - [Delete an organisation](https://tyk.io/docs/api-reference/organisations/delete-an-organisation.md): Please note that this endpoint deletes an organisation but not its developers. When an organisation is deleted, all users are moved to the Default Organisation. To completely erase an organisation and all its users, delete the users first - [Generate Portals](https://tyk.io/docs/api-reference/organisations/generate-portals.md): Generate Portals - [Get an organisation](https://tyk.io/docs/api-reference/organisations/get-an-organisation.md): Get an organisation - [List all developer organisations](https://tyk.io/docs/api-reference/organisations/list-all-developer-organisations.md): List all developer organisations - [List all organisations](https://tyk.io/docs/api-reference/organisations/list-all-organisations.md): List all organisations - [Retrieve a single organisation](https://tyk.io/docs/api-reference/organisations/retrieve-a-single-organisation.md): Retrieve a single organisation - [Update an organisation](https://tyk.io/docs/api-reference/organisations/update-an-organisation.md): Update an organisation's data. At this point, you can change only the name of an organisation - [Update organisation details](https://tyk.io/docs/api-reference/organisations/update-organisation-details.md): Update Organisation details. This operation will replace the existing Organisation details with those provided in the request payload. It is important to provide the entire object - for example linked APIs - to avoid overwriting existing data with empty values. - [Create a new content block for a page](https://tyk.io/docs/api-reference/pages-and-content/create-a-new-content-block-for-a-page.md): Create a new content block for a page - [Create a new content page](https://tyk.io/docs/api-reference/pages-and-content/create-a-new-content-page.md): Create a new content page - [Delete a page](https://tyk.io/docs/api-reference/pages-and-content/delete-a-page.md): Delete a page - [Delete content blocks from this page](https://tyk.io/docs/api-reference/pages-and-content/delete-content-blocks-from-this-page.md): Delete content blocks from this page - [Get a content block](https://tyk.io/docs/api-reference/pages-and-content/get-a-content-block.md): Get a content block - [Get a page](https://tyk.io/docs/api-reference/pages-and-content/get-a-page.md): Get a page - [List all content blocks which are displayed on this page](https://tyk.io/docs/api-reference/pages-and-content/list-all-content-blocks-which-are-displayed-on-this-page.md): List all content blocks which are displayed on this page - [List all content pages](https://tyk.io/docs/api-reference/pages-and-content/list-all-content-pages.md): List all content pages. This doesn't include blog posts and API Products - [Update a content block](https://tyk.io/docs/api-reference/pages-and-content/update-a-content-block.md): Update a content block including the content and name - [Update a page](https://tyk.io/docs/api-reference/pages-and-content/update-a-page.md): Update a page including title, path, and status - [Create a new plan](https://tyk.io/docs/api-reference/plans/create-a-new-plan.md): Create a new plan - [Delete a plan](https://tyk.io/docs/api-reference/plans/delete-a-plan.md): Delete a plan - [Get a plan](https://tyk.io/docs/api-reference/plans/get-a-plan.md): Get a plan's details - [List all plans](https://tyk.io/docs/api-reference/plans/list-all-plans.md): List all plans that exist in the portal - [Update a plan](https://tyk.io/docs/api-reference/plans/update-a-plan.md): Update a plan - [Approve or deny plugin service scopes](https://tyk.io/docs/api-reference/plugins/approve-or-deny-plugin-service-scopes.md): Admin endpoint to approve or deny service access scopes for AI Studio plugins - [Call plugin RPC method](https://tyk.io/docs/api-reference/plugins/call-plugin-rpc-method.md): Execute RPC call on loaded AI Studio plugin - [Cleanup orphaned UI registry entries](https://tyk.io/docs/api-reference/plugins/cleanup-orphaned-ui-registry-entries.md): Remove UI registry entries for plugins that no longer exist - [Clear plugin data](https://tyk.io/docs/api-reference/plugins/clear-plugin-data.md): Delete all key-value data stored by a plugin - [Create plugin](https://tyk.io/docs/api-reference/plugins/create-plugin.md): Create a new plugin configuration - [Create plugin from OCI artifact](https://tyk.io/docs/api-reference/plugins/create-plugin-from-oci-artifact.md): Create a new AI Studio plugin from an OCI artifact reference - [Delete plugin](https://tyk.io/docs/api-reference/plugins/delete-plugin.md): Delete a plugin configuration - [Get AI Studio plugins with manifests](https://tyk.io/docs/api-reference/plugins/get-ai-studio-plugins-with-manifests.md): Get AI Studio plugins that have UI extension manifests - [Get plugin](https://tyk.io/docs/api-reference/plugins/get-plugin.md): Get a specific plugin by ID - [Get plugin status](https://tyk.io/docs/api-reference/plugins/get-plugin-status.md): Get the runtime status of a plugin (loaded, healthy, etc.) - [Get plugin workflow status](https://tyk.io/docs/api-reference/plugins/get-plugin-workflow-status.md): Get the current workflow status and approval state for a plugin - [Get plugins by type](https://tyk.io/docs/api-reference/plugins/get-plugins-by-type.md): Get plugins filtered by plugin type (gateway or ai_studio) - [Get sidebar menu items](https://tyk.io/docs/api-reference/plugins/get-sidebar-menu-items.md): Get sidebar menu items contributed by plugins - [Get UI registry](https://tyk.io/docs/api-reference/plugins/get-ui-registry.md): Get all registered UI components from plugins - [List cached OCI plugins](https://tyk.io/docs/api-reference/plugins/list-cached-oci-plugins.md): Get a list of all cached OCI plugins from the local cache - [List loaded plugins](https://tyk.io/docs/api-reference/plugins/list-loaded-plugins.md): Get status of all loaded AI Studio plugins - [List plugins](https://tyk.io/docs/api-reference/plugins/list-plugins.md): Get a list of plugins with optional filtering - [Load plugin UI](https://tyk.io/docs/api-reference/plugins/load-plugin-ui.md): Mark a plugin's UI as loaded - [Parse plugin manifest](https://tyk.io/docs/api-reference/plugins/parse-plugin-manifest.md): Parse and register a plugin's manifest - [Refresh OCI plugin](https://tyk.io/docs/api-reference/plugins/refresh-oci-plugin.md): Refresh an OCI plugin from the registry to get the latest version - [Reload AI Studio plugin](https://tyk.io/docs/api-reference/plugins/reload-ai-studio-plugin.md): Reload an AI Studio plugin and auto-fetch its manifest - [Serve plugin asset](https://tyk.io/docs/api-reference/plugins/serve-plugin-asset.md): Serve static assets for plugins (JS, CSS, images, etc.) - [Test plugin](https://tyk.io/docs/api-reference/plugins/test-plugin.md): Test a plugin configuration - [Unload plugin UI](https://tyk.io/docs/api-reference/plugins/unload-plugin-ui.md): Mark a plugin's UI as unloaded - [Update plugin](https://tyk.io/docs/api-reference/plugins/update-plugin.md): Update an existing plugin configuration - [Validate plugin command and load metadata](https://tyk.io/docs/api-reference/plugins/validate-plugin-command-and-load-metadata.md): Validates a plugin command and loads both config schema and manifest in a single operation - [Create a policy.](https://tyk.io/docs/api-reference/policies/create-a-policy.md): Create a policy in your Tyk Instance. - [Create policy definition.](https://tyk.io/docs/api-reference/policies/create-policy-definition.md): Creating policy definitions is slightly different to the core API, API definitions are wrapped inside an api_definition field and event handlers, such as webhooks are not embedded in the main api_definition object (though they can be), webhooks are instead appended as references into the hook_refere… - [Delete a policy.](https://tyk.io/docs/api-reference/policies/delete-a-policy.md): Delete a policy by ID in your Tyk instance. - [Delete a single policy by ID.](https://tyk.io/docs/api-reference/policies/delete-a-single-policy-by-id.md): Delete a Policy by ID. - [Get a policy.](https://tyk.io/docs/api-reference/policies/get-a-policy.md): You can retrieve details of a single policy by ID in your Tyk instance. - [Get a single policy by ID.](https://tyk.io/docs/api-reference/policies/get-a-single-policy-by-id.md): Get a policy by ID. - [Get list portal policies.](https://tyk.io/docs/api-reference/policies/get-list-portal-policies.md): Get list of policies. The result returned are paginated. Use the p query parameter to say which page you want returned. The default pagesize of the results is 10 but this can be changed in the dashboard config. - [List policies.](https://tyk.io/docs/api-reference/policies/list-policies.md): Retrieve all the policies in your Tyk instance. Returns an array policies. - [Search list of policies.](https://tyk.io/docs/api-reference/policies/search-list-of-policies.md): Search list of policies. If query parameter q is a policy ID it will look for policies that have the given ID. However if q is not a policy ID it will return policies with whose name matches the patten based via q query parameter. If you send a policy ID in query parameter q and also send query para… - [Update a policy.](https://tyk.io/docs/api-reference/policies/update-a-policy.md): You can update a Policy in your Tyk Instance by ID. - [Update policy definition.](https://tyk.io/docs/api-reference/policies/update-policy-definition.md): Update a policy definition. - [Get app interactions analytics for portal user](https://tyk.io/docs/api-reference/portal-analytics/get-app-interactions-analytics-for-portal-user.md): Get interaction analytics for a user's app - [Get app usage analytics for portal user](https://tyk.io/docs/api-reference/portal-analytics/get-app-usage-analytics-for-portal-user.md): Get token usage and cost analytics for a user's app - [Get the portal config](https://tyk.io/docs/api-reference/portal-configuration/get-the-portal-config.md): View the current configuration of the portal - [Attach a category to a post](https://tyk.io/docs/api-reference/posts/attach-a-category-to-a-post.md): Attach a category to a specific post. - [Attach a tag to a post](https://tyk.io/docs/api-reference/posts/attach-a-tag-to-a-post.md): Attach a tag to a specific post. - [Create a new post](https://tyk.io/docs/api-reference/posts/create-a-new-post.md): Create a new post. - [Delete a post](https://tyk.io/docs/api-reference/posts/delete-a-post.md): Delete a specific post by its ID. - [Detach a category from a post](https://tyk.io/docs/api-reference/posts/detach-a-category-from-a-post.md): Detach a category from a specific post. - [Detach a tag from a post](https://tyk.io/docs/api-reference/posts/detach-a-tag-from-a-post.md): Detach a tag from a specific post. - [Get a post by ID](https://tyk.io/docs/api-reference/posts/get-a-post-by-id.md): Get a specific post by its ID. - [List all posts](https://tyk.io/docs/api-reference/posts/list-all-posts.md): List all posts in the portal. - [List categories for a post](https://tyk.io/docs/api-reference/posts/list-categories-for-a-post.md): List all categories associated with a specific post. - [List tags for a post](https://tyk.io/docs/api-reference/posts/list-tags-for-a-post.md): List all tags associated with a specific post. - [Update a post](https://tyk.io/docs/api-reference/posts/update-a-post.md): Update a post's data such as title, content, status, and more. - [Attach a client type to this API Product](https://tyk.io/docs/api-reference/products/attach-a-client-type-to-this-api-product.md): Attach a client type to this API Product - [Attach a tag to this API Product](https://tyk.io/docs/api-reference/products/attach-a-tag-to-this-api-product.md): Attach a tag to this API Product - [Create a new product](https://tyk.io/docs/api-reference/products/create-a-new-product.md): Create a new product (regular API product or documentation-only product) - [Delete a product](https://tyk.io/docs/api-reference/products/delete-a-product.md): Delete a product - [Delete a tag from this API Product](https://tyk.io/docs/api-reference/products/delete-a-tag-from-this-api-product.md): Delete a tag from this API Product - [Delete the logo/product page image for this API Product](https://tyk.io/docs/api-reference/products/delete-the-logoproduct-page-image-for-this-api-product.md): Delete the logo/product page image for this API Product - [Delete the preview/catalogue page image for this API Product](https://tyk.io/docs/api-reference/products/delete-the-previewcatalogue-page-image-for-this-api-product.md): Delete the preview/catalogue page image for this API Product - [Detach a client type from this API Product](https://tyk.io/docs/api-reference/products/detach-a-client-type-from-this-api-product.md): Delete a client type from this API Product - [Get a client type attached to this API Product](https://tyk.io/docs/api-reference/products/get-a-client-type-attached-to-this-api-product.md): Get a client type attached to this API Product - [Get a product](https://tyk.io/docs/api-reference/products/get-a-product.md): Get a product - [Get a tag from this API Product](https://tyk.io/docs/api-reference/products/get-a-tag-from-this-api-product.md): Get a tag for this API Product - [Get the logo/product page image for this API Product](https://tyk.io/docs/api-reference/products/get-the-logoproduct-page-image-for-this-api-product.md): Get the logo/product page image for this API Product - [Get the preview/catalogue page image for this API Product](https://tyk.io/docs/api-reference/products/get-the-previewcatalogue-page-image-for-this-api-product.md): Get the preview/catalogue page image for this API Product - [List all client types for this API Product](https://tyk.io/docs/api-reference/products/list-all-client-types-for-this-api-product.md): List all client types attached to this API Product - [List all products](https://tyk.io/docs/api-reference/products/list-all-products.md): List all products available in the portal - [List all tags for this API Product](https://tyk.io/docs/api-reference/products/list-all-tags-for-this-api-product.md): List all tags attached to this API Product - [Update a product](https://tyk.io/docs/api-reference/products/update-a-product.md): Update a product (regular API product or documentation-only product) - [Upload a logo/product page image for this API Product](https://tyk.io/docs/api-reference/products/upload-a-logoproduct-page-image-for-this-api-product.md): Upload a logo/product page image for this API Product - [Upload a preview/catalogue page image for this API Product](https://tyk.io/docs/api-reference/products/upload-a-previewcatalogue-page-image-for-this-api-product.md): Upload a preview/catalogue page image for this API Product - [Configure provider credentials](https://tyk.io/docs/api-reference/providers/configure-provider-credentials.md): Set up credentials for a specific OpenAPI provider - [Create a new API Provider](https://tyk.io/docs/api-reference/providers/create-a-new-api-provider.md): Create a new API Provider. The new API Provider will have the 'Unknown' synchronization status until the first synchronization attempt - [Delete an API Provider](https://tyk.io/docs/api-reference/providers/delete-an-api-provider.md): This endpoint deletes an API Provider provider and removes all assets related to it such as API Products and Plans - [Get an API Provider configuration](https://tyk.io/docs/api-reference/providers/get-an-api-provider-configuration.md): Get an API Provider configuration - [Get API specifications from provider](https://tyk.io/docs/api-reference/providers/get-api-specifications-from-provider.md): Retrieve available API specifications from a specific provider - [Get import steps](https://tyk.io/docs/api-reference/providers/get-import-steps.md): Get the steps required for importing an OpenAPI specification - [Import OpenAPI spec](https://tyk.io/docs/api-reference/providers/import-openapi-spec.md): Import an OpenAPI specification using the specified method - [List all API Providers](https://tyk.io/docs/api-reference/providers/list-all-api-providers.md): List all API Providers connected to this portal instance - [List available OpenAPI providers](https://tyk.io/docs/api-reference/providers/list-available-openapi-providers.md): Get a list of all registered OpenAPI specification providers - [Synchronize API Products and plans with an API Provider](https://tyk.io/docs/api-reference/providers/synchronize-api-products-and-plans-with-an-api-provider.md): Synchronize API Products and plans with an API Provider - [Update Provider](https://tyk.io/docs/api-reference/providers/update-provider.md): Update Provider - [Proxy API request](https://tyk.io/docs/api-reference/proxy/proxy-api-request.md): Forwards a request to a specified gateway endpoint. This endpoint allows you to send requests to other services through the Tyk gateway, which can be useful for testing or accessing protected resources. - [Get OAS schema.](https://tyk.io/docs/api-reference/schema/get-oas-schema.md): Get OAS schema definition using a version. - [Get all API definition schemas.](https://tyk.io/docs/api-reference/schemas/get-all-api-definition-schemas.md): Get all API definition schemas. - [Get API definition OAS schema.](https://tyk.io/docs/api-reference/schemas/get-api-definition-oas-schema.md): Get API definition OAS schema. An alias to `/api/schemas/apidefs/oas`. - [Get API definition OAS schema.](https://tyk.io/docs/api-reference/schemas/get-api-definition-oas-schema-1.md): Get API definition OAS schema. - [Get API definition Streams OAS schema.](https://tyk.io/docs/api-reference/schemas/get-api-definition-streams-oas-schema.md): Retrieve schema for Tyk Streams APIs, enabling developers and integrators to validate or generate stream-based API definitions programmatically. Optionally select the OAS version and pretty-print formatting. - [Create a new secret](https://tyk.io/docs/api-reference/secrets/create-a-new-secret.md): Create a new secret with the provided information - [Delete a secret](https://tyk.io/docs/api-reference/secrets/delete-a-secret.md): Delete a secret by its ID - [Get a secret by ID](https://tyk.io/docs/api-reference/secrets/get-a-secret-by-id.md): Get details of a secret by its ID - [List all secrets](https://tyk.io/docs/api-reference/secrets/list-all-secrets.md): Get a paginated list of all secrets - [Update a secret](https://tyk.io/docs/api-reference/secrets/update-a-secret.md): Update an existing secret's information - [Generate authentication token](https://tyk.io/docs/api-reference/single-sign-on/generate-authentication-token.md): The Dashboard exposes the /admin/sso Dashboard API which allows you to generate a temporary authentication token, valid for 60 seconds. - [Create a new SSO profile](https://tyk.io/docs/api-reference/sso-profiles/create-a-new-sso-profile.md): Create a new SSO profile with the provided information - [Delete an SSO profile](https://tyk.io/docs/api-reference/sso-profiles/delete-an-sso-profile.md): Delete an SSO profile by its ID - [Get an SSO profile](https://tyk.io/docs/api-reference/sso-profiles/get-an-sso-profile.md): Get an SSO profile by ID - [Get an SSO profile by ID](https://tyk.io/docs/api-reference/sso-profiles/get-an-sso-profile-by-id.md): Get details of an SSO profile by its ID - [Get the profile used in the login page](https://tyk.io/docs/api-reference/sso-profiles/get-the-profile-used-in-the-login-page.md): Get the profile that has UseInLoginPage set to true - [List all SSO profiles](https://tyk.io/docs/api-reference/sso-profiles/list-all-sso-profiles.md): Get a list of all SSO profiles with pagination - [Set profile use in login page](https://tyk.io/docs/api-reference/sso-profiles/set-profile-use-in-login-page.md): Set a profile to be used in the login page - [Update an SSO profile](https://tyk.io/docs/api-reference/sso-profiles/update-an-sso-profile.md): Update an existing SSO profile's information - [Create Streams API.](https://tyk.io/docs/api-reference/streams-apis/create-streams-api.md): Create a Streams API Definition in Tyk OAS API format. Note that the response includes the newly created Tyk Streams API Definition containing the unique identifier for the API (`ID`). You can provide a value for `ID` in the request body, otherwise Tyk will automatically generate a value. - [Delete Streams API.](https://tyk.io/docs/api-reference/streams-apis/delete-streams-api.md): Deleting a Streams API definition will remove the file from the file store. The API definition will not be unloaded and a separate reload request will need to be made to disable the API endpoint. - [Get Streams API details.](https://tyk.io/docs/api-reference/streams-apis/get-streams-api-details.md): Get a single Streams API definition. - [Patch a single Streams API by ID.](https://tyk.io/docs/api-reference/streams-apis/patch-a-single-streams-api-by-id.md): Update a Tyk Streams API. You can use this endpoint to update the OAS part of your Tyk Streams API definition. This endpoint allows you to configure the Tyk OAS extension based on the query parameters provided (similar to import). - [Update Streams API.](https://tyk.io/docs/api-reference/streams-apis/update-streams-api.md): Updating an API definition uses the same signature object as a `POST`. It will first ensure that the API ID being updated is the same as in the `PUT` object.
Updating will completely replace the file descriptor and will not change an API definition that has already been loaded. The hot-reload e… - [Get sync audit log](https://tyk.io/docs/api-reference/sync/get-sync-audit-log.md): Get sync audit log entries with filtering - [Get sync status for namespace](https://tyk.io/docs/api-reference/sync/get-sync-status-for-namespace.md): Get detailed synchronization status for a specific namespace - [Get sync status summary](https://tyk.io/docs/api-reference/sync/get-sync-status-summary.md): Get synchronization status for all namespaces - [Get system feature set](https://tyk.io/docs/api-reference/system/get-system-feature-set.md): Returns the current system feature set from licensing - [Get system usage info.](https://tyk.io/docs/api-reference/system/get-system-usage-info.md): 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. - [Create a new tag](https://tyk.io/docs/api-reference/tags/create-a-new-tag.md): Create a new tag with the provided information - [Delete a tag](https://tyk.io/docs/api-reference/tags/delete-a-tag.md): Delete a tag by its ID - [Get a tag](https://tyk.io/docs/api-reference/tags/get-a-tag.md): Get a tag - [Get a tag by ID](https://tyk.io/docs/api-reference/tags/get-a-tag-by-id.md): Get details of a tag by its ID - [List all tags](https://tyk.io/docs/api-reference/tags/list-all-tags.md): Get a list of all tags - [Search tags by name](https://tyk.io/docs/api-reference/tags/search-tags-by-name.md): Search for tags using a name stub - [Update a tag](https://tyk.io/docs/api-reference/tags/update-a-tag.md): Update an existing tag's information - [Create a new team for an organisation](https://tyk.io/docs/api-reference/teams/create-a-new-team-for-an-organisation.md): Create a new team for an organisation - [Delete a team from an organisation](https://tyk.io/docs/api-reference/teams/delete-a-team-from-an-organisation.md): This endpoint deletes a team from an organisation. Please note that developers that belong to that team won't be removed. Instead, they will be moved to the default team of that organisation - [Get teams for an organisation](https://tyk.io/docs/api-reference/teams/get-teams-for-an-organisation.md): Get teams for an organisation - [List all teams for an organisation](https://tyk.io/docs/api-reference/teams/list-all-teams-for-an-organisation.md): List all teams for an organisation - [Update a team for an organisation](https://tyk.io/docs/api-reference/teams/update-a-team-for-an-organisation.md): Update a team for an organisation by adding or removing users, or changing the name of the team - [Activate a theme](https://tyk.io/docs/api-reference/themes/activate-a-theme.md): Activate a theme. When a new theme is activated, it becomes the current theme for the live portal and is displayed to all developers visiting the portal - [Download a theme](https://tyk.io/docs/api-reference/themes/download-a-theme.md): Download a theme as a zip archive - [Get a theme](https://tyk.io/docs/api-reference/themes/get-a-theme.md): Get metadata for a theme such as name, author, version and status - [List all themes](https://tyk.io/docs/api-reference/themes/list-all-themes.md): List all themes - [Soft delete a theme](https://tyk.io/docs/api-reference/themes/soft-delete-a-theme.md): Soft delete a theme by its ID - [Upload a theme](https://tyk.io/docs/api-reference/themes/upload-a-theme.md): This endpoint uploads a theme that is archived as a zip file to the portal. - [Add a tag to a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/add-a-tag-to-a-tool-catalogue.md): Add a tag to a specified tool catalogue - [Add a tool to a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/add-a-tool-to-a-tool-catalogue.md): Add a tool to a specified tool catalogue - [Add tag to tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/add-tag-to-tool-catalogue.md): Add a tag to a specific tool catalogue (Enterprise Edition only) - [Add tool to tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/add-tool-to-tool-catalogue.md): Add a tool to a specific tool catalogue (Enterprise Edition only) - [Create a new tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/create-a-new-tool-catalogue.md): Create a new tool catalogue (Enterprise Edition only) - [Create a new tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/create-a-new-tool-catalogue-1.md): Create a new tool catalogue with the provided information - [Delete a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/delete-a-tool-catalogue.md): Delete a tool catalogue by its ID - [Delete tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/delete-tool-catalogue.md): Delete a specific tool catalogue (Enterprise Edition only) - [Get a tool catalogue by ID](https://tyk.io/docs/api-reference/tool-catalogues/get-a-tool-catalogue-by-id.md): Get details of a tool catalogue by its ID - [Get tags in a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/get-tags-in-a-tool-catalogue.md): Get all tags in a specified tool catalogue - [Get tool catalogue by ID](https://tyk.io/docs/api-reference/tool-catalogues/get-tool-catalogue-by-id.md): Get details of a specific tool catalogue (Enterprise Edition only) - [Get tool catalogue tags](https://tyk.io/docs/api-reference/tool-catalogues/get-tool-catalogue-tags.md): Get all tags for a specific tool catalogue (Enterprise Edition only) - [Get tool documentation](https://tyk.io/docs/api-reference/tool-catalogues/get-tool-documentation.md): Get documentation for a specific tool (Enterprise Edition only) - [Get tools in a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/get-tools-in-a-tool-catalogue.md): Get all tools in a specified tool catalogue - [Get tools in a tool catalogue (secure version for portal users)](https://tyk.io/docs/api-reference/tool-catalogues/get-tools-in-a-tool-catalogue-secure-version-for-portal-users.md): Get all tools in a specified tool catalogue with sensitive fields hidden - [Get user apps for a tool](https://tyk.io/docs/api-reference/tool-catalogues/get-user-apps-for-a-tool.md): Get all user apps that use a specific tool (Enterprise Edition only) - [List all tool catalogues](https://tyk.io/docs/api-reference/tool-catalogues/list-all-tool-catalogues.md): Get a list of all tool catalogues - [List tool catalogue tools](https://tyk.io/docs/api-reference/tool-catalogues/list-tool-catalogue-tools.md): Get all tools in a specific tool catalogue (Enterprise Edition only) - [List tool catalogue tools (secure)](https://tyk.io/docs/api-reference/tool-catalogues/list-tool-catalogue-tools-secure.md): Get all tools in a specific tool catalogue with redacted sensitive data (Enterprise Edition only) - [List tool catalogues](https://tyk.io/docs/api-reference/tool-catalogues/list-tool-catalogues.md): Get all tool catalogues (Enterprise Edition only) - [Remove a tag from a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/remove-a-tag-from-a-tool-catalogue.md): Remove a tag from a specified tool catalogue - [Remove a tool from a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/remove-a-tool-from-a-tool-catalogue.md): Remove a tool from a specified tool catalogue - [Remove tag from tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/remove-tag-from-tool-catalogue.md): Remove a tag from a specific tool catalogue (Enterprise Edition only) - [Remove tool from tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/remove-tool-from-tool-catalogue.md): Remove a tool from a specific tool catalogue (Enterprise Edition only) - [Search tool catalogues](https://tyk.io/docs/api-reference/tool-catalogues/search-tool-catalogues.md): Search tool catalogues (Enterprise Edition only) - [Search tool catalogues](https://tyk.io/docs/api-reference/tool-catalogues/search-tool-catalogues-1.md): Search for tool catalogues using a query string - [Update a tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/update-a-tool-catalogue.md): Update an existing tool catalogue's information - [Update tool catalogue](https://tyk.io/docs/api-reference/tool-catalogues/update-tool-catalogue.md): Update an existing tool catalogue (Enterprise Edition only) - [Add dependency to tool](https://tyk.io/docs/api-reference/tools/add-dependency-to-tool.md): Add a dependency to a specific tool - [Add FileStore to Tool](https://tyk.io/docs/api-reference/tools/add-filestore-to-tool.md): Add a FileStore to a specific Tool - [Add Filter to Tool](https://tyk.io/docs/api-reference/tools/add-filter-to-tool.md): Add a Filter to a specific Tool - [Add operation to tool](https://tyk.io/docs/api-reference/tools/add-operation-to-tool.md): Add an operation to a specific tool - [Call Tool Operation](https://tyk.io/docs/api-reference/tools/call-tool-operation.md): Call an operation from the tool's OpenAPI specification - [Create a new tool](https://tyk.io/docs/api-reference/tools/create-a-new-tool.md): Create a new tool with the provided information - [Delete a tool](https://tyk.io/docs/api-reference/tools/delete-a-tool.md): Delete a tool by its ID - [Get a tool by ID](https://tyk.io/docs/api-reference/tools/get-a-tool-by-id.md): Get details of a tool by its ID - [Get all tools](https://tyk.io/docs/api-reference/tools/get-all-tools.md): Get a list of all tools - [Get tool dependencies](https://tyk.io/docs/api-reference/tools/get-tool-dependencies.md): Get all dependencies associated with a specific tool - [Get tool documentation by ID](https://tyk.io/docs/api-reference/tools/get-tool-documentation-by-id.md): Get documentation for a specific tool by its ID - [Get Tool FileStores](https://tyk.io/docs/api-reference/tools/get-tool-filestores.md): Get all FileStores associated with a specific Tool - [Get Tool Filters](https://tyk.io/docs/api-reference/tools/get-tool-filters.md): Get all Filters associated with a specific Tool - [Get tool operations](https://tyk.io/docs/api-reference/tools/get-tool-operations.md): Get all operations associated with a specific tool - [Get tools by type](https://tyk.io/docs/api-reference/tools/get-tools-by-type.md): Get a list of tools of a specific type - [Get user apps that have access to a tool](https://tyk.io/docs/api-reference/tools/get-user-apps-that-have-access-to-a-tool.md): Get list of user's apps that have been granted access to a specific tool - [List Tool Operations from OpenAPI Spec](https://tyk.io/docs/api-reference/tools/list-tool-operations-from-openapi-spec.md): List all operations available in the tool's OpenAPI specification - [Remove dependency from tool](https://tyk.io/docs/api-reference/tools/remove-dependency-from-tool.md): Remove a dependency from a specific tool - [Remove FileStore from Tool](https://tyk.io/docs/api-reference/tools/remove-filestore-from-tool.md): Remove a FileStore from a specific Tool - [Remove Filter from Tool](https://tyk.io/docs/api-reference/tools/remove-filter-from-tool.md): Remove a Filter from a specific Tool - [Remove operation from tool](https://tyk.io/docs/api-reference/tools/remove-operation-from-tool.md): Remove an operation from a specific tool - [Search tools](https://tyk.io/docs/api-reference/tools/search-tools.md): Search for tools by name or description - [Set tool dependencies](https://tyk.io/docs/api-reference/tools/set-tool-dependencies.md): Replace all dependencies for a specific tool - [Set Tool FileStores](https://tyk.io/docs/api-reference/tools/set-tool-filestores.md): Replace all FileStore associations for a specific Tool - [Set Tool Filters](https://tyk.io/docs/api-reference/tools/set-tool-filters.md): Replace all Filter associations for a specific Tool - [Update a tool](https://tyk.io/docs/api-reference/tools/update-a-tool.md): Update an existing tool's information - [Change order of tutorial pages](https://tyk.io/docs/api-reference/tutorials-for-api-products/change-order-of-tutorial-pages.md): Change order of tutorial pages in an API Product - [Create a new tutorial page for this API Product](https://tyk.io/docs/api-reference/tutorials-for-api-products/create-a-new-tutorial-page-for-this-api-product.md): Create a new tutorial page for this API Product - [Delete a tutorial page from this API Product](https://tyk.io/docs/api-reference/tutorials-for-api-products/delete-a-tutorial-page-from-this-api-product.md): Delete a tutorial page from this API Product - [Get a tutorial page](https://tyk.io/docs/api-reference/tutorials-for-api-products/get-a-tutorial-page.md): Get a tutorial page - [List all tutorials for this API Product](https://tyk.io/docs/api-reference/tutorials-for-api-products/list-all-tutorials-for-this-api-product.md): List all tutorials for this API Product - [Update a tutorial page](https://tyk.io/docs/api-reference/tutorials-for-api-products/update-a-tutorial-page.md): Update a tutorial page including its metadata and content - [Create an API with Tyk OAS format.](https://tyk.io/docs/api-reference/tyk-oas-apis/create-an-api-with-tyk-oas-format.md): Create an API with Tyk OAS API format on the Tyk Gateway. - [Deleting a Tyk OAS API.](https://tyk.io/docs/api-reference/tyk-oas-apis/deleting-a-tyk-oas-api.md): Deleting an API definition will remove the file from the file store, the API definition will not be unloaded, a separate reload request will need to be made to disable the API endpoint. - [Download a Tyk OAS format API.](https://tyk.io/docs/api-reference/tyk-oas-apis/download-a-tyk-oas-format-api.md): Use the mode query parameter to specify if you want the x-tyk-api-gateway stripped out. - [Download all Tyk OAS format APIs.](https://tyk.io/docs/api-reference/tyk-oas-apis/download-all-tyk-oas-format-apis.md): Download all Tyk OAS format APIs, from the Gateway. - [Get a Tyk OAS API definition.](https://tyk.io/docs/api-reference/tyk-oas-apis/get-a-tyk-oas-api-definition.md): Get Tyk OAS API definition using an API ID. - [Import an API in Tyk OAS format.](https://tyk.io/docs/api-reference/tyk-oas-apis/import-an-api-in-tyk-oas-format.md): Import an Tyk OAS format API without x-tyk-gateway. For use with an existing Tyk OAS API that you want to expose via your Tyk Gateway. - [List all APIs in Tyk OAS API format.](https://tyk.io/docs/api-reference/tyk-oas-apis/list-all-apis-in-tyk-oas-api-format.md): List all APIs in Tyk OAS API format, from Tyk Gateway. - [Listing versions of a Tyk OAS API.](https://tyk.io/docs/api-reference/tyk-oas-apis/listing-versions-of-a-tyk-oas-api.md): Listing versions of a Tyk OAS API. - [Patch API in Tyk OAS format.](https://tyk.io/docs/api-reference/tyk-oas-apis/patch-api-in-tyk-oas-format.md): You can use this endpoint to update Tyk OAS part of the Tyk API definition. This endpoint allows you to configure Tyk OAS extension based on query params provided(similar to import). - [Update a Tyk OAS API definition.](https://tyk.io/docs/api-reference/tyk-oas-apis/update-a-tyk-oas-api-definition.md): Updating an API definition uses the same signature an object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`. - [Create user group.](https://tyk.io/docs/api-reference/usergroup/create-user-group.md): Instead of assigning permission to each individual users, per user, you can create a user group and configure the permissions for all users in the group. This endpoint allow you to create a user group and set permission for the user group. - [Delete user group.](https://tyk.io/docs/api-reference/usergroup/delete-user-group.md): Delete user group using the group ID. - [Get user group details.](https://tyk.io/docs/api-reference/usergroup/get-user-group-details.md): Return a user group object with all the details of a specified group. - [List user groups.](https://tyk.io/docs/api-reference/usergroup/list-user-groups.md): This will return a list of all the user groups. The returned user groups are paginated. - [Update user group.](https://tyk.io/docs/api-reference/usergroup/update-user-group.md): Update the details of a user group. You must have either admin or user groups permission to be able to modify user groups. Note you cannot update the ResetPassword permission with this endpoint. For that you need to use Admin API. When updating a user group you also need to specify at least one perm… - [Add user.](https://tyk.io/docs/api-reference/users/add-user.md): Create a user. If you want to create an admin user, you need to send {IsAdmin: admin} in the user_permissions field e.g ```{user_permissions: {IsAdmin: admin},last_name: sasuke,email_address: itachi@gmail.com,first_name: itachi}```. You can add a user to a given user-group by sending the group_id in… - [Allow password reset for a User](https://tyk.io/docs/api-reference/users/allow-password-reset-for-a-user.md): Allow password reset for a User. - [Create a new user](https://tyk.io/docs/api-reference/users/create-a-new-user.md): Create a new user with the provided information - [Create a user](https://tyk.io/docs/api-reference/users/create-a-user.md): Add a user to the dashboard - [Delete a custom attribute](https://tyk.io/docs/api-reference/users/delete-a-custom-attribute.md): Delete a user custom attribute - [Delete a user](https://tyk.io/docs/api-reference/users/delete-a-user.md): Delete a user by their ID - [Disallow password reset for a User](https://tyk.io/docs/api-reference/users/disallow-password-reset-for-a-user.md): Disallow password reset for a User. - [Get a user](https://tyk.io/docs/api-reference/users/get-a-user.md): Get a user - [Get a user by ID](https://tyk.io/docs/api-reference/users/get-a-user-by-id.md): Get details of a user by their ID - [Get a user custom attribute](https://tyk.io/docs/api-reference/users/get-a-user-custom-attribute.md): Get a user custom attribute - [Get current user.](https://tyk.io/docs/api-reference/users/get-current-user.md): Return a user object with the details of the current user. This request need to have a session cookie with the key authorisation. - [Get extended custom attributes for user](https://tyk.io/docs/api-reference/users/get-extended-custom-attributes-for-user.md): Get extended custom attributes for user - [Get user accessible catalogues](https://tyk.io/docs/api-reference/users/get-user-accessible-catalogues.md): Get a list of all catalogues accessible to a user - [Get user details](https://tyk.io/docs/api-reference/users/get-user-details.md): Get user summary with user id - [List all users](https://tyk.io/docs/api-reference/users/list-all-users.md): List all admin users and developers - [List all users with optional search filter](https://tyk.io/docs/api-reference/users/list-all-users-with-optional-search-filter.md): Get a list of all users, optionally filtered by search term - [List users](https://tyk.io/docs/api-reference/users/list-users.md): Lists dashboard users - [Reset user Dashboard API access credentials.](https://tyk.io/docs/api-reference/users/reset-user-dashboard-api-access-credentials.md): Reset specified user's Dashboard API access credentials by generating a new access key for the specified user. - [Revoke user.](https://tyk.io/docs/api-reference/users/revoke-user.md): This will set the use account as inactive. It will also disable API Access and log out the user from all dashboards. - [Roll API Key](https://tyk.io/docs/api-reference/users/roll-api-key.md): Generate a new API key for a user - [Search user with email.](https://tyk.io/docs/api-reference/users/search-user-with-email.md): This endpoint allows you to search for users with their email address (e.g if you send the filter @gmail.com` in the request payload, all users whole email contain the string @gmail.com will be returned). - [Search Users(Deprecated)](https://tyk.io/docs/api-reference/users/search-usersdeprecated.md): This endpoint allows you to search for users by providing their email address as a query parameter. - [Set user password.](https://tyk.io/docs/api-reference/users/set-user-password.md): Set a user's password. The password need to be 6 character long. If you are trying to update another users password you also need to have permission to update they password or you need to be a super-admin. You cannot also reuse a password. - [Skip user quick start wizard](https://tyk.io/docs/api-reference/users/skip-user-quick-start-wizard.md): Set a user's skip_quick_start flag to true - [Update a user](https://tyk.io/docs/api-reference/users/update-a-user.md): Update an existing user's information - [Update a user custom attribute](https://tyk.io/docs/api-reference/users/update-a-user-custom-attribute.md): Update a user custom attribute value if write once set false - [Update user.](https://tyk.io/docs/api-reference/users/update-user.md): Update a user with user ID. If you update the user as inactive they will be logged out of all dashboard sessions. User password can only be updated via admin API or the update password endpoint. ResetPassword is also only available via the admin API. - [Update user details](https://tyk.io/docs/api-reference/users/update-user-details.md): Update user details with the user ID - [Get available embedders](https://tyk.io/docs/api-reference/vendors/get-available-embedders.md): Get a list of available embedders - [Get available LLM drivers](https://tyk.io/docs/api-reference/vendors/get-available-llm-drivers.md): Get a list of available LLM drivers - [Get available vector stores](https://tyk.io/docs/api-reference/vendors/get-available-vector-stores.md): Get a list of available vector stores - [Add a new header to a webhook](https://tyk.io/docs/api-reference/webhooks/add-a-new-header-to-a-webhook.md): Adds a new header to an existing webhook. - [Create a new webhook](https://tyk.io/docs/api-reference/webhooks/create-a-new-webhook.md): Creates a new webhook configuration. - [Create a webhook.](https://tyk.io/docs/api-reference/webhooks/create-a-webhook.md): Create a webhook. The webhook method and target_path fields are required. Method can either be DELETE,GET,PUT,POST or PATCH. - [Delete a header by ID for a specific webhook](https://tyk.io/docs/api-reference/webhooks/delete-a-header-by-id-for-a-specific-webhook.md): Removes a header from a webhook. - [Delete a webhook by ID](https://tyk.io/docs/api-reference/webhooks/delete-a-webhook-by-id.md): Removes a webhook using its unique identifier. - [Delete web hook.](https://tyk.io/docs/api-reference/webhooks/delete-web-hook.md): Delete webhook with ID. - [Get a header by ID for a specific webhook](https://tyk.io/docs/api-reference/webhooks/get-a-header-by-id-for-a-specific-webhook.md): Retrieves the details of a specific header associated with a given webhook. Useful for inspecting custom headers configured for webhook delivery. - [Get a webhook by ID](https://tyk.io/docs/api-reference/webhooks/get-a-webhook-by-id.md): Retrieves a webhook using its unique identifier. - [Get single webhook.](https://tyk.io/docs/api-reference/webhooks/get-single-webhook.md): Get a webhook details with its ID. - [List all headers for a webhook](https://tyk.io/docs/api-reference/webhooks/list-all-headers-for-a-webhook.md): Retrieves all headers for a specific webhook. - [List all webhooks](https://tyk.io/docs/api-reference/webhooks/list-all-webhooks.md): Retrieves all configured webhooks. - [List webhooks.](https://tyk.io/docs/api-reference/webhooks/list-webhooks.md): Return a paginated list of webhooks. - [Update a header by ID for a specific webhook](https://tyk.io/docs/api-reference/webhooks/update-a-header-by-id-for-a-specific-webhook.md): Updates an existing header in a webhook. - [Update a webhook by ID](https://tyk.io/docs/api-reference/webhooks/update-a-webhook-by-id.md): Updates an existing webhook's configuration using its unique identifier. - [Update Webhook](https://tyk.io/docs/api-reference/webhooks/update-webhook.md): Update a web hook using its ID. The webhook method and target_path fields are required in the request body when updating. *Note the original webhook data will be completely replaced with the new update request object(so if for example you don't send the name or webhook_id fields in your request body… - [Tyk API Management Deployment Options](https://tyk.io/docs/apim.md): How to decide on which Tyk deployment option is best for you - [Installation Options for Tyk Gateway](https://tyk.io/docs/apim/open-source/installation.md): This page serves as a comprehensive guide to installing Tyk Gateway Open Source - [Sign Requests with HMAC](https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/hmac-signatures.md): How to configure HMAC Signatures in Tyk - [JSON Web Token (JWT) Authentication](https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/json-web-tokens.md): How to use JWT Authentication with Tyk - [Combine Authentication Methods](https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/multiple-auth.md): How to combine multiple authentication methods in Tyk to enhance security and flexibility. - [Open (No Authentication)](https://tyk.io/docs/basic-config-and-security/security/authentication-authorization/open-keyless.md): How to configure open or keyless authentication in Tyk. - [External Services Configuration](https://tyk.io/docs/configure/external-service.md): Complete guide to configuring external services in Tyk Gateway including proxy settings, mutual TLS, and service-specific configurations - [Tyk Dashboard Admin API](https://tyk.io/docs/dashboard-admin-api.md): Tyk Dashboard Admin API documentation. This page provides details on how to use the Tyk Dashboard Admin API for setting up and provisioning a Tyk Dashboard instance. - [Container Runtimes](https://tyk.io/docs/deployment-and-operations/container-runtimes.md): Tyk runs as OCI-compatible containers and works with Docker, containerd, CRI-O, and Podman. Learn which runtimes are supported and how to configure each for local and Kubernetes deployments. - [Quick Start Tyk Gateway](https://tyk.io/docs/deployment-and-operations/tyk-open-source-api-gateway/quick-start.md): This page serves as a comprehensive guide to migrating workloads to Tyk Open Source - [Explore Demos and Proof of Concepts](https://tyk.io/docs/deployment-and-operations/tyk-self-managed/tyk-demos-and-pocs/overview.md): Explore Tyk demos and proof of concepts to quickly set up Tyk Self-Managed, including the Tyk Gateway, Dashboard, and analytics processing pipeline. - [Community Support](https://tyk.io/docs/developer-support/community.md): Developer support mechanisms, release notes and upgrading information for your Tyk installation - [Contributing to Tyk documentation](https://tyk.io/docs/developer-support/contributing.md): How to contribute to Tyk documentation - [Contributing Guides](https://tyk.io/docs/developer-support/contribution-guides.md): Guide to releasing Tyk documentation - [Tyk Deprecation and EOL Policy](https://tyk.io/docs/developer-support/deprecation.md): Official schedule and information regarding Tyk component deprecation and End-of-Life (EOL). - [Inclusive Naming](https://tyk.io/docs/developer-support/documentation-projects/inclusive-naming.md): Explains the inclusive naming initiative concerning Tyk docs - [Frequently Asked Questions](https://tyk.io/docs/developer-support/faq.md): Frequently asked questions about Tyk, including configuration file backups, gateway version checking, and high traffic handling. - [Releasing Tyk Docs](https://tyk.io/docs/developer-support/release-guide.md): Guide to releasing Tyk documentation - [Archived Releases](https://tyk.io/docs/developer-support/release-notes/archived.md): Tyk Old releases - [Tyk Cloud Release Notes](https://tyk.io/docs/developer-support/release-notes/cloud.md): Release notes documenting updates, enhancements, and changes for Tyk Cloud - [Tyk Dashboard Release Notes](https://tyk.io/docs/developer-support/release-notes/dashboard.md): Release notes documenting updates, enhancements, and changes for Tyk Dashboard. - [Tyk Gateway Release Notes](https://tyk.io/docs/developer-support/release-notes/gateway.md): Release notes documenting updates, enhancements, and changes for Tyk Gateway. - [Tyk Charts Release Notes](https://tyk.io/docs/developer-support/release-notes/helm-chart.md): Release notes documenting updates, enhancements and changes for Tyk Charts. - [Tyk Multi Data Center Bridge Release Notes](https://tyk.io/docs/developer-support/release-notes/mdcb.md): Tyk Multi Data-Center Bridge v2.8 release notes - [Tyk Operator Release Notes](https://tyk.io/docs/developer-support/release-notes/operator.md): Release notes documenting updates, enhancements, fixes and changes for Tyk Operator. - [Latest Tyk Releases](https://tyk.io/docs/developer-support/release-notes/overview.md): Explore Tyk's latest releases. Here you will find latest releases and access to docker images and release notes for all our platforms. - [Tyk Enterprise Developer Portal Release Notes](https://tyk.io/docs/developer-support/release-notes/portal.md): Release notes documenting updates, enhancements and changes for Tyk Enterprise Developer Portal - [Tyk Pump Release Notes](https://tyk.io/docs/developer-support/release-notes/pump.md): Release notes documenting updates, enhancements and changes for Tyk Pump versions within the 1.X.X series. - [Tyk Sync Release Notes](https://tyk.io/docs/developer-support/release-notes/sync.md): Release notes documenting updates, enhancements, fixes and changes for Tyk Sync. - [Tyk Identity Broker Release Notes](https://tyk.io/docs/developer-support/release-notes/tib.md): Release notes documenting updates, enhancements, and changes for Tyk Identity Broker versions within the 1.6.x series. - [Early Access Features](https://tyk.io/docs/developer-support/release-types/early-access-feature.md): Explain what Early Access Features means and what to expect - [Tyk FIPS Policy](https://tyk.io/docs/developer-support/release-types/fips-release.md): Explain what FIPS Release means, what it includes, and what to expect - [Lab Release](https://tyk.io/docs/developer-support/release-types/lab-release.md): Explain what Lab Release means, what it includes, and what to expect - [Long Term Support Release](https://tyk.io/docs/developer-support/release-types/long-term-support.md): Long Term Releases and how we support them - [Support SLA](https://tyk.io/docs/developer-support/support.md): Learn about Tyk's flexible support offerings and how your specific entitlements are defined. - [Tyk Upgrading Guide](https://tyk.io/docs/developer-support/upgrading.md): Tyk upgrade guide for different deployment models and installation types - [Tyk QuickStart: Configure Your First API](https://tyk.io/docs/getting-started/configure-first-api.md): Configure your first API on Tyk Cloud - [Create Tyk Account](https://tyk.io/docs/getting-started/create-account.md): Create your account on Tyk Cloud - [URL Path Matching](https://tyk.io/docs/getting-started/key-concepts/url-matching.md): Overview of URL path matching with the Tyk Gateway - [Getting Started with Tyk Self-Managed](https://tyk.io/docs/getting-started/quick-start.md): Quickly set up Tyk Self-Managed with our comprehensive guide, including installation options and demo environments. - [Using Tyk Dashboard](https://tyk.io/docs/getting-started/using-tyk-dashboard.md): Configure your first API in Tyk Cloud - [Tyk API Gateway Documentation](https://tyk.io/docs/index.md) - [gRPC Proxy](https://tyk.io/docs/key-concepts/grpc-proxy.md): How to use gRPC in Tyk - [TCP Proxy](https://tyk.io/docs/key-concepts/tcp-proxy.md): Describe how you can use Tyk as a simple TCP Proxy - [Plan Your API Integration](https://tyk.io/docs/plan-your-api-integration.md): Plan your first API integration - [Planning for Production](https://tyk.io/docs/planning-for-production.md): How to plan for production deployment of Tyk Gateway - [Database Management](https://tyk.io/docs/planning-for-production/database-settings.md): How to configure Tyk's data storage for production - [Circuit Breakers](https://tyk.io/docs/planning-for-production/ensure-high-availability/circuit-breakers.md): How to configure Tyk's circuit breaker middleware to protect your upstream services from repeated failures and overloading. - [Gateway Configuration Inspection](https://tyk.io/docs/planning-for-production/ensure-high-availability/config-inspection.md): How to inspect the live configuration of a running Tyk Gateway using the built-in configuration inspection endpoints. - [Enforced Timeouts](https://tyk.io/docs/planning-for-production/ensure-high-availability/enforced-timeouts.md): Learn how to use Tyk's Enforced Timeout middleware to manage upstream service response times, ensuring system stability and optimal performance. - [Graceful Shutdown in Tyk](https://tyk.io/docs/planning-for-production/ensure-high-availability/graceful-shutdown.md): Graceful Shutdown in Tyk - [Liveness Health Checks](https://tyk.io/docs/planning-for-production/ensure-high-availability/health-check.md): How to set up liveness health checks for the Tyk Gateway to ensure high availability and monitor the status of components like Redis, Dashboard, and RPC. - [Load Balancing](https://tyk.io/docs/planning-for-production/ensure-high-availability/load-balancing.md): How to set up round-robin load balancing in Tyk Gateway and Dashboard, including dynamic load balancing with service discovery. - [Service Discovery](https://tyk.io/docs/planning-for-production/ensure-high-availability/service-discovery.md): How to configure service discovery in Tyk - [Uptime Tests](https://tyk.io/docs/planning-for-production/ensure-high-availability/uptime-tests.md): How to configure uptime tests - [Monitor Tyk Stack](https://tyk.io/docs/planning-for-production/monitoring/tyk-components.md): How to monitor Tyk components in production - [API Consumers](https://tyk.io/docs/portal/api-consumer.md): Tyk Developer Portal users - [API Owners](https://tyk.io/docs/portal/api-owner.md): Tyk Developer Portal administrators - [API Plans](https://tyk.io/docs/portal/api-plans.md): Working with API Plans - [API Products](https://tyk.io/docs/portal/api-products.md): Working with API Products - [API Providers](https://tyk.io/docs/portal/api-provider.md): All about API Providers with Tyk Developer Portal - [TLS Certificates](https://tyk.io/docs/portal/certificates.md): Managing Client Certificates with Developer Portal - [Developer Portal Customization](https://tyk.io/docs/portal/customization.md): Customization options for enterprise developer portal - [Customize Branding in Developer Portal](https://tyk.io/docs/portal/customization/branding.md): How to customize branding in developer portal - [Customize Email Notification in Developer Portal](https://tyk.io/docs/portal/customization/email-notifications.md): How to customize email notification in developer portal - [Markdown in Developer Portal](https://tyk.io/docs/portal/customization/markdown.md): Markdown capabilities, supported features, and known limitations when writing content in the Tyk Enterprise Developer Portal - [Customize Menus in Developer Portal](https://tyk.io/docs/portal/customization/menus.md): How to customize menus in developer portal - [Customize Pages in Developer Portal](https://tyk.io/docs/portal/customization/pages.md): How to customize pages in developer portal - [Customize Sign Up Form in Developer Portal](https://tyk.io/docs/portal/customization/sign-up.md): How to customize sign up form in developer portal - [Customize Templates in Developer Portal](https://tyk.io/docs/portal/customization/templates.md): How to customize templates in developer portal - [Customize Themes in Developer Portal](https://tyk.io/docs/portal/customization/themes.md): How to customize themes in developer portal - [Customize User Model in Developer Portal](https://tyk.io/docs/portal/customization/user-model.md): How to customize user model in developer portal - [Customize Webhooks in Developer Portal](https://tyk.io/docs/portal/customization/webhooks.md): How to customize webhooks in developer portal - [Developer Apps](https://tyk.io/docs/portal/developer-app.md): All about Developer Apps with Tyk Developer Portal - [Install Developer Portal](https://tyk.io/docs/portal/install.md): Install Tyk Developer Portal using Docker, Kubernetes, or Linux packages. This page explains the architecture, requirements, and how to install and bootstrap the portal. - [Install Developer Portal on Docker](https://tyk.io/docs/portal/install/docker.md): Installation guide for the Tyk Developer Portal on Docker - [Install Developer Portal on Kubernetes](https://tyk.io/docs/portal/install/kubernetes.md): Installation guide for the Tyk Developer Portal on Kubernetes using Helm charts - [Install Developer Portal on Linux Distributions](https://tyk.io/docs/portal/install/linux.md): Installation guide for the Tyk Developer Portal on Linux distributions using Ubuntu, Debian, Red Hat, and CentOS - [Core Concepts of Tyk Developer Portal](https://tyk.io/docs/portal/overview/concepts.md): Understand the fundamental concepts behind the Tyk Developer Portal, including APIs, access control, and customisation. - [Set up the Developer Portal](https://tyk.io/docs/portal/overview/getting-started.md): Get started quickly with setting up and using the Tyk Developer Portal. - [Tyk Developer Portal](https://tyk.io/docs/portal/overview/intro.md): Learn what the Tyk Developer Portal is, its key features, and how it supports API management. - [Publish your first API Catalog](https://tyk.io/docs/portal/publish-api-catalog.md): Build an API Catalog on the Tyk Developer Portal. - [Request access to an API](https://tyk.io/docs/portal/request-access.md): Create aa App to consume a Product published on the Tyk Developer Portal. - [Migrate Resources Between Environments](https://tyk.io/docs/portal/resource-migration.md): Learn how to migrate resources between environments in the Tyk Enterprise Developer Portal. - [Managing Webcrawlers](https://tyk.io/docs/portal/webcrawlers.md): Configuring your Live Portal to restrit webcrawlers and bots - [Helm Chart Overview](https://tyk.io/docs/product-stack/tyk-charts/overview.md): Explains an overview of Tyk charts - [Tyk Control Plane Chart](https://tyk.io/docs/product-stack/tyk-charts/tyk-control-plane-chart.md): Explains the Tyk Control Plane Chart - [Tyk Data Plane Chart](https://tyk.io/docs/product-stack/tyk-charts/tyk-data-plane-chart.md): Install and configure Tyk Data Plane - [Tyk Open Source Chart](https://tyk.io/docs/product-stack/tyk-charts/tyk-oss-chart.md): Explains the Tyk Open Source Chart - [Tyk Stack Chart](https://tyk.io/docs/product-stack/tyk-charts/tyk-stack-chart.md): Install and configure Tyk Stack Chart - [Reference list of Endpoints in the Developer Portal API](https://tyk.io/docs/product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-api-list-of-endpoints.md): Internal APIs exposed by Tyk Developer Portal - [Tyk Developer Portal API](https://tyk.io/docs/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api.md): Tyk Developer Portal API documentation. This page provides details on how to use the Tyk Developer Portal Management API for managing portal resources. - [Environment Variables and Configuration](https://tyk.io/docs/product-stack/tyk-enterprise-developer-portal/deploy/configuration.md): Configuration reference for the Tyk Enterprise Developer Portal - [Set up email notification service](https://tyk.io/docs/product-stack/tyk-enterprise-developer-portal/getting-started/setup-email-notifications.md): Learn how to set up email notifications in the Tyk Enterprise Developer Portal. - [Custom Plugins with Tyk Operator](https://tyk.io/docs/product-stack/tyk-operator/advanced-configurations/custom-plugins.md): Learn how to configure custom plugins with Tyk Operator in Kubernetes for API request lifecycle management. - [GraphQL Federation with Tyk Operator](https://tyk.io/docs/product-stack/tyk-operator/advanced-configurations/graphql-federation.md): Learn how to implement GraphQL Federation using Tyk Operator in Kubernetes, enabling a unified API from multiple subgraphs. - [Internal Looping With Tyk Operator](https://tyk.io/docs/product-stack/tyk-operator/advanced-configurations/internal-looping.md): Learn how to configure internal looping in Tyk Operator for URL rewrites, triggers, and proxying to internal APIs. - [Management Multiple Organization With Tyk Operator](https://tyk.io/docs/product-stack/tyk-operator/getting-started/tyk-operator-multiple-organisations.md): Learn how to manage multiple organizations with Tyk Operator by defining OperatorContext and referencing it in API definitions. - [Tyk Operator as Ingress Controller](https://tyk.io/docs/product-stack/tyk-operator/tyk-ingress-controller.md): Learn how to use Tyk Operator as an Ingress Controller to manage API traffic in Kubernetes - [Tyk Sync Commands](https://tyk.io/docs/product-stack/tyk-sync/commands.md): Learn about the Tyk Sync commands for managing API configurations, examples, and deployments. - [Install Tyk Sync](https://tyk.io/docs/product-stack/tyk-sync/installing-tyk-sync.md): Learn how to install Tyk Sync using Docker or Packagecloud - [URL Rewriting](https://tyk.io/docs/transform-traffic/url-rewriting.md): How to rewrite URL in Tyk - [Tyk APIs Hub](https://tyk.io/docs/tyk-apis.md): The Tyk API Hub. In this section you will find OpenAPI docs for the APIs for Tyk Gateway, Tyk Dashboard and other Tyk products - [Set Up Tyk Cloud](https://tyk.io/docs/tyk-cloud.md): This page serves as a comprehensive guide to migrating workloads to Tyk Cloud - [Manage Accounts and Billing in Tyk Cloud](https://tyk.io/docs/tyk-cloud/account-billing.md): Learn how to manage your Tyk Cloud account, including payment plans, billing methods, and account retirement. - [Deploy Hybrid Gateways with Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/hybrid-gateways.md): Learn how to deploy and manage hybrid gateways in Tyk Cloud, connecting your self-managed data planes to the Tyk Cloud control plane. - [Managing Control Planes in Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/managing-control-planes.md): Learn how to manage Control Planes in Tyk Cloud - [Managing Environments in Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/managing-environments.md): Learn how to manage Environments in Tyk Cloud - [Managing Data Planes in Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/managing-gateways.md): Learn how to manage Data Planes in Tyk Cloud - [Managing Organizations in Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/managing-organisations.md): Learn how to manage organizations in Tyk Cloud, including organization, teams, deployments, and environments. - [How monitoring works in Tyk Cloud](https://tyk.io/docs/tyk-cloud/environments-deployments/monitoring-how-it-works.md): Learn how Tyk Cloud monitors throughput and storage metrics for your deployments. - [Configure Developer Portal in Tyk Cloud](https://tyk.io/docs/tyk-cloud/initial-portal-config.md): Learn how to set up and configure the Developer Portal in Tyk Cloud Control Plane deployments. - [Managing and Securing your APIs Tyk Cloud](https://tyk.io/docs/tyk-cloud/securing-your-apis.md): Learn how to manage and secure your APIs in Tyk Cloud Control Plane deployments. - [Manage Teams and Users in Tyk Cloud](https://tyk.io/docs/tyk-cloud/teams-users.md): Learn how to manage teams and users in Tyk Cloud, including user roles, team management, and single sign-on (SSO) configuration. - [Configure Single Sign-On (SSO) in Tyk Cloud](https://tyk.io/docs/tyk-cloud/teams-users/single-sign-on.md): Learn how to set up and manage Single Sign-On (SSO) in Tyk Cloud Control Plane deployments. - [Configure Telemetry in Tyk Cloud](https://tyk.io/docs/tyk-cloud/telemetry.md): Learn how to set up and manage telemetry in Tyk Cloud for distributed tracing of your APIs. - [Troubleshooting Tyk Cloud](https://tyk.io/docs/tyk-cloud/troubleshooting-support.md): Learn how to troubleshoot common issues in Tyk Cloud, including FAQs and support resources. - [Configure Custom Domains in Tyk Cloud](https://tyk.io/docs/tyk-cloud/using-custom-domains.md): Learn how to set up custom domains for Tyk Cloud Control Planes and Cloud Data Planes. - [Configure Custom Plugins in Tyk Cloud](https://tyk.io/docs/tyk-cloud/using-plugins.md): Learn how to set up and manage custom plugins in Tyk Cloud Control Plane deployments. - [Tyk Components](https://tyk.io/docs/tyk-components.md): Explaining Tyk Components - [Using external Key Value storage with Tyk](https://tyk.io/docs/tyk-configuration-reference/kv-store.md): Learn how to use external Key-Value storage with Tyk Gateway, including Consul and Vault, to manage configuration data and secrets. - [Configure Redis Cluster and Sentinel](https://tyk.io/docs/tyk-configuration-reference/redis-cluster-sentinel.md): This page provides guidance on configuring Tyk to work with Redis Cluster and Sentinel, including TLS encryption and troubleshooting tips. - [Tyk Identity Broker Configuration Options](https://tyk.io/docs/tyk-configuration-reference/tyk-identity-broker-configuration.md): Configuration options for Tyk Identity Broker (TIB), including settings for profiles, backends, and Tyk API integration. - [Tyk Dashboard API](https://tyk.io/docs/tyk-dashboard-api.md): Tyk Dashboard API documentation. This page provides details on how to use the Tyk Dashboard API for managing organisations, users, API definitions, and more. - [Tyk Dashboard Configuration Options](https://tyk.io/docs/tyk-dashboard/configuration.md): Configuration options and environment variables for Tyk Dashboard. - [How to Request Access to API Products Using Direct Access Flow](https://tyk.io/docs/tyk-developer-portal/direct-access-flow.md): This guide explains how to use the Direct Access Flow in the Tyk Developer Portal to request access to API products without the shopping cart, including creating applications, attaching credentials, changing plans, and admin configuration. - [Enable and View Audit Logs in Tyk Developer Portal](https://tyk.io/docs/tyk-developer-portal/enable-audit-logs-portal.md): Learn how to enable audit logging in Tyk Developer Portal and access the audit log file to track admin actions. - [How to Set Up the GraphQL Playground](https://tyk.io/docs/tyk-developer-portal/graphql-playground.md): Learn how to set up and use the GraphQL Playground in the Tyk Developer Portal - [How to Associate API Products with Tyk Managed Custom Credentials](https://tyk.io/docs/tyk-developer-portal/import-custom-credentials.md): This guide explains how an admin of the Tyk Developer Portal can associate API Products with Tyk Managed Custom Credentials. It covers the manual UI steps, how to verify on the developer portal, and guidance for bulk imports via the Developer Portal APIs. - [How to use Existing Credentials with Multiple API Products](https://tyk.io/docs/tyk-developer-portal/single-credentials-multiple-api-products.md): This guide explains how to use existing credentials with multiple API Products in the Tyk Developer Portal - [Forgotten Password](https://tyk.io/docs/tyk-developer-portal/tyk-enterprise-developer-portal/api-consumer-portal/reset-password.md): How to reset your password when using Tyk Developer Portal - [Tyk Gateway API](https://tyk.io/docs/tyk-gateway-api.md): Tyk Gateway API documentation. This page provides details on how to use the Tyk Gateway API for managing session objects, policies, API definitions, and more. - [Agent and API Provider Management](https://tyk.io/docs/tyk-governance/agent-management.md): Deploy, configure, and monitor Tyk Governance agents that discover and synchronize APIs from various providers to create a federated API inventory. - [API Evaluation](https://tyk.io/docs/tyk-governance/api-evaluation.md): Validate API specifications against governance policies before deployment to catch compliance issues early in the development lifecycle and reduce rework. - [API Labeling and Categorization](https://tyk.io/docs/tyk-governance/api-labeling.md): Organize, classify, and filter your APIs using customizable metadata tags to create a structured taxonomy for your API landscape. - [API Repository](https://tyk.io/docs/tyk-governance/api-repository.md): Learn how Tyk Governance automatically discovers and catalogs APIs across multiple sources to create a comprehensive inventory of all APIs in your organization. - [Core Concepts](https://tyk.io/docs/tyk-governance/core-concepts.md): Detailed explanation of key technical concepts that form the foundation of Tyk Governance, including federated API management, governance rulesets, and the technical architecture. - [Governance Rulesets](https://tyk.io/docs/tyk-governance/governance-rulesets.md): Define, manage, and enforce API standards across your organization through customizable rules that act as executable policies for API governance requirements. - [Installation and Setup](https://tyk.io/docs/tyk-governance/installation.md): Step-by-step instructions for installing and configuring Tyk Governance, including cloud-hosted options and deploying agents in your environment. - [Tyk Governance Overview](https://tyk.io/docs/tyk-governance/overview.md): Introduction to Tyk Governance, a universal API governance hub that enables organizations to establish, enforce, and monitor governance policies across multiple API platforms and gateways. - [TIB REST API](https://tyk.io/docs/tyk-identity-broker/tib-rest-api.md): Tyk Identity Broker (TIB) REST API, including endpoints for managing identity profiles and configurations. - [Tyk MDCB API](https://tyk.io/docs/tyk-mdcb-api.md): Tyk MDCB API documentation. This page provides details on how to use the Tyk Multi Data Center Bridge (MDCB) API for monitoring connected Data Planes and accessing diagnostic data. - [MDCB Configuration options](https://tyk.io/docs/tyk-multi-data-centre/mdcb-configuration-options.md): Each of the config options that are available when deploying MDCB. - [Tyk Open Source](https://tyk.io/docs/tyk-open-source.md): This page serves as a comprehensive guide to Tyk Open Source - [Tyk Gateway Open Source (OSS)](https://tyk.io/docs/tyk-oss-gateway.md): Overview of Tyk Gateway features and deployment options. - [Tyk Gateway Configuration Options](https://tyk.io/docs/tyk-oss-gateway/configuration.md): Configuration options and environment variables for Tyk Gateway. - [Tyk Overview](https://tyk.io/docs/tyk-overview.md): Explaining Tyk at a high level - [Tyk Pump Environment Variables](https://tyk.io/docs/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables.md): Using Environment Variables to configure your Tyk Pump - [Tyk Self Managed](https://tyk.io/docs/tyk-self-managed.md): This page serves as a comprehensive guide to migrating workloads to Tyk Self Managed - [Installation Options for Tyk Self-Managed](https://tyk.io/docs/tyk-self-managed/install.md): Explore the various installation options for Tyk Self-Managed, including Docker, Kubernetes, Linux packages, Ansible, and more. - [Install Tyk Self-Managed on Docker](https://tyk.io/docs/tyk-self-managed/install/docker.md): Installation guide for the Tyk Self-Managed on Docker - [Install Tyk Self-Managed on Kubernetes](https://tyk.io/docs/tyk-self-managed/install/kubernetes.md): Installation guide for the Tyk Self-Managed on Kubernetes using Helm charts - [Install Tyk Self-Managed on Linux](https://tyk.io/docs/tyk-self-managed/install/linux.md): Installation guide for the Tyk Self-Managed on on Linux distributions using Ubuntu, Debian, Red Hat, and CentOS - [Install Tyk Self-Managed on Ansible, AWS, GCP, Heroku, and more](https://tyk.io/docs/tyk-self-managed/install/methods.md): Explore the various installation options for Tyk Self-Managed, including AWS Marketplace, Ansible, Heroku, Google Cloud, Azure, and more. - [Tyk Stack](https://tyk.io/docs/tyk-stack.md): Overview of Tyk Stack components, both open-source and closed-source. - [Managing API Access Requests](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/approve-requests.md): How to provision API Access Requests in Tyk Developer Portal - [Configuring Custom Rate Limit Keys in Developer Portal](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/configuring-custom-rate-limit-keys.md): How to configure custom rate limit keys in Tyk Developer Portal - [Dynamic Client Registration](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/dynamic-client-registration.md): How to configure Dynamic Client Registration in Tyk developer portal - [Enable single sign on for admin users and developers](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/enable-sso.md): Learn how to enable single sign on for admin users and developers in the Developer Portal. - [Organisations and Teams](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumer-organisations.md): How to manage Organisations in Tyk Developer Portal - [API Catalogs](https://tyk.io/docs/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-catalogues.md): Working with API Catalogs - [Useful Configurations when Getting started](https://tyk.io/docs/tyk-stack/tyk-gateway/important-prerequisites.md): Important prerequisites and configurations needed before proceeding with Tyk tutorials. - [Create and Secure an API with Tyk Operator](https://tyk.io/docs/tyk-stack/tyk-operator/create-an-api.md): Learn how to create an API using Tyk Operator in Kubernetes - [Install Tyk Operator](https://tyk.io/docs/tyk-stack/tyk-operator/installing-tyk-operator.md): Learn how to install Tyk Operator on Kubernetes to manage your Tyk API configurations - [Publish an API to Developer Portal with Tyk Operator](https://tyk.io/docs/tyk-stack/tyk-operator/publish-an-api.md): Learn how to publish an API to the Tyk Developer Portal using Tyk Operator in Kubernetes, enabling third-party developers to access your APIs. - [Tyk FAPI Accelerator for Open Banking](https://tyk.io/docs/use-cases/open-banking.md): Learn how Tyk API Gateway enables financial institutions to implement secure, standards-compliant Open Banking APIs with advanced features like DPoP authentication, event notifications, and idempotency support. ## OpenAPI Specs - [mdcb-swagger](https://tyk.io/docs/swagger/nightly/mdcb-swagger.yml) - [ai-studio-swagger](https://tyk.io/docs/swagger/nightly/ai-studio-swagger.yml) - [enterprise-developer-portal-swagger](https://tyk.io/docs/swagger/nightly/enterprise-developer-portal-swagger.yaml) - [gateway-swagger](https://tyk.io/docs/swagger/nightly/gateway-swagger.yml) - [dashboard-swagger](https://tyk.io/docs/swagger/nightly/dashboard-swagger.yml) - [dashboard-admin-swagger](https://tyk.io/docs/swagger/5.12/dashboard-admin-swagger.yml)