# API7 Docs > Official documentation for the AISIX AI Gateway suite, Apache APISIX, API7 Gateway, API7 and APISIX Ingress Controllers, and gateway plugins. ## ai-gateway Route and govern LLM and AI-agent traffic through AISIX AI Gateway with stable model aliases, centralized provider credentials, routing, and policy. - [AISIX AI Gateway](https://docs.api7.ai/ai-gateway.md): Route and govern LLM and AI-agent traffic through AISIX AI Gateway with stable model aliases, centralized provider credentials, routing, and policy. ### reference #### admin-api Inspect resources, model status, and health through the authenticated, read-only Admin API of an open-source AISIX gateway. - [AISIX Admin API](https://docs.api7.ai/ai-gateway/reference/admin-api.md): Inspect resources, model status, and health through the authenticated, read-only Admin API of an open-source AISIX gateway. #### cloud-admin-api AISIX Cloud Admin API reference for organization-scoped automation in AISIX Cloud and AISIX Cloud On-Premises, generated from the AISIX control plane OpenAPI source. - [AISIX Cloud Admin API](https://docs.api7.ai/ai-gateway/reference/cloud-admin-api.md): AISIX Cloud Admin API reference for organization-scoped automation in AISIX Cloud and AISIX Cloud On-Premises, generated from the AISIX control plane OpenAPI source. #### cli Reference for AISIX gateway commands that validate declarative resources and export etcd configuration to a resources.yaml file. - [CLI Reference](https://docs.api7.ai/ai-gateway/reference/cli.md): Reference for AISIX gateway commands that validate declarative resources and export etcd configuration to a resources.yaml file. #### cloud-admin-api-changelog Endpoint and schema differences between released versions of the AISIX Cloud Admin API. - [AISIX Cloud Admin API Changelog](https://docs.api7.ai/ai-gateway/reference/cloud-admin-api-changelog.md): Endpoint and schema differences between released versions of the AISIX Cloud Admin API. #### config-status Reference for AISIX gateway configuration-status endpoints and metrics, including applied, rejected, stale, and partially compatible resources. - [Configuration Status](https://docs.api7.ai/ai-gateway/reference/config-status.md): Reference for AISIX gateway configuration-status endpoints and metrics, including applied, rejected, stale, and partially compatible resources. #### configuration-files Reference for AISIX gateway startup configuration formats, resource sources, connection settings, loading precedence, and common options. - [Startup Configuration Reference](https://docs.api7.ai/ai-gateway/reference/configuration-files.md): Reference for AISIX gateway startup configuration formats, resource sources, connection settings, loading precedence, and common options. #### environment-variables Reference for AISIX gateway environment variables used for configuration-file selection, startup overrides, managed connections, and runtime tuning. - [Environment Variables](https://docs.api7.ai/ai-gateway/reference/environment-variables.md): Reference for AISIX gateway environment variables used for configuration-file selection, startup overrides, managed connections, and runtime tuning. #### headers-and-error-codes Reference for AISIX gateway response headers, status codes, and error envelopes across proxy, MCP, A2A, and passthrough routes. - [Headers and Error Codes](https://docs.api7.ai/ai-gateway/reference/headers-and-error-codes.md): Reference for AISIX gateway response headers, status codes, and error envelopes across proxy, MCP, A2A, and passthrough routes. #### metric-labels Select the labels emitted by each Prometheus metric, and look up every supported label variable and its defaults. - [Metric Labels and Variables](https://docs.api7.ai/ai-gateway/reference/metric-labels.md): Select the labels emitted by each Prometheus metric, and look up every supported label variable and its defaults. #### metrics Reference for AISIX gateway Prometheus metrics covering traffic, latency, tokens, cost, caching, guardrails, and upstream health. - [Metrics Reference](https://docs.api7.ai/ai-gateway/reference/metrics.md): Reference for AISIX gateway Prometheus metrics covering traffic, latency, tokens, cost, caching, guardrails, and upstream health. #### on-premises-configuration Reference for Docker Compose environment variables and Helm values used to run AISIX Enterprise in your infrastructure. - [AISIX Enterprise Configuration](https://docs.api7.ai/ai-gateway/reference/on-premises-configuration.md): Reference for Docker Compose environment variables and Helm values used to run AISIX Enterprise in your infrastructure. #### ports Reference for default AISIX gateway and control-plane ports, traffic direction, configuration, and recommended network exposure. - [Port Reference](https://docs.api7.ai/ai-gateway/reference/ports.md): Reference for default AISIX gateway and control-plane ports, traffic direction, configuration, and recommended network exposure. #### proxy-api Reference for AISIX gateway proxy routes, authentication, model discovery, routing behavior, and endpoint constraints. - [Proxy API Reference](https://docs.api7.ai/ai-gateway/reference/proxy-api.md): Reference for AISIX gateway proxy routes, authentication, model discovery, routing behavior, and endpoint constraints. #### resources-file Configure an AISIX gateway with resources.yaml using this reference for supported collections, fields, environment interpolation, and validation rules. - [Resources File Reference](https://docs.api7.ai/ai-gateway/reference/resources-file.md): Configure an AISIX gateway with resources.yaml using this reference for supported collections, fields, environment interpolation, and validation rules. ### agent-gateway #### agent-access-control Scope each AISIX caller API key to exact A2A agent names, name patterns, or every registered agent. A2A access is denied by default. - [Control Agent Access](https://docs.api7.ai/ai-gateway/agent-gateway/agent-access-control.md): Scope each AISIX caller API key to exact A2A agent names, name patterns, or every registered agent. A2A access is denied by default. #### observability Read the usage events and Prometheus metrics that A2A agent calls emit in an AISIX gateway, tagged so you can isolate A2A traffic from model traffic. - [Observability](https://docs.api7.ai/ai-gateway/agent-gateway/observability.md): Read the usage events and Prometheus metrics that A2A agent calls emit in an AISIX gateway, tagged so you can isolate A2A traffic from model traffic. #### overview Expose A2A agents through AISIX with caller access control, upstream authentication, rate limits, telemetry, and budgets in AISIX Enterprise and AISIX Cloud. - [Agent Gateway Overview](https://docs.api7.ai/ai-gateway/agent-gateway/overview.md): Expose A2A agents through AISIX with caller access control, upstream authentication, rate limits, telemetry, and budgets in AISIX Enterprise and AISIX Cloud. #### setup Register an A2A agent in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway, grant caller access, and verify it with the official A2A Go SDK client. - [Set Up Agent Gateway](https://docs.api7.ai/ai-gateway/agent-gateway/setup.md): Register an A2A agent in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway, grant caller access, and verify it with the official A2A Go SDK client. #### streaming-and-discovery Use the official A2A Go SDK client to test streaming through AISIX Agent Gateway and verify agent-card discovery through a public origin. - [A2A Streaming and Agent-Card Discovery](https://docs.api7.ai/ai-gateway/agent-gateway/streaming-and-discovery.md): Use the official A2A Go SDK client to test streaming through AISIX Agent Gateway and verify agent-card discovery through a public origin. #### traffic-controls Apply caller API key request and concurrency limits to A2A calls, with budgets across caller traffic in AISIX Enterprise and AISIX Cloud. - [Rate Limits and Budgets](https://docs.api7.ai/ai-gateway/agent-gateway/traffic-controls.md): Apply caller API key request and concurrency limits to A2A calls, with budgets across caller traffic in AISIX Enterprise and AISIX Cloud. #### upstream-authentication Configure how AISIX authenticates to an upstream A2A agent with no credential, a bearer token, or an API key held by the gateway. - [Upstream Authentication](https://docs.api7.ai/ai-gateway/agent-gateway/upstream-authentication.md): Configure how AISIX authenticates to an upstream A2A agent with no credential, a bearer token, or an API key held by the gateway. ### cloud #### admin-tokens Create and manage admin tokens for AISIX Enterprise or AISIX Cloud automation, including scopes, expiration, rotation, revocation, and SCIM access. - [Admin Tokens](https://docs.api7.ai/ai-gateway/cloud/admin-tokens.md): Create and manage admin tokens for AISIX Enterprise or AISIX Cloud automation, including scopes, expiration, rotation, revocation, and SCIM access. #### connect-a-gateway Connect an AISIX gateway to an AISIX Enterprise or AISIX Cloud environment with dashboard-issued mTLS credentials and connection verification. - [Connect an AISIX Gateway](https://docs.api7.ai/ai-gateway/cloud/connect-a-gateway.md): Connect an AISIX gateway to an AISIX Enterprise or AISIX Cloud environment with dashboard-issued mTLS credentials and connection verification. #### control-plane Understand the shared AISIX Enterprise and AISIX Cloud architecture, management model, traffic path, and product-specific responsibilities. - [AISIX Enterprise and Cloud Overview](https://docs.api7.ai/ai-gateway/cloud/control-plane.md): Understand the shared AISIX Enterprise and AISIX Cloud architecture, management model, traffic path, and product-specific responsibilities. #### custom-roles Understand owner, admin, member, and custom roles in AISIX Enterprise and AISIX Cloud, then assign fine-grained permissions and environment-scoped access. - [Roles and Custom Roles](https://docs.api7.ai/ai-gateway/cloud/custom-roles.md): Understand owner, admin, member, and custom roles in AISIX Enterprise and AISIX Cloud, then assign fine-grained permissions and environment-scoped access. #### high-availability Design a highly available AISIX Enterprise or AISIX Cloud traffic path with redundant AISIX gateways, resilient control-plane connectivity, and upstream failover. - [High Availability](https://docs.api7.ai/ai-gateway/cloud/high-availability.md): Design a highly available AISIX Enterprise or AISIX Cloud traffic path with redundant AISIX gateways, resilient control-plane connectivity, and upstream failover. #### kubernetes Deploy gateways connected to AISIX Enterprise or AISIX Cloud and operate AISIX gateways on Kubernetes with Helm, autoscaling, Redis, and disruption handling. - [Deploy Gateways for AISIX Enterprise or AISIX Cloud](https://docs.api7.ai/ai-gateway/cloud/kubernetes.md): Deploy gateways connected to AISIX Enterprise or AISIX Cloud and operate AISIX gateways on Kubernetes with Helm, autoscaling, Redis, and disruption handling. #### logging-and-auditing Understand how AISIX Enterprise and AISIX Cloud record gateway requests and control-plane resource changes. - [Logging and Auditing](https://docs.api7.ai/ai-gateway/cloud/logging-and-auditing.md): Understand how AISIX Enterprise and AISIX Cloud record gateway requests and control-plane resource changes. #### members Add organization members for AISIX Enterprise or AISIX Cloud control-plane access and API key ownership. - [Members](https://docs.api7.ai/ai-gateway/cloud/members.md): Add organization members for AISIX Enterprise or AISIX Cloud control-plane access and API key ownership. #### model-pricing Understand how AISIX Enterprise and AISIX Cloud derive per-request cost, and set prices for models the catalog does not cover. - [Model Pricing](https://docs.api7.ai/ai-gateway/cloud/model-pricing.md): Understand how AISIX Enterprise and AISIX Cloud derive per-request cost, and set prices for models the catalog does not cover. #### offline-resilience Understand how AISIX gateways serve cached configuration during control-plane outages, including restart, budget, telemetry, and recovery behavior. - [Offline Resilience](https://docs.api7.ai/ai-gateway/cloud/offline-resilience.md): Understand how AISIX gateways serve cached configuration during control-plane outages, including restart, budget, telemetry, and recovery behavior. #### organization-backup-and-restore Back up one AISIX Enterprise organization as a full or redacted bundle and restore it onto a freshly installed control plane. - [Organization Backup and Restore](https://docs.api7.ai/ai-gateway/cloud/organization-backup-and-restore.md): Back up one AISIX Enterprise organization as a full or redacted bundle and restore it onto a freshly installed control plane. #### organization-domains Prove that an AISIX Cloud organization owns a DNS domain, so its single sign-on and SCIM directory sync are trusted for the email addresses in that domain. - [Organization Domains](https://docs.api7.ai/ai-gateway/cloud/organization-domains.md): Prove that an AISIX Cloud organization owns a DNS domain, so its single sign-on and SCIM directory sync are trusted for the email addresses in that domain. #### organizations-and-environments Understand organization and environment scopes in AISIX Enterprise and AISIX Cloud, including environment management and safe organization deletion. - [Organizations and Environments](https://docs.api7.ai/ai-gateway/cloud/organizations-and-environments.md): Understand organization and environment scopes in AISIX Enterprise and AISIX Cloud, including environment management and safe organization deletion. #### overview Request AISIX Cloud access, understand the API7-hosted operating model, and continue from organization setup to a connected AISIX gateway. - [Get Started with AISIX Cloud](https://docs.api7.ai/ai-gateway/cloud/overview.md): Request AISIX Cloud access, understand the API7-hosted operating model, and continue from organization setup to a connected AISIX gateway. #### playground Understand what playground requests in AISIX Enterprise or AISIX Cloud can validate compared with gateway requests. - [Playground](https://docs.api7.ai/ai-gateway/cloud/playground.md): Understand what playground requests in AISIX Enterprise or AISIX Cloud can validate compared with gateway requests. #### resource-projection Understand how AISIX Enterprise and AISIX Cloud project environment resources, then verify publication, gateway application, and caller-visible behavior. - [Resource Projection](https://docs.api7.ai/ai-gateway/cloud/resource-projection.md): Understand how AISIX Enterprise and AISIX Cloud project environment resources, then verify publication, gateway application, and caller-visible behavior. #### scim-directory-sync Provision organization members in AISIX Enterprise and AISIX Cloud automatically from your identity provider with SCIM 2.0. - [SCIM Directory Sync](https://docs.api7.ai/ai-gateway/cloud/scim-directory-sync.md): Provision organization members in AISIX Enterprise and AISIX Cloud automatically from your identity provider with SCIM 2.0. #### single-sign-on Configure SAML single sign-on for AISIX Enterprise or AISIX Cloud, with just-in-time provisioning, role mapping, and enforced SSO. - [Single Sign-On (SAML)](https://docs.api7.ai/ai-gateway/cloud/single-sign-on.md): Configure SAML single sign-on for AISIX Enterprise or AISIX Cloud, with just-in-time provisioning, role mapping, and enforced SSO. #### single-sign-on-microsoft-entra-id Set up SAML single sign-on between Microsoft Entra ID and AISIX Enterprise or AISIX Cloud, and map app roles to organization roles. - [Integrate with Microsoft Entra ID](https://docs.api7.ai/ai-gateway/cloud/single-sign-on-microsoft-entra-id.md): Set up SAML single sign-on between Microsoft Entra ID and AISIX Enterprise or AISIX Cloud, and map app roles to organization roles. #### teams Group AISIX Enterprise or AISIX Cloud members into teams, bind caller API keys for attribution, and configure budgets, rate limits, and MCP access. - [Teams](https://docs.api7.ai/ai-gateway/cloud/teams.md): Group AISIX Enterprise or AISIX Cloud members into teams, bind caller API keys for attribution, and configure budgets, rate limits, and MCP access. #### usage-reporting Understand how AISIX Enterprise and AISIX Cloud report gateway usage, spend, and budget-related signals. - [Usage Reporting](https://docs.api7.ai/ai-gateway/cloud/usage-reporting.md): Understand how AISIX Enterprise and AISIX Cloud report gateway usage, spend, and budget-related signals. ### deployment #### configuration-propagation Understand how resource changes reach an AISIX gateway, reload a declarative resources file safely, and verify the applied configuration. - [Configuration Propagation](https://docs.api7.ai/ai-gateway/deployment/configuration-propagation.md): Understand how resource changes reach an AISIX gateway, reload a declarative resources file safely, and verify the applied configuration. #### forward-proxy Deploy AISIX behind a TLS-terminating egress proxy for governed IDE AI traffic, using GitHub Copilot extensions and Copilot CLI as the worked example. - [Forward Proxy for IDE AI Traffic](https://docs.api7.ai/ai-gateway/deployment/forward-proxy.md): Deploy AISIX behind a TLS-terminating egress proxy for governed IDE AI traffic, using GitHub Copilot extensions and Copilot CLI as the worked example. #### health-checks Choose and interpret AISIX gateway health checks for process liveness, traffic readiness, model health, and configuration state. - [Health Checks](https://docs.api7.ai/ai-gateway/deployment/health-checks.md): Choose and interpret AISIX gateway health checks for process liveness, traffic readiness, model health, and configuration state. #### network-and-security Operate AISIX gateways with correct listener exposure, configuration-source isolation, and credential handling. - [Network and Security](https://docs.api7.ai/ai-gateway/deployment/network-and-security.md): Operate AISIX gateways with correct listener exposure, configuration-source isolation, and credential handling. #### okd Install and upgrade AISIX gateways for all three products and the AISIX Enterprise control plane on OKD with restricted-v2 SCCs, Routes, and Helm. - [Run AISIX on OKD](https://docs.api7.ai/ai-gateway/deployment/okd.md): Install and upgrade AISIX gateways for all three products and the AISIX Enterprise control plane on OKD with restricted-v2 SCCs, Routes, and Helm. #### open-source-gateway-on-kubernetes Deploy AISIX OSS on Kubernetes with the api7/aisix Helm chart and a declarative resources.yaml file, without a control plane. - [Deploy AISIX OSS on Kubernetes](https://docs.api7.ai/ai-gateway/deployment/open-source-gateway-on-kubernetes.md): Deploy AISIX OSS on Kubernetes with the api7/aisix Helm chart and a declarative resources.yaml file, without a control plane. #### performance-and-sizing Expected AISIX gateway proxy overhead and throughput, and how to size CPU for your request volume. - [Performance and Sizing](https://docs.api7.ai/ai-gateway/deployment/performance-and-sizing.md): Expected AISIX gateway proxy overhead and throughput, and how to size CPU for your request volume. #### production Prepare AISIX gateways for production traffic by planning capacity, dependencies, network exposure, health checks, recovery, and shutdown. - [Prepare AISIX Gateways for Production](https://docs.api7.ai/ai-gateway/deployment/production.md): Prepare AISIX gateways for production traffic by planning capacity, dependencies, network exposure, health checks, recovery, and shutdown. #### startup-configuration Configure AISIX gateway startup settings, including its resource source, listeners, runtime dependencies, observability, and control-plane connection. - [Startup Configuration](https://docs.api7.ai/ai-gateway/deployment/startup-configuration.md): Configure AISIX gateway startup settings, including its resource source, listeners, runtime dependencies, observability, and control-plane connection. #### thread-per-core-workers Configure AISIX gateway worker threads and thread-per-core serving, verify the active mode, and plan for per-worker upstream pools and shared listeners. - [Thread-per-Core Workers](https://docs.api7.ai/ai-gateway/deployment/thread-per-core-workers.md): Configure AISIX gateway worker threads and thread-per-core serving, verify the active mode, and plan for per-worker upstream pools and shared listeners. #### tls-and-mtls Configure listener TLS, upstream trust, etcd mTLS, and control-plane mTLS for the AISIX gateway. - [TLS and mTLS](https://docs.api7.ai/ai-gateway/deployment/tls-and-mtls.md): Configure listener TLS, upstream trust, etcd mTLS, and control-plane mTLS for the AISIX gateway. #### troubleshooting Diagnose AISIX gateway startup, configuration, caller access, policy, upstream, and control-plane projection failures. - [Troubleshooting](https://docs.api7.ai/ai-gateway/deployment/troubleshooting.md): Diagnose AISIX gateway startup, configuration, caller access, policy, upstream, and control-plane projection failures. #### upgrade-gateway-on-kubernetes Upgrade a gateway connected to AISIX Enterprise or AISIX Cloud from 0.12.0, or an open-source AISIX gateway from 1.4 or 1.5, to this version with verification and rollback. - [Upgrade an AISIX Gateway on Kubernetes](https://docs.api7.ai/ai-gateway/deployment/upgrade-gateway-on-kubernetes.md): Upgrade a gateway connected to AISIX Enterprise or AISIX Cloud from 0.12.0, or an open-source AISIX gateway from 1.4 or 1.5, to this version with verification and rollback. #### url-rewriting Map legacy or external URL shapes onto AISIX gateway endpoints with entry-level rewrite rules, so existing clients migrate without configuration changes. - [URL Rewriting](https://docs.api7.ai/ai-gateway/deployment/url-rewriting.md): Map legacy or external URL shapes onto AISIX gateway endpoints with entry-level rewrite rules, so existing clients migrate without configuration changes. ### endpoints #### anthropic-messages Understand how an AISIX gateway handles Anthropic-style Messages requests, including caller keys, model aliases, upstream translation, token counting, and errors. - [Anthropic-Style Messages API](https://docs.api7.ai/ai-gateway/endpoints/anthropic-messages.md): Understand how an AISIX gateway handles Anthropic-style Messages requests, including caller keys, model aliases, upstream translation, token counting, and errors. #### audio Learn how an AISIX gateway handles OpenAI-style audio transcription, translation, and speech endpoints. - [Speech and Audio](https://docs.api7.ai/ai-gateway/endpoints/audio.md): Learn how an AISIX gateway handles OpenAI-style audio transcription, translation, and speech endpoints. #### batch-files-fine-tuning Run the OpenAI-compatible Files, Batch, and Fine-tuning APIs through an AISIX gateway, with gateway-managed provider routing and batch usage attribution. - [Batch, Files, and Fine-Tuning](https://docs.api7.ai/ai-gateway/endpoints/batch-files-fine-tuning.md): Run the OpenAI-compatible Files, Batch, and Fine-tuning APIs through an AISIX gateway, with gateway-managed provider routing and batch usage attribution. #### chat-audio Send audio to an OpenAI-compatible chat model through AISIX and save generated audio from a non-streaming Chat Completions response. - [Audio Input and Output with Chat Completions](https://docs.api7.ai/ai-gateway/endpoints/chat-audio.md): Send audio to an OpenAI-compatible chat model through AISIX and save generated audio from a non-streaming Chat Completions response. #### embeddings Learn how an AISIX gateway handles the OpenAI-compatible embeddings endpoint, including request format and provider limits. - [Embeddings](https://docs.api7.ai/ai-gateway/endpoints/embeddings.md): Learn how an AISIX gateway handles the OpenAI-compatible embeddings endpoint, including request format and provider limits. #### image-editing Edit images through the AISIX gateway /v1/images/edits endpoint with multipart uploads, model aliases, prompt guardrails, and token usage accounting. - [Image Editing](https://docs.api7.ai/ai-gateway/endpoints/image-editing.md): Edit images through the AISIX gateway /v1/images/edits endpoint with multipart uploads, model aliases, prompt guardrails, and token usage accounting. #### image-generation Learn how an AISIX gateway handles the OpenAI image generation endpoint and provider support. - [Image Generation](https://docs.api7.ai/ai-gateway/endpoints/image-generation.md): Learn how an AISIX gateway handles the OpenAI image generation endpoint and provider support. #### openai-client-to-anthropic Use an OpenAI-compatible client with an Anthropic-backed AISIX model alias and understand how the gateway translates requests and responses. - [OpenAI Client with Anthropic Upstream](https://docs.api7.ai/ai-gateway/endpoints/openai-client-to-anthropic.md): Use an OpenAI-compatible client with an Anthropic-backed AISIX model alias and understand how the gateway translates requests and responses. #### openai-compatible-chat Understand how an AISIX gateway handles OpenAI-compatible POST /v1/chat/completions requests, model aliases, authentication, provider translation, and errors. - [OpenAI-Compatible Chat Completions](https://docs.api7.ai/ai-gateway/endpoints/openai-compatible-chat.md): Understand how an AISIX gateway handles OpenAI-compatible POST /v1/chat/completions requests, model aliases, authentication, provider translation, and errors. #### overview Compare AISIX caller-facing API families and proxy routes, including supported operations, model discovery, health checks, and shared gateway behavior. - [Supported Endpoints](https://docs.api7.ai/ai-gateway/endpoints/overview.md): Compare AISIX caller-facing API families and proxy routes, including supported operations, model discovery, health checks, and shared gateway behavior. #### provider-passthrough Relay provider-native APIs and forward-proxy traffic through AISIX passthrough routes with matching, authentication, credentials, controls, and telemetry. - [Passthrough Routes](https://docs.api7.ai/ai-gateway/endpoints/provider-passthrough.md): Relay provider-native APIs and forward-proxy traffic through AISIX passthrough routes with matching, authentication, credentials, controls, and telemetry. #### realtime Connect OpenAI Realtime WebSocket clients through an AISIX gateway with gateway-managed authentication, policy enforcement, and session usage tracking. - [Realtime API](https://docs.api7.ai/ai-gateway/endpoints/realtime.md): Connect OpenAI Realtime WebSocket clients through an AISIX gateway with gateway-managed authentication, policy enforcement, and session usage tracking. #### request-lifecycle Understand how AISIX authenticates callers, resolves model aliases, applies controls, routes to providers, and records usage for each AI request. - [Request Lifecycle](https://docs.api7.ai/ai-gateway/endpoints/request-lifecycle.md): Understand how AISIX authenticates callers, resolves model aliases, applies controls, routes to providers, and records usage for each AI request. #### rerank Learn how an AISIX gateway proxies rerank requests through supported rerank providers. - [Rerank](https://docs.api7.ai/ai-gateway/endpoints/rerank.md): Learn how an AISIX gateway proxies rerank requests through supported rerank providers. #### responses-api Learn how an AISIX gateway handles the OpenAI Responses API and provider support. - [Responses API](https://docs.api7.ai/ai-gateway/endpoints/responses-api.md): Learn how an AISIX gateway handles the OpenAI Responses API and provider support. #### streaming Understand streaming behavior on an AISIX gateway, including OpenAI-style and Anthropic-style streaming paths. - [Streaming](https://docs.api7.ai/ai-gateway/endpoints/streaming.md): Understand streaming behavior on an AISIX gateway, including OpenAI-style and Anthropic-style streaming paths. #### text-completions Learn how an AISIX gateway handles OpenAI-compatible text-completions requests. - [Text Completions](https://docs.api7.ai/ai-gateway/endpoints/text-completions.md): Learn how an AISIX gateway handles OpenAI-compatible text-completions requests. #### tool-calling Understand tool-calling behavior on an AISIX gateway, including OpenAI-compatible requests and Anthropic translation. - [Tool Calling](https://docs.api7.ai/ai-gateway/endpoints/tool-calling.md): Understand tool-calling behavior on an AISIX gateway, including OpenAI-compatible requests and Anthropic translation. #### video-generation Generate videos through the AISIX gateway /v1/videos endpoint with asynchronous task submission, status polling, and video download. - [Video Generation](https://docs.api7.ai/ai-gateway/endpoints/video-generation.md): Generate videos through the AISIX gateway /v1/videos endpoint with asynchronous task submission, status polling, and video download. ### getting-started #### aisix-cloud-quickstart Deploy AISIX Enterprise with Docker Compose, configure a model, and send your first request through an attached AISIX gateway. - [Get Started with AISIX Enterprise](https://docs.api7.ai/ai-gateway/getting-started/aisix-cloud-quickstart.md): Deploy AISIX Enterprise with Docker Compose, configure a model, and send your first request through an attached AISIX gateway. #### anthropic-sdk Configure an Anthropic-compatible client to call an AISIX gateway through the /v1/messages proxy API. - [Anthropic SDK](https://docs.api7.ai/ai-gateway/getting-started/anthropic-sdk.md): Configure an Anthropic-compatible client to call an AISIX gateway through the /v1/messages proxy API. #### gateway-quickstart Run AISIX OSS in one container, declare provider keys, models, and caller API keys in a resources.yaml file, and send your first request. - [Get Started with AISIX OSS](https://docs.api7.ai/ai-gateway/getting-started/gateway-quickstart.md): Run AISIX OSS in one container, declare provider keys, models, and caller API keys in a resources.yaml file, and send your first request. #### openai-sdk Configure the official OpenAI SDK to call an AISIX gateway through the OpenAI-compatible proxy API. - [OpenAI SDK](https://docs.api7.ai/ai-gateway/getting-started/openai-sdk.md): Configure the official OpenAI SDK to call an AISIX gateway through the OpenAI-compatible proxy API. #### products-and-deployment-options Compare AISIX OSS, AISIX Enterprise, and AISIX Cloud across the AISIX AI Gateway suite by control-plane ownership and operational responsibility. - [Choose an AISIX AI Gateway Product](https://docs.api7.ai/ai-gateway/getting-started/products-and-deployment-options.md): Compare AISIX OSS, AISIX Enterprise, and AISIX Cloud across the AISIX AI Gateway suite by control-plane ownership and operational responsibility. ### integrations Connect SDKs, coding agents, application frameworks, AI application platforms, and voice agent platforms to an AISIX gateway. - [Integrations](https://docs.api7.ai/ai-gateway/integrations.md): Connect SDKs, coding agents, application frameworks, AI application platforms, and voice agent platforms to an AISIX gateway. #### application-platforms Connect AI application platforms to an AISIX gateway for governed model access while the platform continues to run workflows, tools, RAG, and user interfaces. - [AI Application Platforms](https://docs.api7.ai/ai-gateway/integrations/application-platforms.md): Connect AI application platforms to an AISIX gateway for governed model access while the platform continues to run workflows, tools, RAG, and user interfaces. - [Dify](https://docs.api7.ai/ai-gateway/integrations/application-platforms/dify.md): Configure Dify's OpenAI-API-compatible model provider plugin to send application and agent model requests through an AISIX gateway. - [n8n](https://docs.api7.ai/ai-gateway/integrations/application-platforms/n8n.md): Configure the n8n OpenAI Chat Model to send AI Agent and chain requests through an AISIX gateway with a caller key and model alias. - [Open WebUI](https://docs.api7.ai/ai-gateway/integrations/application-platforms/open-webui.md): Connect Open WebUI to an AISIX gateway as an OpenAI-compatible endpoint with caller authentication, model discovery, streaming, and tool-call support. #### coding-agents Connect coding agents directly or through a forward proxy to govern model, tool, and official-service traffic with AISIX access controls and telemetry. - [Coding Agents](https://docs.api7.ai/ai-gateway/integrations/coding-agents.md): Connect coding agents directly or through a forward proxy to govern model, tool, and official-service traffic with AISIX access controls and telemetry. - [Claude Code](https://docs.api7.ai/ai-gateway/integrations/coding-agents/claude-code.md): Configure Claude Code to send Anthropic Messages traffic through an AISIX gateway. - [Cline](https://docs.api7.ai/ai-gateway/integrations/coding-agents/cline.md): Configure Cline to send OpenAI-compatible model traffic through an AISIX gateway. - [Codex](https://docs.api7.ai/ai-gateway/integrations/coding-agents/codex.md): Configure Codex to send Responses API traffic through an AISIX gateway. - [Cursor](https://docs.api7.ai/ai-gateway/integrations/coding-agents/cursor.md): Configure Cursor to send OpenAI-compatible chat traffic through an AISIX gateway. #### frameworks - [CrewAI](https://docs.api7.ai/ai-gateway/integrations/frameworks/crewai.md): Configure CrewAI to send OpenAI-compatible chat traffic through an AISIX gateway. - [Haystack](https://docs.api7.ai/ai-gateway/integrations/frameworks/haystack.md): Configure Haystack to send OpenAI Responses API traffic through an AISIX gateway. - [Instructor](https://docs.api7.ai/ai-gateway/integrations/frameworks/instructor.md): Configure Instructor to send OpenAI Responses API structured-output requests through an AISIX gateway. - [LangChain and LangGraph](https://docs.api7.ai/ai-gateway/integrations/frameworks/langchain.md): Configure LangChain and LangGraph to send OpenAI Responses API traffic through an AISIX gateway. - [LlamaIndex](https://docs.api7.ai/ai-gateway/integrations/frameworks/llamaindex.md): Configure LlamaIndex to send OpenAI Responses API traffic through an AISIX gateway. - [Microsoft Agent Framework](https://docs.api7.ai/ai-gateway/integrations/frameworks/microsoft-agent-framework.md): Configure Microsoft Agent Framework to send OpenAI Responses API traffic through an AISIX gateway. - [OpenAI Agents SDK](https://docs.api7.ai/ai-gateway/integrations/frameworks/openai-agents-sdk.md): Configure OpenAI Agents SDK to send OpenAI Responses API traffic through an AISIX gateway. - [Pydantic AI](https://docs.api7.ai/ai-gateway/integrations/frameworks/pydantic-ai.md): Configure Pydantic AI to send OpenAI Responses API traffic through an AISIX gateway. - [Vercel AI SDK](https://docs.api7.ai/ai-gateway/integrations/frameworks/vercel-ai-sdk.md): Configure Vercel AI SDK to send OpenAI Responses API traffic through an AISIX gateway. #### voice-agents Connect voice agent platforms to an AISIX gateway so their text model requests use gateway authentication, model aliases, routing, policy, and telemetry. - [Voice Agent Platforms](https://docs.api7.ai/ai-gateway/integrations/voice-agents.md): Connect voice agent platforms to an AISIX gateway so their text model requests use gateway authentication, model aliases, routing, policy, and telemetry. - [ElevenLabs Agents](https://docs.api7.ai/ai-gateway/integrations/voice-agents/elevenlabs.md): Configure an ElevenLabs Agent to use an AISIX gateway as its Custom LLM endpoint with a restricted caller key and model alias. - [LiveKit Agents](https://docs.api7.ai/ai-gateway/integrations/voice-agents/livekit.md): Configure the LiveKit Agents OpenAI plugin to stream Chat Completions requests through an AISIX gateway with a caller key and model alias. - [Pipecat](https://docs.api7.ai/ai-gateway/integrations/voice-agents/pipecat.md): Configure Pipecat OpenAILLMService to stream Chat Completions requests through an AISIX gateway while Pipecat operates the voice pipeline. - [Vapi](https://docs.api7.ai/ai-gateway/integrations/voice-agents/vapi.md): Configure a Vapi voice assistant to use an AISIX gateway as an authenticated OpenAI-compatible Custom LLM endpoint. ### mcp-gateway #### access-policies Manage MCP tool access across AISIX Enterprise and AISIX Cloud environments and teams, combined with each caller API key's own grant. - [Manage MCP Access with Policies](https://docs.api7.ai/ai-gateway/mcp-gateway/access-policies.md): Manage MCP tool access across AISIX Enterprise and AISIX Cloud environments and teams, combined with each caller API key's own grant. #### client-authentication Choose how MCP clients authenticate to an AISIX gateway — with a gateway API key, through OAuth sign-in, or anonymously from trusted networks. - [Client Authentication](https://docs.api7.ai/ai-gateway/mcp-gateway/client-authentication.md): Choose how MCP clients authenticate to an AISIX gateway — with a gateway API key, through OAuth sign-in, or anonymously from trusted networks. #### cursor Connect Cursor to AISIX MCP Gateway with a caller API key, discover the permitted tools, and verify a complete tool call through AISIX. - [Connect Cursor to MCP Gateway](https://docs.api7.ai/ai-gateway/mcp-gateway/cursor.md): Connect Cursor to AISIX MCP Gateway with a caller API key, discover the permitted tools, and verify a complete tool call through AISIX. #### guardrails Inspect MCP tool-call arguments and results with AISIX guardrails, blocking unsafe calls before dispatch or withholding unsafe results from clients. - [Guardrails](https://docs.api7.ai/ai-gateway/mcp-gateway/guardrails.md): Inspect MCP tool-call arguments and results with AISIX guardrails, blocking unsafe calls before dispatch or withholding unsafe results from clients. #### observability Diagnose MCP requests in AISIX gateway access logs, then isolate tool-call traffic from model traffic with usage events and Prometheus metrics. - [Observability](https://docs.api7.ai/ai-gateway/mcp-gateway/observability.md): Diagnose MCP requests in AISIX gateway access logs, then isolate tool-call traffic from model traffic with usage events and Prometheus metrics. #### openapi-servers Register a REST API with its OpenAPI document so an AISIX gateway generates MCP tools from its operations and executes tool calls as HTTP requests. - [Expose a REST API as MCP Tools](https://docs.api7.ai/ai-gateway/mcp-gateway/openapi-servers.md): Register a REST API with its OpenAPI document so an AISIX gateway generates MCP tools from its operations and executes tool calls as HTTP requests. #### overview Expose upstream MCP servers through an AISIX gateway with caller API key access control, upstream authentication, guardrails, telemetry, and automatic MCP protocol version negotiation. - [MCP Gateway Overview](https://docs.api7.ai/ai-gateway/mcp-gateway/overview.md): Expose upstream MCP servers through an AISIX gateway with caller API key access control, upstream authentication, guardrails, telemetry, and automatic MCP protocol version negotiation. #### server-review Review MCP server registrations and changes in AISIX Enterprise and AISIX Cloud before publishing them to gateways, and revoke approvals that no longer hold. - [Review and Approve MCP Servers](https://docs.api7.ai/ai-gateway/mcp-gateway/server-review.md): Review MCP server registrations and changes in AISIX Enterprise and AISIX Cloud before publishing them to gateways, and revoke approvals that no longer hold. #### setup Register an upstream MCP server in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway, grant one tool, and verify allowed and denied MCP calls. - [Set Up MCP Gateway](https://docs.api7.ai/ai-gateway/mcp-gateway/setup.md): Register an upstream MCP server in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway, grant one tool, and verify allowed and denied MCP calls. #### tool-access-control Scope each caller API key to the MCP tools it may list and call in an AISIX gateway, using exact names, per-server wildcards, or a global wildcard. - [Control Tool Access](https://docs.api7.ai/ai-gateway/mcp-gateway/tool-access-control.md): Scope each caller API key to the MCP tools it may list and call in an AISIX gateway, using exact names, per-server wildcards, or a global wildcard. #### traffic-controls Configure MCP request and concurrency limits in an AISIX gateway, plus budgets for AISIX Enterprise and AISIX Cloud, using the caller API key boundary. - [Rate Limits and Budgets](https://docs.api7.ai/ai-gateway/mcp-gateway/traffic-controls.md): Configure MCP request and concurrency limits in an AISIX gateway, plus budgets for AISIX Enterprise and AISIX Cloud, using the caller API key boundary. #### upstream-authentication Configure how an AISIX gateway authenticates to each upstream MCP server with no credential, a bearer token, an API key, or OAuth 2.0 client credentials. - [Upstream Authentication](https://docs.api7.ai/ai-gateway/mcp-gateway/upstream-authentication.md): Configure how an AISIX gateway authenticates to each upstream MCP server with no credential, a bearer token, an API key, or OAuth 2.0 client credentials. #### vscode Connect Visual Studio Code to AISIX MCP Gateway with a protected caller key, discover permitted tools, and verify a complete tool call. - [Connect VS Code to MCP Gateway](https://docs.api7.ai/ai-gateway/mcp-gateway/vscode.md): Connect Visual Studio Code to AISIX MCP Gateway with a protected caller key, discover permitted tools, and verify a complete tool call. ### models #### model-aliases Configure direct and wildcard model aliases in AISIX gateway deployments, including retries, pricing, rate limits, and other model-level behavior. - [Model Aliases](https://docs.api7.ai/ai-gateway/models/model-aliases.md): Configure direct and wildcard model aliases in AISIX gateway deployments, including retries, pricing, rate limits, and other model-level behavior. #### provider-key-rotation Rotate upstream provider credentials across AISIX models and passthrough routes while keeping caller API keys, model aliases, and route paths stable. - [Provider Key Rotation](https://docs.api7.ai/ai-gateway/models/provider-key-rotation.md): Rotate upstream provider credentials across AISIX models and passthrough routes while keeping caller API keys, model aliases, and route paths stable. #### provider-keys Configure provider keys across AISIX gateway deployments for upstream credentials, endpoints, adapters, request headers, compatibility overrides, and rotation. - [Provider Keys](https://docs.api7.ai/ai-gateway/models/provider-keys.md): Configure provider keys across AISIX gateway deployments for upstream credentials, endpoints, adapters, request headers, compatibility overrides, and rotation. #### reasoning-effort-mapping Rewrite reasoning-effort values for each direct model without changing client requests. - [Reasoning Effort Mapping](https://docs.api7.ai/ai-gateway/models/reasoning-effort-mapping.md): Rewrite reasoning-effort values for each direct model without changing client requests. #### resource-model Understand how provider keys, models, caller API keys, routing, traffic controls, and policies work together across AISIX gateway deployments. - [Resource Model](https://docs.api7.ai/ai-gateway/models/resource-model.md): Understand how provider keys, models, caller API keys, routing, traffic controls, and policies work together across AISIX gateway deployments. #### upstream-request-headers Forward approved caller headers to an upstream on any AISIX proxy face, inject request-context headers on a provider key, and understand which headers AISIX never relays. - [Upstream Request Headers](https://docs.api7.ai/ai-gateway/models/upstream-request-headers.md): Forward approved caller headers to an upstream on any AISIX proxy face, inject request-context headers on a provider key, and understand which headers AISIX never relays. ### observability #### access-logs-and-request-correlation Collect structured AISIX gateway access logs and trace requests across callers, fronting proxies, the gateway, and upstream providers. - [Access Logs and Request Correlation](https://docs.api7.ai/ai-gateway/observability/access-logs-and-request-correlation.md): Collect structured AISIX gateway access logs and trace requests across callers, fronting proxies, the gateway, and upstream providers. #### exporters Send AISIX gateway request telemetry to OTLP collectors, object storage, Datadog, or Alibaba Cloud SLS through either configuration path. - [Observability Exporters](https://docs.api7.ai/ai-gateway/observability/exporters.md): Send AISIX gateway request telemetry to OTLP collectors, object storage, Datadog, or Alibaba Cloud SLS through either configuration path. #### load-logs-into-snowflake Export AISIX gateway request telemetry to Amazon S3 or Azure Blob, ingest the records with Snowpipe, and query them through a Snowflake view. - [Load Request Telemetry into Snowflake](https://docs.api7.ai/ai-gateway/observability/load-logs-into-snowflake.md): Export AISIX gateway request telemetry to Amazon S3 or Azure Blob, ingest the records with Snowpipe, and query them through a Snowflake view. #### memory-diagnostics Find out where AISIX gateway memory goes with allocator, process, runtime, and component gauges, take heap profiles on demand, and recover the profiles written before an out-of-memory kill. - [Memory Diagnostics](https://docs.api7.ai/ai-gateway/observability/memory-diagnostics.md): Find out where AISIX gateway memory goes with allocator, process, runtime, and component gauges, take heap profiles on demand, and recover the profiles written before an out-of-memory kill. #### metrics-and-usage-events Monitor AISIX gateway traffic with Prometheus metrics and exportable per-attempt usage events, including request and attempt accounting. - [Metrics and Usage Events](https://docs.api7.ai/ai-gateway/observability/metrics-and-usage-events.md): Monitor AISIX gateway traffic with Prometheus metrics and exportable per-attempt usage events, including request and attempt accounting. ### on-premises #### backup-and-recovery Protect and recover AISIX Enterprise by preserving its PostgreSQL data, encryption keys, deployment configuration, and release identity. - [Backup and Recovery](https://docs.api7.ai/ai-gateway/on-premises/backup-and-recovery.md): Protect and recover AISIX Enterprise by preserving its PostgreSQL data, encryption keys, deployment configuration, and release identity. #### database-operations Size, monitor, and maintain the PostgreSQL database of an AISIX Enterprise control plane, including data retention, autovacuum, and reclaiming disk space. - [Database Operations](https://docs.api7.ai/ai-gateway/on-premises/database-operations.md): Size, monitor, and maintain the PostgreSQL database of an AISIX Enterprise control plane, including data retention, autovacuum, and reclaiming disk space. #### deployment Plan production resources and install AISIX Enterprise in your infrastructure with Docker Compose, Helm, or an offline package. - [Install AISIX Enterprise](https://docs.api7.ai/ai-gateway/on-premises/deployment.md): Plan production resources and install AISIX Enterprise in your infrastructure with Docker Compose, Helm, or an offline package. #### email Connect AISIX Enterprise to an SMTP relay for invitation, password-reset, and set-password emails. - [Configure AISIX Enterprise Email (SMTP)](https://docs.api7.ai/ai-gateway/on-premises/email.md): Connect AISIX Enterprise to an SMTP relay for invitation, password-reset, and set-password emails. #### external-database Provision external PostgreSQL and a least-privilege role for AISIX Enterprise installed with Helm, without granting superuser access. - [External Database](https://docs.api7.ai/ai-gateway/on-premises/external-database.md): Provision external PostgreSQL and a least-privilege role for AISIX Enterprise installed with Helm, without granting superuser access. #### upgrade Upgrade AISIX Enterprise safely with control-plane-first sequencing, package and Helm procedures, database preparation, and rollback guidance. - [Upgrade AISIX Enterprise](https://docs.api7.ai/ai-gateway/on-premises/upgrade.md): Upgrade AISIX Enterprise safely with control-plane-first sequencing, package and Helm procedures, database preparation, and rollback guidance. ### providers #### adapters Understand the OpenAI, Anthropic, Amazon Bedrock, Google Vertex AI, and Azure OpenAI protocol adapter families available in AISIX gateway deployments. - [Adapter Protocol Families](https://docs.api7.ai/ai-gateway/providers/adapters.md): Understand the OpenAI, Anthropic, Amazon Bedrock, Google Vertex AI, and Azure OpenAI protocol adapter families available in AISIX gateway deployments. #### amazon-nova Connect the direct Amazon Nova API to AISIX gateway deployments. Configure API credentials, Nova model aliases, caller API keys, and model access controls. - [Amazon Nova API](https://docs.api7.ai/ai-gateway/providers/amazon-nova.md): Connect the direct Amazon Nova API to AISIX gateway deployments. Configure API credentials, Nova model aliases, caller API keys, and model access controls. #### anthropic Connect Anthropic Claude to AISIX gateway deployments through the native Messages or OpenAI-compatible API. Configure credentials, model aliases, and caller access. - [Anthropic](https://docs.api7.ai/ai-gateway/providers/anthropic.md): Connect Anthropic Claude to AISIX gateway deployments through the native Messages or OpenAI-compatible API. Configure credentials, model aliases, and caller access. #### aws-bedrock Connect AWS Bedrock to AISIX gateway deployments using SigV4. Configure regional endpoints, model or inference-profile aliases, caller keys, and access controls. - [AWS Bedrock](https://docs.api7.ai/ai-gateway/providers/aws-bedrock.md): Connect AWS Bedrock to AISIX gateway deployments using SigV4. Configure regional endpoints, model or inference-profile aliases, caller keys, and access controls. #### azure-openai Connect Azure OpenAI to AISIX gateway deployments using resource API keys or Microsoft Entra ID. Configure deployment aliases, caller keys, and access controls. - [Azure OpenAI](https://docs.api7.ai/ai-gateway/providers/azure-openai.md): Connect Azure OpenAI to AISIX gateway deployments using resource API keys or Microsoft Entra ID. Configure deployment aliases, caller keys, and access controls. #### baseten Connect Baseten Model APIs or dedicated endpoints to AISIX gateway deployments. Configure credentials, model aliases, caller keys, and access controls. - [Baseten](https://docs.api7.ai/ai-gateway/providers/baseten.md): Connect Baseten Model APIs or dedicated endpoints to AISIX gateway deployments. Configure credentials, model aliases, caller keys, and access controls. #### bring-your-own-endpoint Connect AISIX gateway deployments to private OpenAI-compatible endpoints such as vLLM, SGLang, or Ollama. Configure credentials, aliases, and custom token pricing. - [Bring Your Own Endpoint](https://docs.api7.ai/ai-gateway/providers/bring-your-own-endpoint.md): Connect AISIX gateway deployments to private OpenAI-compatible endpoints such as vLLM, SGLang, or Ollama. Configure credentials, aliases, and custom token pricing. #### cerebras Connect Cerebras Inference to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. - [Cerebras](https://docs.api7.ai/ai-gateway/providers/cerebras.md): Connect Cerebras Inference to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. #### cloudflare-workers-ai Connect Cloudflare Workers AI to AISIX. Configure account-scoped credentials, model aliases, native Responses, and caller access. - [Cloudflare Workers AI](https://docs.api7.ai/ai-gateway/providers/cloudflare-workers-ai.md): Connect Cloudflare Workers AI to AISIX. Configure account-scoped credentials, model aliases, native Responses, and caller access. #### cohere Connect Cohere to AISIX gateway deployments for Command chat models, embeddings, and reranking. Configure provider credentials, model aliases, and caller access. - [Cohere](https://docs.api7.ai/ai-gateway/providers/cohere.md): Connect Cohere to AISIX gateway deployments for Command chat models, embeddings, and reranking. Configure provider credentials, model aliases, and caller access. #### compatibility Compare provider protocol and proxy endpoint support across AISIX gateway deployments, including chat, embeddings, media, Realtime, and job APIs. - [Provider Compatibility](https://docs.api7.ai/ai-gateway/providers/compatibility.md): Compare provider protocol and proxy endpoint support across AISIX gateway deployments, including chat, embeddings, media, Realtime, and job APIs. #### databricks Connect Databricks Model Serving to AISIX gateway deployments. Configure workspace endpoints, provider credentials, model aliases, caller keys, and access controls. - [Databricks](https://docs.api7.ai/ai-gateway/providers/databricks.md): Connect Databricks Model Serving to AISIX gateway deployments. Configure workspace endpoints, provider credentials, model aliases, caller keys, and access controls. #### deepinfra Connect DeepInfra to AISIX. Configure OpenAI-compatible and native Messages endpoints, credentials, model aliases, and caller access. - [DeepInfra](https://docs.api7.ai/ai-gateway/providers/deepinfra.md): Connect DeepInfra to AISIX. Configure OpenAI-compatible and native Messages endpoints, credentials, model aliases, and caller access. #### deepseek Connect DeepSeek models to AISIX gateway deployments through the OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. - [DeepSeek](https://docs.api7.ai/ai-gateway/providers/deepseek.md): Connect DeepSeek models to AISIX gateway deployments through the OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. #### digitalocean-gradient-ai Connect DigitalOcean Gradient AI to AISIX. Configure inference credentials, model aliases, native Responses, caller keys, and access controls. - [DigitalOcean Gradient AI](https://docs.api7.ai/ai-gateway/providers/digitalocean-gradient-ai.md): Connect DigitalOcean Gradient AI to AISIX. Configure inference credentials, model aliases, native Responses, caller keys, and access controls. #### fireworks-ai Connect Fireworks AI to AISIX through its OpenAI-compatible APIs. Configure credentials, model aliases, native Responses, reasoning, and caller access. - [Fireworks AI](https://docs.api7.ai/ai-gateway/providers/fireworks-ai.md): Connect Fireworks AI to AISIX through its OpenAI-compatible APIs. Configure credentials, model aliases, native Responses, reasoning, and caller access. #### gemini Connect Google Gemini to AISIX gateway deployments through the AI Studio OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. - [Gemini (Google AI Studio)](https://docs.api7.ai/ai-gateway/providers/gemini.md): Connect Google Gemini to AISIX gateway deployments through the AI Studio OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. #### google-vertex-ai Connect Gemini Enterprise Agent Platform to AISIX with service-account credentials, global or regional endpoints, model aliases, and adapter limits. - [Gemini Enterprise Agent Platform](https://docs.api7.ai/ai-gateway/providers/google-vertex-ai.md): Connect Gemini Enterprise Agent Platform to AISIX with service-account credentials, global or regional endpoints, model aliases, and adapter limits. #### groq Connect Groq to AISIX through its OpenAI-compatible APIs. Configure credentials, model aliases, native Responses, audio, batch, and caller access. - [Groq](https://docs.api7.ai/ai-gateway/providers/groq.md): Connect Groq to AISIX through its OpenAI-compatible APIs. Configure credentials, model aliases, native Responses, audio, batch, and caller access. #### huggingface Connect Hugging Face Inference Providers to AISIX. Configure router credentials, model aliases, native Responses, routing, and caller access. - [Hugging Face](https://docs.api7.ai/ai-gateway/providers/huggingface.md): Connect Hugging Face Inference Providers to AISIX. Configure router credentials, model aliases, native Responses, routing, and caller access. #### jina Connect Jina AI embeddings and rerankers to AISIX gateway deployments, including model, route, passthrough, and accounting boundaries. - [Jina](https://docs.api7.ai/ai-gateway/providers/jina.md): Connect Jina AI embeddings and rerankers to AISIX gateway deployments, including model, route, passthrough, and accounting boundaries. #### meta-llama-api Connect the Meta Llama API to AISIX through its OpenAI-compatible endpoint, with the correct API base, example model, and route boundaries. - [Meta Llama API](https://docs.api7.ai/ai-gateway/providers/meta-llama-api.md): Connect the Meta Llama API to AISIX through its OpenAI-compatible endpoint, with the correct API base, example model, and route boundaries. #### minimax Connect MiniMax models to AISIX through its OpenAI- and Anthropic-compatible APIs. Configure endpoints, credentials, aliases, and caller access. - [MiniMax](https://docs.api7.ai/ai-gateway/providers/minimax.md): Connect MiniMax models to AISIX through its OpenAI- and Anthropic-compatible APIs. Configure endpoints, credentials, aliases, and caller access. #### mistral Connect Mistral AI to AISIX for chat and compatible endpoints, with model aliases, structured-response boundaries, and passthrough routes. - [Mistral AI](https://docs.api7.ai/ai-gateway/providers/mistral.md): Connect Mistral AI to AISIX for chat and compatible endpoints, with model aliases, structured-response boundaries, and passthrough routes. #### modelscope Connect ModelScope API-Inference to AISIX gateway deployments. Configure OpenAI-compatible endpoints, namespaced model IDs, provider keys, and caller access. - [ModelScope](https://docs.api7.ai/ai-gateway/providers/modelscope.md): Connect ModelScope API-Inference to AISIX gateway deployments. Configure OpenAI-compatible endpoints, namespaced model IDs, provider keys, and caller access. #### moonshotai Connect Moonshot AI and Kimi models to AISIX gateway deployments. Configure regional endpoints, credentials, model aliases, thinking mode, and caller access. - [Moonshot AI (Kimi)](https://docs.api7.ai/ai-gateway/providers/moonshotai.md): Connect Moonshot AI and Kimi models to AISIX gateway deployments. Configure regional endpoints, credentials, model aliases, thinking mode, and caller access. #### nebius-token-factory Connect Nebius Token Factory to AISIX through its OpenAI-compatible API, with model aliases, endpoint compatibility, and passthrough routes for native APIs. - [Nebius Token Factory](https://docs.api7.ai/ai-gateway/providers/nebius-token-factory.md): Connect Nebius Token Factory to AISIX through its OpenAI-compatible API, with model aliases, endpoint compatibility, and passthrough routes for native APIs. #### novita-ai Connect Novita AI to AISIX through its OpenAI-compatible API, with model aliases, endpoint compatibility, batch workflows, and passthrough routes. - [Novita AI](https://docs.api7.ai/ai-gateway/providers/novita-ai.md): Connect Novita AI to AISIX through its OpenAI-compatible API, with model aliases, endpoint compatibility, batch workflows, and passthrough routes. #### nvidia-nim Connect hosted or privately deployed NVIDIA NIM models to AISIX gateway deployments. Configure endpoint credentials, namespaced model aliases, and caller access. - [NVIDIA NIM](https://docs.api7.ai/ai-gateway/providers/nvidia-nim.md): Connect hosted or privately deployed NVIDIA NIM models to AISIX gateway deployments. Configure endpoint credentials, namespaced model aliases, and caller access. #### ollama Connect an Ollama server to AISIX. Configure private endpoints, native Responses, Anthropic-compatible Messages through passthrough, and model aliases. - [Ollama](https://docs.api7.ai/ai-gateway/providers/ollama.md): Connect an Ollama server to AISIX. Configure private endpoints, native Responses, Anthropic-compatible Messages through passthrough, and model aliases. #### openai Connect OpenAI chat models and Sora video generation to AISIX gateway deployments. Configure credentials, model aliases, caller API keys, access controls, rate limits, and request verification. - [OpenAI](https://docs.api7.ai/ai-gateway/providers/openai.md): Connect OpenAI chat models and Sora video generation to AISIX gateway deployments. Configure credentials, model aliases, caller API keys, access controls, rate limits, and request verification. #### openai-compatible-vendors Configure public OpenAI-compatible LLM providers in AISIX gateway deployments using explicit API endpoints, provider credentials, model aliases, and caller keys. - [Other OpenAI-Compatible Providers](https://docs.api7.ai/ai-gateway/providers/openai-compatible-vendors.md): Configure public OpenAI-compatible LLM providers in AISIX gateway deployments using explicit API endpoints, provider credentials, model aliases, and caller keys. #### openrouter Connect OpenRouter to AISIX through its OpenAI-compatible APIs. Configure credentials, namespaced model aliases, native Responses, routing, and caller access. - [OpenRouter](https://docs.api7.ai/ai-gateway/providers/openrouter.md): Connect OpenRouter to AISIX through its OpenAI-compatible APIs. Configure credentials, namespaced model aliases, native Responses, routing, and caller access. #### overview Compare hosted AI provider APIs and private model servers supported across AISIX gateway deployments, including native adapters, community providers, Ollama, and vLLM. - [Choose a Provider Upstream](https://docs.api7.ai/ai-gateway/providers/overview.md): Compare hosted AI provider APIs and private model servers supported across AISIX gateway deployments, including native adapters, community providers, Ollama, and vLLM. #### ovhcloud-ai-endpoints Connect OVHcloud AI Endpoints to AISIX. Configure credentials, model aliases, native Responses, caller keys, and endpoint limitations. - [OVHcloud AI Endpoints](https://docs.api7.ai/ai-gateway/providers/ovhcloud-ai-endpoints.md): Connect OVHcloud AI Endpoints to AISIX. Configure credentials, model aliases, native Responses, caller keys, and endpoint limitations. #### perplexity Connect Perplexity's native Agent API to AISIX with provider credentials, route access controls, presets, streaming, and background requests. - [Perplexity](https://docs.api7.ai/ai-gateway/providers/perplexity.md): Connect Perplexity's native Agent API to AISIX with provider credentials, route access controls, presets, streaming, and background requests. #### qwen Connect Qwen and Wan to AISIX. Configure regional Model Studio endpoints, native Responses, model aliases, video generation, and caller access. - [Qwen (Alibaba Cloud)](https://docs.api7.ai/ai-gateway/providers/qwen.md): Connect Qwen and Wan to AISIX. Configure regional Model Studio endpoints, native Responses, model aliases, video generation, and caller access. #### runwayml Connect RunwayML video generation to AISIX gateway deployments through the AISIX video API. Configure credentials, model aliases, caller keys, and access controls. - [RunwayML](https://docs.api7.ai/ai-gateway/providers/runwayml.md): Connect RunwayML video generation to AISIX gateway deployments through the AISIX video API. Configure credentials, model aliases, caller keys, and access controls. #### siliconflow Connect SiliconFlow to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, namespaced model IDs, aliases, and caller access. - [SiliconFlow](https://docs.api7.ai/ai-gateway/providers/siliconflow.md): Connect SiliconFlow to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, namespaced model IDs, aliases, and caller access. #### snowflake-cortex Connect Snowflake Cortex to AISIX gateway deployments. Configure account-specific OpenAI-compatible endpoints, credentials, model aliases, and caller access. - [Snowflake Cortex](https://docs.api7.ai/ai-gateway/providers/snowflake-cortex.md): Connect Snowflake Cortex to AISIX gateway deployments. Configure account-specific OpenAI-compatible endpoints, credentials, model aliases, and caller access. #### together Connect Together AI to AISIX gateway deployments through its OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. - [Together AI](https://docs.api7.ai/ai-gateway/providers/together.md): Connect Together AI to AISIX gateway deployments through its OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. #### vllm Connect a private vLLM server to AISIX. Configure native Responses, Anthropic-compatible Messages through passthrough, credentials, and model aliases. - [vLLM](https://docs.api7.ai/ai-gateway/providers/vllm.md): Connect a private vLLM server to AISIX. Configure native Responses, Anthropic-compatible Messages through passthrough, credentials, and model aliases. #### volcengine-ark Connect Volcengine Ark to AISIX for native Responses and Messages, Doubao chat, and Seedance video. Configure credentials, aliases, and caller access. - [Volcengine Ark (Doubao)](https://docs.api7.ai/ai-gateway/providers/volcengine-ark.md): Connect Volcengine Ark to AISIX for native Responses and Messages, Doubao chat, and Seedance video. Configure credentials, aliases, and caller access. #### wandb-inference Connect CoreWeave Serverless Inference to AISIX. Configure Forge credentials, model aliases, caller access, and supported proxy endpoints. - [CoreWeave Serverless Inference](https://docs.api7.ai/ai-gateway/providers/wandb-inference.md): Connect CoreWeave Serverless Inference to AISIX. Configure Forge credentials, model aliases, caller access, and supported proxy endpoints. #### xai Connect xAI Grok models to AISIX through native Responses and Chat Completions APIs. Configure credentials, aliases, regional endpoints, and caller access. - [xAI (Grok)](https://docs.api7.ai/ai-gateway/providers/xai.md): Connect xAI Grok models to AISIX through native Responses and Chat Completions APIs. Configure credentials, aliases, regional endpoints, and caller access. #### zhipuai Connect Zhipu AI to AISIX gateway deployments for GLM chat and CogVideoX video generation. Configure API credentials, model aliases, and caller access. - [Zhipu AI (GLM)](https://docs.api7.ai/ai-gateway/providers/zhipuai.md): Connect Zhipu AI to AISIX gateway deployments for GLM chat and CogVideoX video generation. Configure API credentials, model aliases, and caller access. ### release-notes AISIX release notes covering gateway, control-plane, dashboard, and deployment-package features, improvements, and fixes. - [Release Notes](https://docs.api7.ai/ai-gateway/release-notes.md): AISIX release notes covering gateway, control-plane, dashboard, and deployment-package features, improvements, and fixes. ### routing #### ensemble-models Configure ensemble models in AISIX gateway deployments to fan out chat requests, synthesize panel responses, and manage latency, cost, and failures. - [Ensemble Models](https://docs.api7.ai/ai-gateway/routing/ensemble-models.md): Configure ensemble models in AISIX gateway deployments to fan out chat requests, synthesize panel responses, and manage latency, cost, and failures. #### proxy-errors-and-retries Understand how client applications should handle AISIX gateway proxy errors, retry signals, and upstream failures. - [Proxy Errors and Retries](https://docs.api7.ai/ai-gateway/routing/proxy-errors-and-retries.md): Understand how client applications should handle AISIX gateway proxy errors, retry signals, and upstream failures. #### routing-and-failover Configure and test multi-target routing and failover in AISIX gateway deployments, including selection strategies, retries, runtime filtering, and recovery. - [Multi-Target Routing and Failover](https://docs.api7.ai/ai-gateway/routing/routing-and-failover.md): Configure and test multi-target routing and failover in AISIX gateway deployments, including selection strategies, retries, runtime filtering, and recovery. #### semantic-routing Configure semantic routing in AISIX gateway deployments to select direct models by request meaning, tune similarity thresholds, and define safe fallbacks. - [Semantic Routing](https://docs.api7.ai/ai-gateway/routing/semantic-routing.md): Configure semantic routing in AISIX gateway deployments to select direct models by request meaning, tune similarity thresholds, and define safe fallbacks. #### semantic-routing-typesafe-jev Let TypeSafe's hosted jev decision model choose a semantic router's route from each route's description, instead of comparing embeddings with route examples. - [Semantic Routing with TypeSafe Jev](https://docs.api7.ai/ai-gateway/routing/semantic-routing-typesafe-jev.md): Let TypeSafe's hosted jev decision model choose a semantic router's route from each route's description, instead of comparing embeddings with route examples. ### traffic-controls #### budget-alerts Configure budget alerts in AISIX Enterprise or AISIX Cloud to notify operators through webhooks or Slack when AI spending crosses a defined threshold. - [Budget Alerts and Notifications](https://docs.api7.ai/ai-gateway/traffic-controls/budget-alerts.md): Configure budget alerts in AISIX Enterprise or AISIX Cloud to notify operators through webhooks or Slack when AI spending crosses a defined threshold. #### budgets Configure budgets in AISIX Enterprise or AISIX Cloud to enforce AI spending limits across organizations, environments, caller API keys, provider keys, teams, and members. - [Budgets](https://docs.api7.ai/ai-gateway/traffic-controls/budgets.md): Configure budgets in AISIX Enterprise or AISIX Cloud to enforce AI spending limits across organizations, environments, caller API keys, provider keys, teams, and members. #### caching Configure memory or Redis response caching for eligible Chat Completions requests in AISIX OSS, AISIX Enterprise, and AISIX Cloud. - [Response Caching](https://docs.api7.ai/ai-gateway/traffic-controls/caching.md): Configure memory or Redis response caching for eligible Chat Completions requests in AISIX OSS, AISIX Enterprise, and AISIX Cloud. #### caller-api-keys Configure caller API keys for AISIX gateway deployments, including model access controls, expiration, disablement, rotation, authentication, and verification. - [Caller API Keys](https://docs.api7.ai/ai-gateway/traffic-controls/caller-api-keys.md): Configure caller API keys for AISIX gateway deployments, including model access controls, expiration, disablement, rotation, authentication, and verification. #### claim-mappings Map verified JWT claims in AISIX to caller API keys with priority-ordered rules, shared access controls, and per-identity usage attribution. - [JWT Claim Mappings](https://docs.api7.ai/ai-gateway/traffic-controls/claim-mappings.md): Map verified JWT claims in AISIX to caller API keys with priority-ordered rules, shared access controls, and per-identity usage attribution. #### guardrails - [Alibaba Cloud Content Moderation](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/alibaba-cloud-ai.md): Configure Alibaba Cloud Content Moderation through the AISIX Cloud Admin API or a resources file, then verify TextModerationPlus risk-level enforcement. - [Alibaba Cloud AI Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/alibaba-cloud-ai-guardrails.md): Configure Alibaba Cloud AI Guardrails through the AISIX Cloud Admin API or a resources file, then verify MultiModalGuard blocking and sensitive-data masking. - [AWS Bedrock Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/aws-bedrock.md): Configure AWS Bedrock Guardrails through the AISIX Cloud Admin API or a resources file, then verify blocking and PII anonymization in an AISIX gateway. - [Azure AI Content Safety Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/azure-content-safety.md): Configure Azure AI Content Safety through the AISIX Cloud Admin API or a resources file, then verify Prompt Shield and Text Moderation behavior in AISIX. - [Guardrail Behavior](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/behavior.md): Understand AISIX guardrail hook points, enforcement modes, scope differences, streaming output controls, remote failures, and caller behavior. - [Custom Script Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/custom-script.md): Configure custom JavaScript guardrails through the AISIX Cloud Admin API or a resources file to run screening logic, including calls to content-policy services. - [Built-in Keyword Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/keyword.md): Configure built-in AISIX keyword guardrails through the AISIX Cloud Admin API or a resources file, then verify blocking, monitor mode, and scoped behavior. - [Lakera Guard](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/lakera.md): Configure Lakera Guard through the AISIX Cloud Admin API or a resources file, then verify prompt-injection blocking and PII masking in an AISIX gateway. - [OpenAI Moderation Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/openai-moderation.md): Configure OpenAI Moderation through the AISIX Cloud Admin API or a resources file, then verify blocking and tune per-category thresholds in an AISIX gateway. - [Choosing a Guardrail Provider](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/overview.md): Compare built-in and remote AISIX guardrail providers by evaluation location, detection coverage, enforcement actions, and configuration path. - [PII Detection and Redaction](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/pii.md): Configure built-in AISIX PII detection through the AISIX Cloud Admin API or a resources file, then verify masking, blocking, and custom sensitive-data patterns. - [Presidio Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/presidio.md): Deploy the Presidio analyzer and anonymizer in your own infrastructure, connect them to AISIX as a guardrail, and verify PII anonymization and blocking. - [Qwen3Guard Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/qwen3guard.md): Run the open-source Qwen3Guard safety classifier in your own infrastructure and connect it to AISIX with a custom script guardrail that screens requests and model responses. - [Semantic Screening Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/semantic-screening.md): Configure and verify AISIX semantic screening guardrails for requests and responses, including deny policies, topic allow lists, and threshold setup. - [Calibrate Semantic Screening Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/semantic-screening-calibration.md): Calibrate AISIX semantic screening thresholds with sample and real-traffic scores, interpret request telemetry, and review upgraded policies. - [TypeSafe Jev Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/typesafe-jev.md): Screen requests with TypeSafe's hosted jev decision model through a custom script guardrail that blocks jailbreak attempts, harmful requests, and personal data or secrets before they reach the model. #### jwt-authentication Configure JWT authentication for AISIX gateway callers using JWKS or HMAC verification, claim validation, and identity mapping to caller API keys. - [JWT Authentication](https://docs.api7.ai/ai-gateway/traffic-controls/jwt-authentication.md): Configure JWT authentication for AISIX gateway callers using JWKS or HMAC verification, claim validation, and identity mapping to caller API keys. #### keycloak-integration A verified end-to-end walkthrough — configure a Keycloak realm so each user authenticates at the gateway with their own JWT, and map departments and groups to caller API keys with claim mappings. - [Keycloak Integration](https://docs.api7.ai/ai-gateway/traffic-controls/keycloak-integration.md): A verified end-to-end walkthrough — configure a Keycloak realm so each user authenticates at the gateway with their own JWT, and map departments and groups to caller API keys with claim mappings. #### overview Understand how caller identity, rate limits, guardrails, caching, and budgets in AISIX Enterprise and AISIX Cloud govern requests through AISIX. - [Traffic Controls](https://docs.api7.ai/ai-gateway/traffic-controls/overview.md): Understand how caller identity, rate limits, guardrails, caching, and budgets in AISIX Enterprise and AISIX Cloud govern requests through AISIX. #### prompt-caching Enable automatic Anthropic prompt caching in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway so repeated prompt prefixes receive provider cache discounts. - [Anthropic Prompt Caching](https://docs.api7.ai/ai-gateway/traffic-controls/prompt-caching.md): Enable automatic Anthropic prompt caching in AISIX Enterprise or AISIX Cloud, or in an open-source AISIX gateway so repeated prompt prefixes receive provider cache discounts. #### rate-limit-policies Configure AISIX rate limit policies with conditional traffic matching, independent quota buckets, classic single-scope rules, and suspension schedules. - [Rate Limit Policies](https://docs.api7.ai/ai-gateway/traffic-controls/rate-limit-policies.md): Configure AISIX rate limit policies with conditional traffic matching, independent quota buckets, classic single-scope rules, and suspension schedules. #### rate-limits Configure and verify request, token, and concurrency limits for caller API keys and models in AISIX Enterprise, AISIX Cloud, and AISIX OSS. - [API Key and Model Rate Limits](https://docs.api7.ai/ai-gateway/traffic-controls/rate-limits.md): Configure and verify request, token, and concurrency limits for caller API keys and models in AISIX Enterprise, AISIX Cloud, and AISIX OSS. #### semantic-caching Serve cached Chat Completions responses for semantically similar prompts using embedding similarity, with configurable thresholds, sharing scopes, and purging. - [Semantic Caching](https://docs.api7.ai/ai-gateway/traffic-controls/semantic-caching.md): Serve cached Chat Completions responses for semantically similar prompts using embedding similarity, with configurable thresholds, sharing scopes, and purging. ### why-ai-gateway Learn why production AI traffic benefits from a purpose-built gateway and when to use AISIX instead of AI plugins in APISIX or API7 Gateway. - [Why AI Gateway](https://docs.api7.ai/ai-gateway/why-ai-gateway.md): Learn why production AI traffic benefits from a purpose-built gateway and when to use AISIX instead of AI plugins in APISIX or API7 Gateway. ## api7-gateway ### reference Find API7 Gateway reference documentation for APIs, CLI tools, deployment configuration, security controls, and configuration syntax. - [Reference Overview](https://docs.api7.ai/api7-gateway/reference.md): Find API7 Gateway reference documentation for APIs, CLI tools, deployment configuration, security controls, and configuration syntax. #### admin-api API7 Enterprise Admin APIs are RESTful APIs that allow you to create and manage API7 resources. - [API7 Enterprise Admin APIs](https://docs.api7.ai/api7-gateway/reference/admin-api.md): API7 Enterprise Admin APIs are RESTful APIs that allow you to create and manage API7 resources. #### developer-portal-api API7 Enterprise Admin APIs are RESTful APIs that allow you to create and manage API7 resources. - [API7 Enterprise Developer Portal APIs](https://docs.api7.ai/api7-gateway/reference/developer-portal-api.md): API7 Enterprise Admin APIs are RESTful APIs that allow you to create and manage API7 resources. #### a7-cli Use the separately installed a7 CLI to manage API7 Gateway groups and resources interactively, in scripts, or through API7 Gateway Agent Skills. - [a7 CLI](https://docs.api7.ai/api7-gateway/reference/a7-cli.md): Use the separately installed a7 CLI to manage API7 Gateway groups and resources interactively, in scripts, or through API7 Gateway Agent Skills. #### adc Use API Declarative CLI (ADC) to manage API7 Gateway configuration declaratively. - [API Declarative CLI (ADC)](https://docs.api7.ai/api7-gateway/reference/adc.md): Use API Declarative CLI (ADC) to manage API7 Gateway configuration declaratively. #### alert-template Customize alert notifications with pre-defined variables in API7 Gateway, enabling dynamic content in alert messages and emails. - [Alert Variables and Templates](https://docs.api7.ai/api7-gateway/reference/alert-template.md): Customize alert notifications with pre-defined variables in API7 Gateway, enabling dynamic content in alert messages and emails. #### approval-variables Use API7 Gateway approval variables to customize API product subscription notification email content and webhook messages with current template values. - [Approval Notification Variables and Templates](https://docs.api7.ai/api7-gateway/reference/approval-variables.md): Use API7 Gateway approval variables to customize API product subscription notification email content and webhook messages with current template values. #### built-in-variables Discover the built-in variables available in API7 Gateway, including NGINX and APISIX variables, which can be utilized for route matching, log customization, and plugin configurations. - [Built-In Variables](https://docs.api7.ai/api7-gateway/reference/built-in-variables.md): Discover the built-in variables available in API7 Gateway, including NGINX and APISIX variables, which can be utilized for route matching, log customization, and plugin configurations. #### configuration Understand the configuration files used in API7 Gateway, including default and user-defined files for managing settings effectively. - [Configuration Files](https://docs.api7.ai/api7-gateway/reference/configuration.md): Understand the configuration files used in API7 Gateway, including default and user-defined files for managing settings effectively. #### environment-variables Explore the use of environment variables in API7 Gateway for configuring consumer credentials, SSL certificates, and plugins. - [Environment Variables](https://docs.api7.ai/api7-gateway/reference/environment-variables.md): Explore the use of environment variables in API7 Gateway for configuring consumer credentials, SSL certificates, and plugins. #### expressions Understand how to use expressions in API7 Gateway for route matching, request filtering, and conditional logic in configurations. - [API7 Expressions](https://docs.api7.ai/api7-gateway/reference/expressions.md): Understand how to use expressions in API7 Gateway for route matching, request filtering, and conditional logic in configurations. #### hardening Learn about securing sensitive information in API7 Gateway, including storage, encryption, and communication practices to protect against threats. - [Security Hardening Reference](https://docs.api7.ai/api7-gateway/reference/hardening.md): Learn about securing sensitive information in API7 Gateway, including storage, encryption, and communication practices to protect against threats. #### helm-chart Learn where to find API7 Gateway Helm chart values and how Helm values are rendered into gateway configuration. - [Helm Chart](https://docs.api7.ai/api7-gateway/reference/helm-chart.md): Learn where to find API7 Gateway Helm chart values and how Helm values are rendered into gateway configuration. #### obtain-dashboard-token Create a token in the API7 Dashboard and use it for API7 Gateway Admin API and ADC authentication. - [Obtain a Token from the Dashboard](https://docs.api7.ai/api7-gateway/reference/obtain-dashboard-token.md): Create a token in the API7 Dashboard and use it for API7 Gateway Admin API and ADC authentication. #### permission-policy-action-and-resource Complete reference for all permission policy actions and ARN-style resources in API7 Gateway — organized by namespace (gateway, iam, portal) for building least-privilege policies. - [Permission Policy Actions and Resources](https://docs.api7.ai/api7-gateway/reference/permission-policy-action-and-resource.md): Complete reference for all permission policy actions and ARN-style resources in API7 Gateway — organized by namespace (gateway, iam, portal) for building least-privilege policies. #### permission-policy-examples Ready-to-adapt permission policy examples for API7 Gateway, organized by access pattern, service and plugin operations, IAM and governance, and portal management. - [Permission Policy Examples](https://docs.api7.ai/api7-gateway/reference/permission-policy-examples.md): Ready-to-adapt permission policy examples for API7 Gateway, organized by access pattern, service and plugin operations, IAM and governance, and portal management. ### 3.9.x #### ai-gateway - [Proxy Your First LLM Request in 5 Minutes](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/get-started.md): Set up API7 AI Gateway and proxy your first request to OpenAI in under 5 minutes. Step-by-step guide with code examples. - [Connect to Anthropic Claude](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/anthropic.md): Route Anthropic Claude API traffic through API7 Gateway for centralized security, rate limiting, and observability. - [Integrate Azure OpenAI Service](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/azure-openai.md): Manage Azure OpenAI deployments through API7 Gateway. Handle resource names, API versions, and auth centrally. - [Route Traffic to DeepSeek Models](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/deepseek.md): Proxy DeepSeek API requests through API7 Gateway. Manage authentication, enable failover, and monitor usage centrally. - [Integrate Google Gemini](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/google-gemini.md): Proxy Google Gemini API requests through API7 Gateway. Manage API keys and monitor AI traffic centrally. - [Route Traffic to OpenAI](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/openai.md): Proxy and secure OpenAI API requests through API7 Gateway. Centralize authentication, enable failover, and monitor usage. - [Connect Any OpenAI-Compatible LLM](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/openai-compatible.md): Proxy any OpenAI-compatible API through API7 Gateway. Connect self-hosted models, custom endpoints, or niche providers. - [Access Hundreds of LLMs via OpenRouter](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/openrouter.md): Use OpenRouter with API7 AI Gateway to access 200+ LLMs through one API while maintaining enterprise security controls. - [Route AI Traffic to Gemini Enterprise Agent Platform](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/vertex-ai.md): Route Gemini Enterprise Agent Platform requests through API7 Gateway with service-account authentication and regional endpoints. - [Manage and Secure AI Traffic](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/overview.md): Centralize LLM access with API7 AI Gateway. Route traffic to multiple providers, enforce guardrails, and control costs from one platform. - [Monitor AI Traffic and Track LLM Costs](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/ai-observability-and-cost-tracking.md): Gain visibility into LLM usage, token consumption, latency, and costs with API7 AI Gateway's observability features. - [Transform API Requests with AI-Powered Rewriting](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/ai-request-transformation.md): Use LLMs to intelligently transform, enrich, or restructure API requests and responses at the gateway layer. - [Enforce AI Guardrails and Protect PII](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/content-safety-and-guardrails.md): Block prompt injection, detect toxicity, and redact PII before requests reach LLMs using API7 AI Gateway guardrails. - [Expose REST APIs as MCP Tools for AI Agents](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/expose-apis-as-mcp-tools.md): Convert existing OpenAPI services into MCP-compatible tools so AI agents can discover and invoke your APIs automatically. - [Manage API7 Enterprise from an AI Client with API7-MCP](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/manage-api7-with-mcp.md): Deploy the API7-MCP server so an AI client such as Cursor, Claude Desktop, or Cline can read API7 Enterprise resources, check Prometheus metrics, manage RBAC, and send test traffic through the gateway. - [Set Up Multi-LLM Routing and Automatic Fallback](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/multi-llm-routing-and-fallback.md): Route AI traffic across multiple LLM providers with weighted load balancing, automatic failover, and health checks. - [Implement Prompt Templates and Decorators](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/prompt-engineering-and-templating.md): Standardize LLM interactions with reusable prompt templates and automatic system prompt injection using API7 AI Gateway. - [Convert Anthropic Messages to OpenAI Chat Completions](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/protocol-conversion.md): Use API7 AI Gateway to transparently convert Anthropic Messages API requests to the OpenAI Chat Completions API format, enabling teams to use the Anthropic SDK with any OpenAI-compatible backend. - [Implement RAG at the Gateway Layer](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/retrieval-augmented-generation.md): Enhance LLM responses with relevant context using Retrieval-Augmented Generation (RAG) built into API7 AI Gateway. - [Control AI Costs with Token-Based Rate Limiting](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/use-cases/token-rate-limiting-and-quota-management.md): Implement token-based rate limits to prevent LLM abuse and control AI costs per route and model instance. #### configure-and-manage - [Run Benchmarks on AWS EKS](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/benchmark-on-aws-eks.md): Reproduce the published API7 Gateway performance benchmark on AWS EKS. Walkthrough covers EKS cluster setup, three isolated node groups, Helm install, NGINX upstream and wrk2 deployment, and running the full scenario suite. - [Configuration Reference for API7 Gateway Control Plane](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/configure-control-plane.md): Detailed configuration reference for the API7 Gateway Control Plane, covering the Dashboard and DP Manager configuration files. - [Configuration Reference for API7 Gateway Data Plane](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/configure-data-plane.md): Detailed configuration reference for API7 Gateway Data Plane, based on the config-default.yaml structure. - [Data Plane Resilience](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/data-plane-resilience.md): Configure fallback storage for API7 Gateway data plane nodes so they can restart and continue operating during extended control plane outages. - [Multiple Availability Zones Deployment of API7 Gateway](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/deployment-scenarios/multi-az-deployment.md): Configuration and architecture for deploying API7 Gateway across multiple availability zones for high availability and fault tolerance. - [Multi-Region Deployment Patterns](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/deployment-scenarios/multi-region-deployment.md): Architecture and considerations for deploying API7 Gateway across multiple geographic regions for global reach and disaster recovery. - [Data Plane High Availability](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/high-availability-data-plane.md): Design a highly available API7 Gateway data plane with multiple nodes, health checks, and load balancer failover. - [Labels](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/labels.md): Organize and filter API7 Gateway resources at scale with labels — key-value metadata attached to gateway groups, services, routes, consumers, and other entities for team, environment, and application-level segmentation. - [License Management](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/license-management.md): Manage your API7 Gateway license, understand core quotas and license states, and configure license file paths for automated deployment. - [Performance Benchmark](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/performance-benchmark.md): Published performance benchmark results for API7 Gateway (AWS EKS and single-host baselines), plus methodology and optimization guidance for running your own benchmarks accurately. - [Production Best Practices](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/production-best-practices.md): Operational best practices for managing API7 Gateway in production, including GitOps, change management, and disaster recovery. - [Running in Production](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/run-in-production.md): Pre-production checklist and deployment guide for API7 Gateway to ensure a stable and secure production environment. - [Scale Data Plane](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/scale-data-plane.md): Scale API7 Gateway data plane nodes horizontally to increase throughput and prepare for high-availability deployments. - [Shared Memory Sizing](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/shared-dict-sizing.md): Size API7 Gateway shared memory zones for metrics, service discovery, the Developer Portal, and tracing so they do not overflow at your deployment's scale. - [Optimize Telemetry Data Transfer](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/telemetry-opt-out.md): Configure telemetry data transfer between the data plane and control plane, including compression levels and how to disable telemetry. - [User Management](https://docs.api7.ai/api7-gateway/3.9.x/configure-and-manage/user-management.md): Manage users, roles, and permission policies in API7 Enterprise. #### developer-portal - [Configure the Developer Portal](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/deploy/configure-portal.md): Configure the Developer Portal settings, including public access, portal tokens, built-in authentication, and SCIM provisioning. - [Customize the Developer Portal](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/deploy/customize-portal.md): Customize the Developer Portal branding, theme, authentication providers, and functionality using the API7 Developer Portal Boilerplate. - [Deploy the Developer Portal](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/deploy/deploy-portal.md): Deploy the API7 Developer Portal with its two official images — the Portal API backend and the customer-facing frontend — on Docker Compose or Kubernetes, and connect them to your API7 control plane. - [Browse APIs](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/browse-apis.md): Discover and explore available API products in the Developer Portal's API Hub. - [Create an Application](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/create-application.md): Create an application in the Developer Portal to group your API subscriptions and credentials. - [Manage Credentials](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/manage-credentials.md): Create, view, regenerate, and delete credentials in the Developer Portal for authenticating API requests. - [Manage Your Organization](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/manage-organization.md): Manage your organization in the Developer Portal, including inviting members, assigning roles, and switching between organizations. - [Register and Log In](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/register-and-login.md): Create a developer account and log in to the Developer Portal using email/password, SSO, or an organization invitation. - [Subscribe to an API](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/subscribe-to-api.md): Subscribe your application to an API product to gain access to consume APIs through the Developer Portal. - [Try an API](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/guides/try-api.md): Test API endpoints directly from the Developer Portal using the built-in Try It Out feature. - [API Products](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/key-concepts/api-products.md): Understand API products in the Developer Portal, including product types, visibility settings, authentication options, and the publishing lifecycle. - [Applications](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/key-concepts/applications.md): Understand applications in the Developer Portal, which group subscriptions and credentials for a specific project or use case. - [Credentials](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/key-concepts/credentials.md): Understand credentials in the Developer Portal, including supported authentication types (key auth, basic auth, OAuth/DCR) and credential lifecycle management. - [Developers](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/key-concepts/developers.md): Understand developers in the Developer Portal, including registration methods, account states, and the difference between developers and consumers. - [Subscriptions](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/key-concepts/subscriptions.md): Understand subscriptions in the Developer Portal, including the approval workflow, status transitions, and auto-approval configuration. - [Configure Dynamic Client Registration (DCR)](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/configure-dcr.md): Configure DCR providers to enable developers to register OAuth 2.0 clients through the Developer Portal. - [Configure SCIM Provisioning for a Custom Developer Portal with Okta](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/configure-scim.md): Configure SCIM provisioning with Okta for a custom Developer Portal based on the API7 Developer Portal Boilerplate. - [Configure SSO for the Developer Portal](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/configure-sso.md): Configure Single Sign-On (SSO) for the Developer Portal using OIDC, SAML, LDAP, or CAS identity providers. - [Manage API Products](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/manage-api-products.md): Create, configure, publish, and manage API products in the Provider Portal for developer consumption through the Developer Portal. - [Manage Applications](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/manage-applications.md): Manage developer applications in the Developer Portal, including lifecycle, structure, and how to call the Developer Portal backend programmatically. - [Manage Developers](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/manage-developers.md): Manage developer accounts using the Provider Portal Admin API and the standalone Developer Portal backend, including listing, creating, approving registrations, and deleting developers. - [Manage Subscriptions](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/manage/manage-subscriptions.md): Manage API product subscriptions in the Provider Portal, including approving, rejecting, and cancelling subscription requests. - [Developer Portal Overview](https://docs.api7.ai/api7-gateway/3.9.x/developer-portal/overview.md): Learn about the API7 Developer Portal, a platform for API providers to publish API products and for developers to discover, subscribe to, and consume APIs. #### enterprise-features - [Alerts and Contact Points](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/alerts-and-contact-points.md): Explore the concept of alerts and contact points in API7 Gateway, which monitor exceptions and send timely notifications. - [Anonymous Consumers](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/anonymous-consumers.md): Explore the concept of anonymous consumers in API7 Gateway, allowing non-authenticated access to APIs while maintaining security. - [API Portal](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/api-portal.md): Explore the concept of the API portal in API7 Gateway, providing a centralized space for developers to access and manage APIs. - [Audit and Rollback](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/audit-and-rollback.md): Explore the concept of audit logging and rollback in API7 Gateway, tracking user actions and restoring previous configurations. - [Compliance](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/compliance.md): Explore the concept of compliance in API7 Gateway, helping organizations meet regulatory requirements and maintain security standards. - [Credentials](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/credentials.md): Explore the concept of credentials in API7 Gateway, authenticating users and ensuring secure access while facilitating management and rotation. - [Custom Plugins](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/custom-plugins.md): Explore the concept of custom plugins in API7 Gateway, enabling tailored extensions to meet specific business needs. - [Dashboard SSO Options](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/dashboard-sso.md): Explore the concept of Single Sign-On (SSO) in API7 Gateway, allowing users to authenticate with existing credentials for easy access. - [Enterprise Plugins](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/enterprise-plugins.md): Explore the concept of enterprise plugins in API7 Gateway, which extend functionality and enhance capabilities for API management. - [Gateway Groups](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/gateway-groups.md): Explore the concept of gateway groups in API7 Gateway, which manage multiple API gateway instances with shared configurations. - [High Availability](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/high-availability.md): Explore the concept of high availability in API7 Gateway, ensuring continuous service delivery for mission-critical applications. - [Organization and RBAC](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/organization-and-rbac.md): Explore the concept of organization management and RBAC in API7 Gateway, enabling fine-grained permission management. - [Enterprise Features Overview](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/overview.md): Discover the enterprise-grade features that distinguish API7 Gateway from open-source Apache APISIX, including centralized management, RBAC, audit logging, and professional support. - [Permission Policies and Boundaries](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/permission-policies-and-boundaries.md): Explore the concept of permission policies and boundaries in API7 Gateway, defining user access levels for enhanced security. - [Secret Providers](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/secret-providers.md): Explore the concept of secret providers in API7 Gateway, which enhance security by storing sensitive data using third-party tools. - [Security Hardening](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/security-hardening.md): Explore the concept of security hardening in API7 Gateway, designed to protect API infrastructure against threats and vulnerabilities. - [Service Release](https://docs.api7.ai/api7-gateway/3.9.x/enterprise-features/service-release.md): Explore the concept of service release in API7 Gateway, detailing the creation, configuration, and deployment of APIs effectively. #### getting-started - [Learn More About API7 Products and APISIX](https://docs.api7.ai/api7-gateway/3.9.x/getting-started/learn-more.md): Understand the API7 product family, the relationship between API7 Enterprise and Apache APISIX, and how they fit into your API management strategy. - [API7 Gateway Overview](https://docs.api7.ai/api7-gateway/3.9.x/getting-started/overview.md): Get started with API7 Gateway. Understand the platform components, how they work together, and choose the right path for your use case. - [Quick Start](https://docs.api7.ai/api7-gateway/3.9.x/getting-started/quick-start.md): Get API7 Gateway running locally with Docker Compose and proxy your first API request in under 10 minutes. - [Tutorial: Proxying and Managing API Requests via Plugins](https://docs.api7.ai/api7-gateway/3.9.x/getting-started/tutorial-proxying-api-requests.md): A hands-on tutorial that walks you through proxying API requests, adding authentication with Key Auth, and enabling rate limiting with the Limit Count plugin. #### how-to-guides - [Configure Basic Authentication](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/basic-auth.md): Learn how to secure your APIs by requiring clients to provide a standard username and password in the HTTP Authorization header. - [Configure Data Masking](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/data-masking.md): Use the data-mask plugin to redact, replace, or remove sensitive fields from request data before it is written to access logs and logger plugin output, helping you meet GDPR, HIPAA, and PCI-DSS requirements. - [Forward External Auth User Info to Upstream](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/forward-auth-user-info.md): Forward authenticated user information from OpenID Connect or SAML routes to upstream services as request headers or the consumer name. - [Configure HMAC Authentication](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/hmac-auth.md): Learn how to secure your APIs with Hash-based Message Authentication Code (HMAC) for request signing in API7 Enterprise. - [Configure JWT Authentication](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/jwt-auth.md): Learn how to secure your APIs using JSON Web Tokens (JWT) for stateless authentication in API7 Enterprise. - [Configure Key Authentication](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/api-security/key-auth.md): Learn how to secure your APIs by requiring clients to provide a unique API key in the request header or query string. - [Configure Readiness and Liveness Probes](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/ops/configure-readiness-probe.md): Configure readiness and liveness checks for API7 Gateway data planes in Kubernetes, Docker, and other non-Helm deployments. - [Create a Custom Role](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/ops/create-custom-role.md): Create a custom role in API7 Gateway by defining permission policies, attaching them to a role, and assigning the role to a user. - [Design a Custom Role System](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/ops/design-custom-role-system.md): Design a scalable custom role system in API7 Gateway by combining roles, permission policies, labels, and permission boundaries. - [Manage Gateway Groups](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/ops/multi-gateway-group.md): Learn how to create and manage multiple gateway groups to organize and isolate API traffic across environments or teams. - [Configure Secret Management](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/ops/secret-manager.md): Learn how to configure secret providers and reference external secrets in API7 Enterprise without hardcoding sensitive values in gateway resources. - [How-To Guides](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/overview.md): Practical how-to guides for common API7 Gateway tasks and workflows. - [Plugin Development Best Practices](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/plugin-development/best-practices.md): Write custom Lua plugins that are correct, fast, and maintainable by using the built-in core library instead of low-level OpenResty APIs, validating configuration with a schema, and choosing the right phase and priority. - [Develop Custom Lua Plugins](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/plugin-development/custom-lua-plugins.md): Learn how to develop, register, and test custom Lua plugins for API7 Gateway. - [Serverless Functions or Custom Plugins](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/plugin-development/serverless-or-custom-plugins.md): Compare the built-in serverless-function plugins with custom Lua plugins, and choose the right way to run your own Lua logic in API7 Gateway. - [Configure GraphQL Proxying](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/protocol-proxy/graphql-proxy.md): Learn how to proxy GraphQL APIs through API7 Gateway and when to add GraphQL-aware plugins for rate limiting and caching. - [Configure gRPC Proxying](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/protocol-proxy/grpc-proxy.md): Learn how to configure API7 Enterprise to proxy gRPC traffic, including REST-to-gRPC transcoding and gRPC-Web support for browser clients. - [Configure TCP/UDP Proxying](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/protocol-proxy/tcp-udp-proxy.md): Configure API7 Gateway to proxy TCP and UDP (Layer 4) traffic to upstream services such as databases, message queues, and custom protocols. - [Configure WebSocket Proxying](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/protocol-proxy/websocket-proxy.md): Learn how to enable and configure WebSocket proxying for your routes in API7 Enterprise to handle long-lived, bidirectional connections. - [Implement Blue-Green Deployment](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/blue-green-deployment.md): Implement blue-green deployments using API7 Gateway to switch traffic between two upstream environments with zero downtime. - [Implement Canary Release](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/canary-release.md): Learn how to gradually shift traffic to a new version of your backend service using the traffic-split plugin. - [Configure CORS](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/cors.md): Learn how to configure Cross-Origin Resource Sharing (CORS) for your APIs to allow or restrict access from different domains. - [Configure Fault Injection](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/fault-injection.md): Learn how to test the resilience of your application by injecting HTTP errors and response delays. - [Conditionally Disable Global Plugins](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/global-plugin-exemption.md): Conditionally skip global plugin execution for specific routes using route labels and the _meta.filter mechanism. - [Configure Upstream Health Checks](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/health-check.md): Learn how to configure active and passive health checks for upstream services to ensure high availability. - [Configure Proxy Cache](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/proxy-cache.md): Learn how to improve API performance and reduce upstream load by caching responses at the Gateway. - [Configure Proxy Mirror](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/proxy-mirror.md): Learn how to duplicate and send a percentage of real production traffic to a secondary service for testing and verification. - [Rewrite Proxy Requests](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/proxy-rewrite.md): Learn how to modify request URIs, methods, and headers before proxying them to upstream services. - [Configure Rate Limiting](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/rate-limiting.md): Learn how to configure simple and advanced rate limiting for your APIs to prevent abuse and ensure fair usage. - [Configure Response Rewrite](https://docs.api7.ai/api7-gateway/3.9.x/how-to-guides/traffic-management/response-rewrite.md): Learn how to modify response status codes, headers, and body content before they are returned to the client. #### install - [Deploy for High Availability](https://docs.api7.ai/api7-gateway/3.9.x/install/deploy-high-availability.md): Deploy API7 Gateway control plane and data plane in a high-availability configuration to eliminate single points of failure. - [Deploy on Kubernetes](https://docs.api7.ai/api7-gateway/3.9.x/install/deploy-on-kubernetes.md): Deploy API7 Enterprise on Kubernetes using Helm, including control plane setup, data plane configuration with mTLS, and cloud-specific guidance for AWS EKS, GCP GKE, and Azure AKS. - [Deploy on OpenShift](https://docs.api7.ai/api7-gateway/3.9.x/install/deploy-on-openshift.md): Deploy API7 Gateway on Red Hat OpenShift with proper Security Context Constraints (SCCs), service accounts, and Helm chart configuration. - [Deploy with Docker Compose](https://docs.api7.ai/api7-gateway/3.9.x/install/deploy-with-docker-compose.md): Deploy API7 Enterprise locally with Docker Compose. This development and testing setup brings up the control plane with PostgreSQL, Prometheus, Jaeger, the integrated Dashboard, and the DP Manager, then adds a data plane gateway with a dashboard-generated Docker command. - [Installation FAQ](https://docs.api7.ai/api7-gateway/3.9.x/install/installation-faq.md): Frequently asked questions and troubleshooting common installation issues. - [Installation Packages](https://docs.api7.ai/api7-gateway/3.9.x/install/installation-packages.md): Container images, Helm charts, and CLI tools used to install API7 Enterprise — including the official Docker Hub repositories for the gateway, DP manager, Developer Portal, and integrated control plane images. - [Install API7 Gateway On-Premises](https://docs.api7.ai/api7-gateway/3.9.x/install/overview.md): Overview of deployment options for API7 Enterprise on-premises infrastructure. - [Supported Versions and Interoperability](https://docs.api7.ai/api7-gateway/3.9.x/install/supported-versions-and-interoperability.md): Version compatibility matrix for API7 Enterprise components and infrastructure. - [System Requirements](https://docs.api7.ai/api7-gateway/3.9.x/install/system-requirements.md): Hardware, operating system, and network requirements for installing API7 Gateway. #### key-concepts - [Architecture](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/architecture.md): Deep dive into the decoupled control plane and data plane architecture of API7 Enterprise. - [Consumers and Credentials](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/consumers-and-credentials.md): Identity management and authentication using Consumers and Credentials. - [Gateway Groups](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/gateway-groups.md): Logical grouping of data plane instances for environment isolation and configuration management. - [Key Concepts Overview](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/overview.md): Introduction to the core abstractions and entities in API7 Enterprise. - [Plugins](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/plugins.md): Modular components to intercept and modify API traffic in API7 Gateway. - [Service Discovery](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/service-discovery.md): Dynamic upstream resolution in API7 Gateway — automatically discover backend endpoints from Kubernetes Services, Nacos, and Consul registries without hardcoding IPs. - [Services and Routes](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/services-and-routes.md): Understand how to group and route API traffic using Services and Routes. - [SSL Certificates](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/ssl-certificates.md): Understanding how API7 Gateway manages SSL/TLS certificates and terminates secure connections. - [Stream Routes](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/stream-routes.md): Understand stream routes in API7 Gateway for proxying TCP and UDP (Layer 4) traffic, including matching rules, supported plugins, and the relationship with stream services. - [Upstreams and Load Balancing](https://docs.api7.ai/api7-gateway/3.9.x/key-concepts/upstreams-and-load-balancing.md): Definitions of backend targets, including load balancing algorithms and health checks. #### observability - [Configure Alerts](https://docs.api7.ai/api7-gateway/3.9.x/observability/alerts.md): Configure alert policies and contact points in API7 Gateway to get notified by email or webhook when gateway instances go offline, certificates expire, or error rates breach a threshold. - [Include Consumer Labels in Access Logs](https://docs.api7.ai/api7-gateway/3.9.x/observability/consumer-label-based-logging.md): Include consumer labels in API7 Gateway access logs for per-consumer traffic tracking and analysis. - [Capture Request Traces with Debug Sessions](https://docs.api7.ai/api7-gateway/3.9.x/observability/debug-sessions.md): Find out exactly what the gateway did to a single request — which plugins ran, in what order, which one was slow, and what it logged. Capture on demand, or automatically when an alert fires. - [Use an Existing Prometheus](https://docs.api7.ai/api7-gateway/3.9.x/observability/external-prometheus.md): Configure API7 Gateway to use an external Prometheus in Docker Compose, remove the bundled instance, and route Dashboard Monitoring queries to the replacement. - [Send Kubernetes Error Logs to Splunk](https://docs.api7.ai/api7-gateway/3.9.x/observability/kubernetes-error-log-forwarding.md): Forward API7 Gateway error logs from Kubernetes to Splunk by using the Splunk OpenTelemetry Collector. - [Configure Centralized Logging](https://docs.api7.ai/api7-gateway/3.9.x/observability/logging.md): Understand the access and error logs that API7 Gateway produces, how to configure their format and verbosity, and how to forward them to a centralized log management system. - [Monitor Metrics](https://docs.api7.ai/api7-gateway/3.9.x/observability/metrics.md): Monitor API7 Gateway metrics in the Dashboard, inspect the data-plane metrics endpoint, or send metrics to Prometheus through remote write. - [Data Plane Metrics Reference](https://docs.api7.ai/api7-gateway/3.9.x/observability/metrics-reference.md): Look up the core Prometheus metric families and built-in labels exported by API7 Gateway data planes. - [Send Access Logs to Splunk](https://docs.api7.ai/api7-gateway/3.9.x/observability/splunk-integration.md): Send API7 Gateway access logs to Splunk using the HTTP Event Collector (HEC) logging plugin. - [Configure Distributed Tracing](https://docs.api7.ai/api7-gateway/3.9.x/observability/tracing.md): Configure API7 Gateway distributed tracing with OpenTelemetry, export sampled spans to an OTLP/HTTP endpoint, and correlate trace IDs with access logs. #### overview Discover API7 Gateway, a dynamic, high-performance API gateway for cloud-native environments, built on Apache APISIX. Learn about its architecture, features, and deployment models. - [API7 Gateway](https://docs.api7.ai/api7-gateway/3.9.x/overview.md): Discover API7 Gateway, a dynamic, high-performance API gateway for cloud-native environments, built on Apache APISIX. Learn about its architecture, features, and deployment models. #### reference Technical reference documentation for API7 Gateway, including configuration files, environment variables, CLI tools, and API specifications. - [Reference Overview](https://docs.api7.ai/api7-gateway/3.9.x/reference.md): Technical reference documentation for API7 Gateway, including configuration files, environment variables, CLI tools, and API specifications. - [API Declarative CLI (ADC)](https://docs.api7.ai/api7-gateway/3.9.x/reference/adc.md): Use API Declarative CLI (ADC) to manage API7 Gateway configuration declaratively. - [Alert Variables and Templates](https://docs.api7.ai/api7-gateway/3.9.x/reference/alert-template.md): Customize alert notifications with pre-defined variables in API7 Gateway, enabling dynamic content in alert messages and emails. - [Approval Notification Variables and Templates](https://docs.api7.ai/api7-gateway/3.9.x/reference/approval-variables.md): Use API7 Gateway approval variables to customize API product subscription notification email content and webhook messages with current template values. - [Built-In Variables](https://docs.api7.ai/api7-gateway/3.9.x/reference/built-in-variables.md): Discover the built-in variables available in API7 Gateway, including NGINX and APISIX variables, which can be utilized for route matching, log customization, and plugin configurations. - [Configuration Files](https://docs.api7.ai/api7-gateway/3.9.x/reference/configuration.md): Understand the configuration files used in API7 Gateway, including default and user-defined files for managing settings effectively. - [Environment Variables](https://docs.api7.ai/api7-gateway/3.9.x/reference/environment-variables.md): Explore the use of environment variables in API7 Gateway for configuring consumer credentials, SSL certificates, and plugins. - [API7 Expressions](https://docs.api7.ai/api7-gateway/3.9.x/reference/expressions.md): Understand how to use expressions in API7 Gateway for route matching, request filtering, and conditional logic in configurations. - [Security Hardening Reference](https://docs.api7.ai/api7-gateway/3.9.x/reference/hardening.md): Learn about securing sensitive information in API7 Gateway, including storage, encryption, and communication practices to protect against threats. - [Helm Chart](https://docs.api7.ai/api7-gateway/3.9.x/reference/helm-chart.md): Learn where to find API7 Gateway Helm chart values and how Helm values are rendered into gateway configuration. - [Obtain a Token from the Dashboard](https://docs.api7.ai/api7-gateway/3.9.x/reference/obtain-dashboard-token.md): Create a token in the API7 Dashboard and use it for API7 Gateway Admin API and ADC authentication. - [Permission Policy Actions and Resources](https://docs.api7.ai/api7-gateway/3.9.x/reference/permission-policy-action-and-resource.md): Complete reference for all permission policy actions and ARN-style resources in API7 Gateway — organized by namespace (gateway, iam, portal) for building least-privilege policies. - [Permission Policy Examples](https://docs.api7.ai/api7-gateway/3.9.x/reference/permission-policy-examples.md): Ready-to-adapt permission policy examples for API7 Gateway, organized by access pattern, service and plugin operations, IAM and governance, and portal management. #### release-notes Review the latest updates, features, improvements, and bug fixes for each version of API7 Gateway in release notes. - [API7 Gateway Release Notes](https://docs.api7.ai/api7-gateway/3.9.x/release-notes.md): Review the latest updates, features, improvements, and bug fixes for each version of API7 Gateway in release notes. #### scalability - [Autoscale Data Plane on Kubernetes](https://docs.api7.ai/api7-gateway/3.9.x/scalability/autoscale-on-kubernetes.md): Autoscale API7 Gateway data plane pods on Kubernetes with a Horizontal Pod Autoscaler (HPA) to handle changing traffic automatically. #### security-and-compliance - [Access Control Lists](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/access-control-lists.md): Restrict API access using the consumer-restriction plugin in API7 Gateway with consumer, service, or route allow and deny lists. - [Audit Logs](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/audit-logs.md): Track all administrative changes in the API7 Control Plane with detailed audit logs. Learn how to review, manage, and export audit trails for security and compliance. - [Client mTLS Authentication](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/client-mtls.md): Configure mutual TLS (mTLS) on API7 Gateway to authenticate API clients with X.509 certificates before allowing access to your APIs. - [Mutual TLS between Control Plane and Data Plane](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/mutual-tls-cp-dp.md): Learn how API7 Gateway uses a robust, PKI-based mutual TLS (mTLS) model to secure all communication between the Control Plane and Data Plane. - [SCIM Provisioning for Dashboard](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/scim.md): Configure SCIM provisioning for API7 Gateway Dashboard with supported identity providers. - [SCIM Provisioning with Microsoft Entra ID](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/scim-microsoft-entra-id.md): Configure SCIM provisioning with Microsoft Entra ID for API7 Gateway Dashboard. - [SCIM Provisioning with Okta](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/scim-okta.md): Configure SCIM provisioning with Okta for API7 Gateway Dashboard. - [Upstream mTLS](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/authenticate/upstream-mtls.md): Configure mutual TLS (mTLS) between API7 Gateway and upstream services so the gateway presents a client certificate to the upstream and optionally validates the upstream's server certificate. - [IP Restrictions for Control Plane](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/ip-restrictions-control-plane.md): Restrict which client IP addresses can reach the API7 Control Plane (Dashboard and Admin API) using the Control Plane's built-in IP allow list, with complementary network-level controls for defence in depth. - [OAuth 2.0 and OIDC](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/oauth-oidc.md): Secure your APIs with modern token-based authentication. Learn how to integrate API7 Gateway with OAuth 2.0 and OpenID Connect (OIDC) providers like Okta and Keycloak. - [Open Source Licenses](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/open-source-licenses.md): API7 Gateway's commitment to open-source software and license compliance. Review the major open-source components used and their respective licenses. - [Security and Compliance Overview](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/overview.md): Learn how API7 Gateway provides comprehensive security and compliance features to protect your APIs, including authentication, authorization, encryption, and auditing capabilities. - [Permission Policies and Boundaries](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/permission-policies-and-boundaries.md): Author permission policies in API7 Gateway using the native JSON document format. Learn the statement structure, allowed actions, ARN-style resources, label-based conditions, and how permission boundaries enforce maximum allowable permissions. - [Role-Based Access Control (RBAC)](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/role-based-access-control.md): Manage user access to the API7 Gateway control plane with Role-Based Access Control. Assign users to roles, attach permission policies, and enforce least-privilege access across gateway groups. - [Secure Credentials Management](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/secure-credentials.md): Protect your sensitive information with API7 Gateway's secure credentials management. Learn how to manage SSL certificates and integrate with external secret managers like HashiCorp Vault. - [SSO for Dashboard](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/sso-dashboard.md): Centralize user access to the API7 Dashboard using Single Sign-On (SSO). Supports OIDC, SAML, LDAP, and CAS protocols with automatic role mapping. - [SSO with LDAP](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/sso-ldap.md): Configure Single Sign-On (SSO) for the API7 Dashboard using LDAP, allowing users to authenticate with their existing directory service credentials. - [SSO with OIDC](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/sso-oidc.md): Configure Single Sign-On (SSO) for the API7 Dashboard using OpenID Connect (OIDC), with provider-specific guidance for Keycloak, Microsoft Entra ID, and Auth0. - [SSO with SAML](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/sso-saml.md): Configure Single Sign-On (SSO) for the API7 Dashboard using SAML 2.0, with provider-specific guidance for Microsoft Entra ID and Okta. - [Trust Center](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/trust-center.md): The API7 Trust Center is your centralized resource for all security and compliance-related information, including certifications, security reports, and best practice guides. - [Verify Image Signatures](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/verify-image-signatures.md): Verify API7 Enterprise container image signatures with Cosign and keyless OIDC-based verification. Protect your supply chain by confirming every image was built and signed by API7.ai. - [Vulnerability Scanning](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/vulnerability-scanning.md): Learn about API7.ai's security testing and vulnerability scanning practices for API7 Gateway, including our CVE reporting and patching processes. - [Web Application Firewall (WAF)](https://docs.api7.ai/api7-gateway/3.9.x/security-and-compliance/web-application-firewall.md): Learn when to use a Web Application Firewall with API7 Gateway, how it fits into your security model, and where to find the current documented integration path. #### troubleshooting Diagnose and resolve common issues with API7 Gateway deployments, including connectivity problems, configuration errors, and performance degradation. - [Troubleshoot API7 Gateway](https://docs.api7.ai/api7-gateway/3.9.x/troubleshooting.md): Diagnose and resolve common issues with API7 Gateway deployments, including connectivity problems, configuration errors, and performance degradation. #### upgrade-guides - [Backup and Restoration](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/backup-and-restore.md): Back up and restore API7 Gateway CP data and gateway-group configuration with database-native tools and ADC. - [Migrate API7 Gateway to a New Cluster](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/cluster-migration.md): Move API7 Gateway to a new cluster at the same product version with independent databases, staged traffic shifting, and a recoverable rollback plan. - [Dual-Cluster Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/dual-cluster.md): Upgrade API7 Gateway with independent source and target clusters, controlled traffic shifting, write reconciliation, validation, and conditional rollback. - [Control Plane In-Place Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/in-place.md): Upgrade the API7 Gateway Control Plane against its existing database with a write freeze, source shutdown, target validation, and recoverable rollback. - [Data Plane Rolling Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/rolling-upgrade.md): Replace API7 Gateway Data Plane nodes gradually with capacity planning, canary validation, add-before-drain rollout, traffic checks, and rollback. - [Plan an API7 Gateway Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/upgrade.md): Plan an API7 Gateway upgrade by confirming the supported version path, selecting deployment strategies, preparing backups, and rehearsing rollback. #### version-support-policy API7 Enterprise version support lifecycle, LTS policy, and upgrade guidance. Learn how long each release is supported and which versions are currently designated as LTS. - [Version Support Policy](https://docs.api7.ai/api7-gateway/3.9.x/version-support-policy.md): API7 Enterprise version support lifecycle, LTS policy, and upgrade guidance. Learn how long each release is supported and which versions are currently designated as LTS. ### ai-gateway #### get-started Set up API7 AI Gateway and proxy your first request to OpenAI in under 5 minutes. Step-by-step guide with code examples. - [Proxy Your First LLM Request in 5 Minutes](https://docs.api7.ai/api7-gateway/ai-gateway/get-started.md): Set up API7 AI Gateway and proxy your first request to OpenAI in under 5 minutes. Step-by-step guide with code examples. #### llm-providers - [Connect to Anthropic Claude](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/anthropic.md): Route Anthropic Claude API traffic through API7 Gateway for centralized security, rate limiting, and observability. - [Integrate Azure OpenAI Service](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/azure-openai.md): Manage Azure OpenAI deployments through API7 Gateway. Handle resource names, API versions, and auth centrally. - [Route Traffic to DeepSeek Models](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/deepseek.md): Proxy DeepSeek API requests through API7 Gateway. Manage authentication, enable failover, and monitor usage centrally. - [Integrate Google Gemini](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/google-gemini.md): Proxy Google Gemini API requests through API7 Gateway. Manage API keys and monitor AI traffic centrally. - [Route Traffic to OpenAI](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/openai.md): Proxy and secure OpenAI API requests through API7 Gateway. Centralize authentication, enable failover, and monitor usage. - [Connect Any OpenAI-Compatible LLM](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/openai-compatible.md): Proxy any OpenAI-compatible API through API7 Gateway. Connect self-hosted models, custom endpoints, or niche providers. - [Access Hundreds of LLMs via OpenRouter](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/openrouter.md): Use OpenRouter with API7 AI Gateway to access 200+ LLMs through one API while maintaining enterprise security controls. - [Route AI Traffic to Gemini Enterprise Agent Platform](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/vertex-ai.md): Route Gemini Enterprise Agent Platform requests through API7 Gateway with service-account authentication and regional endpoints. #### overview Centralize LLM access with API7 AI Gateway. Route traffic to multiple providers, enforce guardrails, and control costs from one platform. - [Manage and Secure AI Traffic](https://docs.api7.ai/api7-gateway/ai-gateway/overview.md): Centralize LLM access with API7 AI Gateway. Route traffic to multiple providers, enforce guardrails, and control costs from one platform. #### use-cases - [Monitor AI Traffic and Track LLM Costs](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/ai-observability-and-cost-tracking.md): Gain visibility into LLM usage, token consumption, latency, and costs with API7 AI Gateway's observability features. - [Transform API Requests with AI-Powered Rewriting](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/ai-request-transformation.md): Use LLMs to intelligently transform, enrich, or restructure API requests and responses at the gateway layer. - [Enforce AI Guardrails and Protect PII](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/content-safety-and-guardrails.md): Block prompt injection, detect toxicity, and redact PII before requests reach LLMs using API7 AI Gateway guardrails. - [Expose REST APIs as MCP Tools for AI Agents](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/expose-apis-as-mcp-tools.md): Convert existing OpenAPI services into MCP-compatible tools so AI agents can discover and invoke your APIs automatically. - [Manage API7 Enterprise from an AI Client with API7-MCP](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/manage-api7-with-mcp.md): Deploy the API7-MCP server so an AI client such as Cursor, Claude Desktop, or Cline can read API7 Enterprise resources, check Prometheus metrics, manage RBAC, and send test traffic through the gateway. - [Set Up Multi-LLM Routing and Automatic Fallback](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/multi-llm-routing-and-fallback.md): Route AI traffic across multiple LLM providers with weighted load balancing, automatic failover, and health checks. - [Implement Prompt Templates and Decorators](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/prompt-engineering-and-templating.md): Standardize LLM interactions with reusable prompt templates and automatic system prompt injection using API7 AI Gateway. - [Convert Anthropic Messages to OpenAI Chat Completions](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/protocol-conversion.md): Use API7 AI Gateway to transparently convert Anthropic Messages API requests to the OpenAI Chat Completions API format, enabling teams to use the Anthropic SDK with any OpenAI-compatible backend. - [Implement RAG at the Gateway Layer](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/retrieval-augmented-generation.md): Enhance LLM responses with relevant context using Retrieval-Augmented Generation (RAG) built into API7 AI Gateway. - [Control AI Costs with Token-Based Rate Limiting](https://docs.api7.ai/api7-gateway/ai-gateway/use-cases/token-rate-limiting-and-quota-management.md): Implement token-based rate limits to prevent LLM abuse and control AI costs per route and model instance. ### configure-and-manage #### benchmark-on-aws-eks Reproduce the published API7 Gateway performance benchmark on AWS EKS. Walkthrough covers EKS cluster setup, three isolated node groups, Helm install, NGINX upstream and wrk2 deployment, and running the full scenario suite. - [Run Benchmarks on AWS EKS](https://docs.api7.ai/api7-gateway/configure-and-manage/benchmark-on-aws-eks.md): Reproduce the published API7 Gateway performance benchmark on AWS EKS. Walkthrough covers EKS cluster setup, three isolated node groups, Helm install, NGINX upstream and wrk2 deployment, and running the full scenario suite. #### configure-control-plane Detailed configuration reference for the API7 Gateway Control Plane, covering the Dashboard and DP Manager configuration files. - [Configuration Reference for API7 Gateway Control Plane](https://docs.api7.ai/api7-gateway/configure-and-manage/configure-control-plane.md): Detailed configuration reference for the API7 Gateway Control Plane, covering the Dashboard and DP Manager configuration files. #### configure-data-plane Detailed configuration reference for API7 Gateway Data Plane, based on the config-default.yaml structure. - [Configuration Reference for API7 Gateway Data Plane](https://docs.api7.ai/api7-gateway/configure-and-manage/configure-data-plane.md): Detailed configuration reference for API7 Gateway Data Plane, based on the config-default.yaml structure. #### data-plane-resilience Configure fallback storage for API7 Gateway data plane nodes so they can restart and continue operating during extended control plane outages. - [Data Plane Resilience](https://docs.api7.ai/api7-gateway/configure-and-manage/data-plane-resilience.md): Configure fallback storage for API7 Gateway data plane nodes so they can restart and continue operating during extended control plane outages. #### deployment-scenarios - [Multiple Availability Zones Deployment of API7 Gateway](https://docs.api7.ai/api7-gateway/configure-and-manage/deployment-scenarios/multi-az-deployment.md): Configuration and architecture for deploying API7 Gateway across multiple availability zones for high availability and fault tolerance. - [Multi-Region Deployment Patterns](https://docs.api7.ai/api7-gateway/configure-and-manage/deployment-scenarios/multi-region-deployment.md): Architecture and considerations for deploying API7 Gateway across multiple geographic regions for global reach and disaster recovery. #### high-availability-data-plane Design a highly available API7 Gateway data plane with multiple nodes, health checks, and load balancer failover. - [Data Plane High Availability](https://docs.api7.ai/api7-gateway/configure-and-manage/high-availability-data-plane.md): Design a highly available API7 Gateway data plane with multiple nodes, health checks, and load balancer failover. #### labels Organize and filter API7 Gateway resources at scale with labels — key-value metadata attached to gateway groups, services, routes, consumers, and other entities for team, environment, and application-level segmentation. - [Labels](https://docs.api7.ai/api7-gateway/configure-and-manage/labels.md): Organize and filter API7 Gateway resources at scale with labels — key-value metadata attached to gateway groups, services, routes, consumers, and other entities for team, environment, and application-level segmentation. #### license-management Manage your API7 Gateway license, understand the production and non-production core quotas and license states, and configure license file paths for automated deployment. - [License Management](https://docs.api7.ai/api7-gateway/configure-and-manage/license-management.md): Manage your API7 Gateway license, understand the production and non-production core quotas and license states, and configure license file paths for automated deployment. #### performance-benchmark Published performance benchmark results for API7 Gateway (AWS EKS and single-host baselines), plus methodology and optimization guidance for running your own benchmarks accurately. - [Performance Benchmark](https://docs.api7.ai/api7-gateway/configure-and-manage/performance-benchmark.md): Published performance benchmark results for API7 Gateway (AWS EKS and single-host baselines), plus methodology and optimization guidance for running your own benchmarks accurately. #### production-best-practices Operational best practices for managing API7 Gateway in production, including GitOps, change management, and disaster recovery. - [Production Best Practices](https://docs.api7.ai/api7-gateway/configure-and-manage/production-best-practices.md): Operational best practices for managing API7 Gateway in production, including GitOps, change management, and disaster recovery. #### run-in-production Pre-production checklist and deployment guide for API7 Gateway to ensure a stable and secure production environment. - [Running in Production](https://docs.api7.ai/api7-gateway/configure-and-manage/run-in-production.md): Pre-production checklist and deployment guide for API7 Gateway to ensure a stable and secure production environment. #### scale-data-plane Scale API7 Gateway data plane nodes horizontally to increase throughput and prepare for high-availability deployments. - [Scale Data Plane](https://docs.api7.ai/api7-gateway/configure-and-manage/scale-data-plane.md): Scale API7 Gateway data plane nodes horizontally to increase throughput and prepare for high-availability deployments. #### shared-dict-sizing Size API7 Gateway shared memory zones for metrics, service discovery, the Developer Portal, and tracing so they do not overflow at your deployment's scale. - [Shared Memory Sizing](https://docs.api7.ai/api7-gateway/configure-and-manage/shared-dict-sizing.md): Size API7 Gateway shared memory zones for metrics, service discovery, the Developer Portal, and tracing so they do not overflow at your deployment's scale. #### telemetry-opt-out Configure telemetry data transfer between the data plane and control plane, including compression levels and how to disable telemetry. - [Optimize Telemetry Data Transfer](https://docs.api7.ai/api7-gateway/configure-and-manage/telemetry-opt-out.md): Configure telemetry data transfer between the data plane and control plane, including compression levels and how to disable telemetry. #### user-management Manage users, roles, and permission policies in API7 Enterprise. - [User Management](https://docs.api7.ai/api7-gateway/configure-and-manage/user-management.md): Manage users, roles, and permission policies in API7 Enterprise. ### developer-portal #### deploy - [Configure the Developer Portal](https://docs.api7.ai/api7-gateway/developer-portal/deploy/configure-portal.md): Configure Developer Portal access, portal tokens, and built-in authentication settings, and understand the custom integration needed for SCIM provisioning. - [Customize the Developer Portal](https://docs.api7.ai/api7-gateway/developer-portal/deploy/customize-portal.md): Customize Developer Portal branding, authentication, routes, and functionality using the TanStack Start API7 Developer Portal Boilerplate. - [Deploy the Developer Portal](https://docs.api7.ai/api7-gateway/developer-portal/deploy/deploy-portal.md): Deploy the API7 Developer Portal with its two official images — the Portal API backend and the customer-facing frontend — on Docker Compose or Kubernetes, and connect them to your API7 control plane. #### get-started Start a local API7 Developer Portal from the packaged Docker Compose deployment, register a developer, and verify access to the API Hub. - [Start a Local Developer Portal](https://docs.api7.ai/api7-gateway/developer-portal/get-started.md): Start a local API7 Developer Portal from the packaged Docker Compose deployment, register a developer, and verify access to the API Hub. #### guides - [Browse APIs](https://docs.api7.ai/api7-gateway/developer-portal/guides/browse-apis.md): Discover and explore available API products in the Developer Portal's API Hub. - [Create an Application](https://docs.api7.ai/api7-gateway/developer-portal/guides/create-application.md): Create an application in the Developer Portal to group your API subscriptions and credentials. - [Manage Credentials](https://docs.api7.ai/api7-gateway/developer-portal/guides/manage-credentials.md): Create, view, regenerate, and delete credentials in the Developer Portal for authenticating API requests. - [Manage Your Organization](https://docs.api7.ai/api7-gateway/developer-portal/guides/manage-organization.md): Manage your organization in the Developer Portal, including inviting members, assigning roles, and switching between organizations. - [Register and Log In](https://docs.api7.ai/api7-gateway/developer-portal/guides/register-and-login.md): Create a developer account and log in to the Developer Portal using email/password, SSO, or an organization invitation. - [Subscribe to an API](https://docs.api7.ai/api7-gateway/developer-portal/guides/subscribe-to-api.md): Subscribe your application to an API product to gain access to consume APIs through the Developer Portal. - [Try an API](https://docs.api7.ai/api7-gateway/developer-portal/guides/try-api.md): Test API endpoints directly from the Developer Portal using the built-in Try It Out feature. #### key-concepts - [API Products](https://docs.api7.ai/api7-gateway/developer-portal/key-concepts/api-products.md): Understand API products in the Developer Portal, including product types, visibility settings, authentication options, and the publishing lifecycle. - [Applications](https://docs.api7.ai/api7-gateway/developer-portal/key-concepts/applications.md): Understand applications in the Developer Portal, which group subscriptions and credentials for a specific project or use case. - [Credentials](https://docs.api7.ai/api7-gateway/developer-portal/key-concepts/credentials.md): Understand credentials in the Developer Portal, including supported authentication types (key auth, basic auth, OAuth/DCR) and credential lifecycle management. - [Developers](https://docs.api7.ai/api7-gateway/developer-portal/key-concepts/developers.md): Understand developers in the Developer Portal, including registration methods, account states, and the difference between developers and consumers. - [Subscriptions](https://docs.api7.ai/api7-gateway/developer-portal/key-concepts/subscriptions.md): Understand subscriptions in the Developer Portal, including the approval workflow, status transitions, and auto-approval configuration. #### manage - [Configure Dynamic Client Registration (DCR)](https://docs.api7.ai/api7-gateway/developer-portal/manage/configure-dcr.md): Configure DCR providers to enable developers to register OAuth 2.0 clients through the Developer Portal. - [Configure SCIM Provisioning for a Custom Developer Portal with Okta](https://docs.api7.ai/api7-gateway/developer-portal/manage/configure-scim.md): Configure SCIM provisioning with Okta for a custom Developer Portal based on the API7 Developer Portal Boilerplate. - [Developer Portal SSO Status](https://docs.api7.ai/api7-gateway/developer-portal/manage/configure-sso.md): Understand the API7 Gateway 3.10.x component mismatch that prevents a verified Developer Portal SSO configuration procedure. - [Manage API Products](https://docs.api7.ai/api7-gateway/developer-portal/manage/manage-api-products.md): Create, configure, publish, and manage API products in the Provider Portal for developer consumption through the Developer Portal. - [Manage Applications](https://docs.api7.ai/api7-gateway/developer-portal/manage/manage-applications.md): Manage developer applications in the Developer Portal, including lifecycle, structure, and how to call the Developer Portal backend programmatically. - [Manage Developers](https://docs.api7.ai/api7-gateway/developer-portal/manage/manage-developers.md): Manage developer accounts using the Provider Portal Admin API and the standalone Developer Portal backend, including listing, creating, approving registrations, and deleting developers. - [Manage Subscriptions](https://docs.api7.ai/api7-gateway/developer-portal/manage/manage-subscriptions.md): Manage API product subscriptions in the Provider Portal, including approving, rejecting, and cancelling subscription requests. #### overview Learn about the API7 Developer Portal, a platform for API providers to publish API products and for developers to discover, subscribe to, and consume APIs. - [Developer Portal Overview](https://docs.api7.ai/api7-gateway/developer-portal/overview.md): Learn about the API7 Developer Portal, a platform for API providers to publish API products and for developers to discover, subscribe to, and consume APIs. ### enterprise-features #### alerts-and-contact-points Explore the concept of alerts and contact points in API7 Gateway, which monitor exceptions and send timely notifications. - [Alerts and Contact Points](https://docs.api7.ai/api7-gateway/enterprise-features/alerts-and-contact-points.md): Explore the concept of alerts and contact points in API7 Gateway, which monitor exceptions and send timely notifications. #### anonymous-consumers Explore the concept of anonymous consumers in API7 Gateway, allowing non-authenticated access to APIs while maintaining security. - [Anonymous Consumers](https://docs.api7.ai/api7-gateway/enterprise-features/anonymous-consumers.md): Explore the concept of anonymous consumers in API7 Gateway, allowing non-authenticated access to APIs while maintaining security. #### api-portal Explore the concept of the API portal in API7 Gateway, providing a centralized space for developers to access and manage APIs. - [API Portal](https://docs.api7.ai/api7-gateway/enterprise-features/api-portal.md): Explore the concept of the API portal in API7 Gateway, providing a centralized space for developers to access and manage APIs. #### audit-logging Explore audit logging in API7 Gateway, including how user actions and configuration changes are recorded. - [Audit Logging](https://docs.api7.ai/api7-gateway/enterprise-features/audit-logging.md): Explore audit logging in API7 Gateway, including how user actions and configuration changes are recorded. #### compliance Explore the concept of compliance in API7 Gateway, helping organizations meet regulatory requirements and maintain security standards. - [Compliance](https://docs.api7.ai/api7-gateway/enterprise-features/compliance.md): Explore the concept of compliance in API7 Gateway, helping organizations meet regulatory requirements and maintain security standards. #### credentials Explore the concept of credentials in API7 Gateway, authenticating users and ensuring secure access while facilitating management and rotation. - [Credentials](https://docs.api7.ai/api7-gateway/enterprise-features/credentials.md): Explore the concept of credentials in API7 Gateway, authenticating users and ensuring secure access while facilitating management and rotation. #### custom-plugins Explore the concept of custom plugins in API7 Gateway, enabling tailored extensions to meet specific business needs. - [Custom Plugins](https://docs.api7.ai/api7-gateway/enterprise-features/custom-plugins.md): Explore the concept of custom plugins in API7 Gateway, enabling tailored extensions to meet specific business needs. #### dashboard-sso Explore the concept of Single Sign-On (SSO) in API7 Gateway, allowing users to authenticate with existing credentials for easy access. - [Dashboard SSO Options](https://docs.api7.ai/api7-gateway/enterprise-features/dashboard-sso.md): Explore the concept of Single Sign-On (SSO) in API7 Gateway, allowing users to authenticate with existing credentials for easy access. #### gateway-groups Explore the concept of gateway groups in API7 Gateway, which manage multiple API gateway instances with shared configurations. - [Gateway Groups](https://docs.api7.ai/api7-gateway/enterprise-features/gateway-groups.md): Explore the concept of gateway groups in API7 Gateway, which manage multiple API gateway instances with shared configurations. #### high-availability Explore the concept of high availability in API7 Gateway, ensuring continuous service delivery for mission-critical applications. - [High Availability](https://docs.api7.ai/api7-gateway/enterprise-features/high-availability.md): Explore the concept of high availability in API7 Gateway, ensuring continuous service delivery for mission-critical applications. #### organization-and-rbac Explore the concept of organization management and RBAC in API7 Gateway, enabling fine-grained permission management. - [Organization and RBAC](https://docs.api7.ai/api7-gateway/enterprise-features/organization-and-rbac.md): Explore the concept of organization management and RBAC in API7 Gateway, enabling fine-grained permission management. #### overview Discover the enterprise-grade features that distinguish API7 Gateway from open-source Apache APISIX, including centralized management, RBAC, audit logging, and professional support. - [Enterprise Features Overview](https://docs.api7.ai/api7-gateway/enterprise-features/overview.md): Discover the enterprise-grade features that distinguish API7 Gateway from open-source Apache APISIX, including centralized management, RBAC, audit logging, and professional support. #### permission-policies-and-boundaries Explore the concept of permission policies and boundaries in API7 Gateway, defining user access levels for enhanced security. - [Permission Policies and Boundaries](https://docs.api7.ai/api7-gateway/enterprise-features/permission-policies-and-boundaries.md): Explore the concept of permission policies and boundaries in API7 Gateway, defining user access levels for enhanced security. #### secret-providers Explore the concept of secret providers in API7 Gateway, which enhance security by storing sensitive data using third-party tools. - [Secret Providers](https://docs.api7.ai/api7-gateway/enterprise-features/secret-providers.md): Explore the concept of secret providers in API7 Gateway, which enhance security by storing sensitive data using third-party tools. #### security-hardening Explore the concept of security hardening in API7 Gateway, designed to protect API infrastructure against threats and vulnerabilities. - [Security Hardening](https://docs.api7.ai/api7-gateway/enterprise-features/security-hardening.md): Explore the concept of security hardening in API7 Gateway, designed to protect API infrastructure against threats and vulnerabilities. ### getting-started #### learn-more Understand the API7 product family, the relationship between API7 Enterprise and Apache APISIX, and how they fit into your API management strategy. - [Learn More About API7 Products and APISIX](https://docs.api7.ai/api7-gateway/getting-started/learn-more.md): Understand the API7 product family, the relationship between API7 Enterprise and Apache APISIX, and how they fit into your API management strategy. #### management-options Compare the API7 Gateway Dashboard, Admin API, ADC, a7 CLI, and API7-MCP for interactive operations, automation, GitOps, and AI clients. - [Management Options](https://docs.api7.ai/api7-gateway/getting-started/management-options.md): Compare the API7 Gateway Dashboard, Admin API, ADC, a7 CLI, and API7-MCP for interactive operations, automation, GitOps, and AI clients. #### overview Get started with API7 Gateway. Understand the platform components, how they work together, and choose the right path for your use case. - [API7 Gateway Overview](https://docs.api7.ai/api7-gateway/getting-started/overview.md): Get started with API7 Gateway. Understand the platform components, how they work together, and choose the right path for your use case. #### quick-start Get API7 Gateway running locally with Docker Compose and proxy your first API request in under 10 minutes. - [Quick Start](https://docs.api7.ai/api7-gateway/getting-started/quick-start.md): Get API7 Gateway running locally with Docker Compose and proxy your first API request in under 10 minutes. #### tutorial-proxying-api-requests A hands-on tutorial that walks you through proxying API requests, adding authentication with Key Auth, and enabling rate limiting with the Limit Count plugin. - [Tutorial: Proxying and Managing API Requests via Plugins](https://docs.api7.ai/api7-gateway/getting-started/tutorial-proxying-api-requests.md): A hands-on tutorial that walks you through proxying API requests, adding authentication with Key Auth, and enabling rate limiting with the Limit Count plugin. ### how-to-guides #### api-security - [Configure Basic Authentication](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/basic-auth.md): Learn how to secure your APIs by requiring clients to provide a standard username and password in the HTTP Authorization header. - [Configure Data Masking](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/data-masking.md): Use the data-mask plugin to redact, replace, or remove sensitive fields from request data before it is written to access logs and logger plugin output, helping you meet GDPR, HIPAA, and PCI-DSS requirements. - [Forward External Auth User Info to Upstream](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/forward-auth-user-info.md): Forward authenticated user information from OpenID Connect or SAML routes to upstream services as request headers or the consumer name. - [Configure HMAC Authentication](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/hmac-auth.md): Learn how to secure your APIs with Hash-based Message Authentication Code (HMAC) for request signing in API7 Enterprise. - [Configure JWT Authentication](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/jwt-auth.md): Learn how to secure your APIs using JSON Web Tokens (JWT) for stateless authentication in API7 Enterprise. - [Configure Key Authentication](https://docs.api7.ai/api7-gateway/how-to-guides/api-security/key-auth.md): Learn how to secure your APIs by requiring clients to provide a unique API key in the request header or query string. #### ops - [Configure Readiness and Liveness Probes](https://docs.api7.ai/api7-gateway/how-to-guides/ops/configure-readiness-probe.md): Configure readiness and liveness checks for API7 Gateway data planes in Kubernetes, Docker, and other non-Helm deployments. - [Create a Custom Role](https://docs.api7.ai/api7-gateway/how-to-guides/ops/create-custom-role.md): Create a custom role in API7 Gateway by defining permission policies, attaching them to a role, and assigning the role to a user. - [Design a Custom Role System](https://docs.api7.ai/api7-gateway/how-to-guides/ops/design-custom-role-system.md): Design a scalable custom role system in API7 Gateway by combining roles, permission policies, labels, and permission boundaries. - [Manage Gateway Groups](https://docs.api7.ai/api7-gateway/how-to-guides/ops/multi-gateway-group.md): Learn how to create and manage multiple gateway groups to organize and isolate API traffic across environments or teams. - [Configure Secret Management](https://docs.api7.ai/api7-gateway/how-to-guides/ops/secret-manager.md): Learn how to configure secret providers and reference external secrets in API7 Enterprise without hardcoding sensitive values in gateway resources. #### overview Practical how-to guides for common API7 Gateway tasks and workflows. - [How-To Guides](https://docs.api7.ai/api7-gateway/how-to-guides/overview.md): Practical how-to guides for common API7 Gateway tasks and workflows. #### plugin-development - [Plugin Development Best Practices](https://docs.api7.ai/api7-gateway/how-to-guides/plugin-development/best-practices.md): Write custom Lua plugins that are correct, fast, and maintainable by using the built-in core library instead of low-level OpenResty APIs, validating configuration with a schema, and choosing the right phase and priority. - [Develop Custom Lua Plugins](https://docs.api7.ai/api7-gateway/how-to-guides/plugin-development/custom-lua-plugins.md): Learn how to develop, register, and test custom Lua plugins for API7 Gateway. - [Serverless Functions or Custom Plugins](https://docs.api7.ai/api7-gateway/how-to-guides/plugin-development/serverless-or-custom-plugins.md): Compare the built-in serverless-function plugins with custom Lua plugins, and choose the right way to run your own Lua logic in API7 Gateway. #### protocol-proxy - [Configure GraphQL Proxying](https://docs.api7.ai/api7-gateway/how-to-guides/protocol-proxy/graphql-proxy.md): Learn how to proxy GraphQL APIs through API7 Gateway and when to add GraphQL-aware plugins for rate limiting and caching. - [Configure gRPC Proxying](https://docs.api7.ai/api7-gateway/how-to-guides/protocol-proxy/grpc-proxy.md): Learn how to configure API7 Enterprise to proxy gRPC traffic, including REST-to-gRPC transcoding and gRPC-Web support for browser clients. - [Configure TCP/UDP Proxying](https://docs.api7.ai/api7-gateway/how-to-guides/protocol-proxy/tcp-udp-proxy.md): Configure API7 Gateway to proxy TCP and UDP (Layer 4) traffic to upstream services such as databases, message queues, and custom protocols. - [Configure WebSocket Proxying](https://docs.api7.ai/api7-gateway/how-to-guides/protocol-proxy/websocket-proxy.md): Learn how to enable and configure WebSocket proxying for your routes in API7 Enterprise to handle long-lived, bidirectional connections. #### traffic-management - [Implement Blue-Green Deployment](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/blue-green-deployment.md): Implement blue-green deployments using API7 Gateway to switch traffic between two upstream environments with zero downtime. - [Implement Canary Release](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/canary-release.md): Learn how to gradually shift traffic to a new version of your backend service using the traffic-split plugin. - [Configure CORS](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/cors.md): Learn how to configure Cross-Origin Resource Sharing (CORS) for your APIs to allow or restrict access from different domains. - [Configure Fault Injection](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/fault-injection.md): Learn how to test the resilience of your application by injecting HTTP errors and response delays. - [Conditionally Disable Global Plugins](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/global-plugin-exemption.md): Conditionally skip global plugin execution for specific routes using route labels and the _meta.filter mechanism. - [Configure Upstream Health Checks](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/health-check.md): Learn how to configure active and passive health checks for upstream services to ensure high availability. - [Configure Proxy Cache](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/proxy-cache.md): Learn how to improve API performance and reduce upstream load by caching responses at the Gateway. - [Configure Proxy Mirror](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/proxy-mirror.md): Learn how to duplicate and send a percentage of real production traffic to a secondary service for testing and verification. - [Rewrite Proxy Requests](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/proxy-rewrite.md): Learn how to modify request URIs, methods, and headers before proxying them to upstream services. - [Configure Rate Limiting](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/rate-limiting.md): Learn how to configure simple and advanced rate limiting for your APIs to prevent abuse and ensure fair usage. - [Improve Rate Limiting Accuracy Across Gateway Instances](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/rate-limiting-accuracy.md): Understand where rate limiting error comes from when counter synchronization is batched across gateway instances, and why sliding windows keep the long-term error near zero. - [Configure Response Rewrite](https://docs.api7.ai/api7-gateway/how-to-guides/traffic-management/response-rewrite.md): Learn how to modify response status codes, headers, and body content before they are returned to the client. ### install #### deploy-high-availability Deploy API7 Gateway control plane and data plane in a high-availability configuration to eliminate single points of failure. - [Deploy for High Availability](https://docs.api7.ai/api7-gateway/install/deploy-high-availability.md): Deploy API7 Gateway control plane and data plane in a high-availability configuration to eliminate single points of failure. #### deploy-on-kubernetes Deploy API7 Enterprise on Kubernetes using Helm, including control plane setup, data plane configuration with mTLS, and cloud-specific guidance for AWS EKS, GCP GKE, and Azure AKS. - [Deploy on Kubernetes](https://docs.api7.ai/api7-gateway/install/deploy-on-kubernetes.md): Deploy API7 Enterprise on Kubernetes using Helm, including control plane setup, data plane configuration with mTLS, and cloud-specific guidance for AWS EKS, GCP GKE, and Azure AKS. #### deploy-on-openshift Deploy API7 Gateway on Red Hat OpenShift with proper Security Context Constraints (SCCs), service accounts, and Helm chart configuration. - [Deploy on OpenShift](https://docs.api7.ai/api7-gateway/install/deploy-on-openshift.md): Deploy API7 Gateway on Red Hat OpenShift with proper Security Context Constraints (SCCs), service accounts, and Helm chart configuration. #### deploy-with-docker-compose Install a complete API7 Gateway stack with Docker Compose using an online quickstart script, an offline bundle, or a customizable manual deployment. - [Deploy with Docker Compose](https://docs.api7.ai/api7-gateway/install/deploy-with-docker-compose.md): Install a complete API7 Gateway stack with Docker Compose using an online quickstart script, an offline bundle, or a customizable manual deployment. #### deploy-with-rpm Deploy API7 Enterprise on Red Hat-family systems (RHEL, Rocky Linux, AlmaLinux, and CentOS 8 and 9) from the offline RPM bundle, fully air-gapped and managed by systemd. - [Deploy with the Offline RPM Bundle](https://docs.api7.ai/api7-gateway/install/deploy-with-rpm.md): Deploy API7 Enterprise on Red Hat-family systems (RHEL, Rocky Linux, AlmaLinux, and CentOS 8 and 9) from the offline RPM bundle, fully air-gapped and managed by systemd. #### installation-faq Frequently asked questions and troubleshooting common installation issues. - [Installation FAQ](https://docs.api7.ai/api7-gateway/install/installation-faq.md): Frequently asked questions and troubleshooting common installation issues. #### installation-packages Container images, Helm charts, and CLI tools used to install API7 Enterprise — including the official Docker Hub repositories for the gateway, DP manager, Developer Portal, and integrated control plane images. - [Installation Packages](https://docs.api7.ai/api7-gateway/install/installation-packages.md): Container images, Helm charts, and CLI tools used to install API7 Enterprise — including the official Docker Hub repositories for the gateway, DP manager, Developer Portal, and integrated control plane images. #### overview Compare Kubernetes, Docker Compose, and package-based deployment options for API7 Gateway across production, evaluation, and air-gapped environments. - [Install API7 Gateway On-Premises](https://docs.api7.ai/api7-gateway/install/overview.md): Compare Kubernetes, Docker Compose, and package-based deployment options for API7 Gateway across production, evaluation, and air-gapped environments. #### production-deployment-checklist Validate CPU sizing, high availability, health checks, configuration management, security, and operations before running API7 Gateway in production on Kubernetes or Docker Compose. - [Production Deployment Checklist](https://docs.api7.ai/api7-gateway/install/production-deployment-checklist.md): Validate CPU sizing, high availability, health checks, configuration management, security, and operations before running API7 Gateway in production on Kubernetes or Docker Compose. #### rpm-from-docker When the Dashboard does not yet generate an RPM data-plane script, extract the connection parameters from the Docker script to onboard an api7-gateway RPM. - [Deploy an RPM Data Plane from a Docker Script](https://docs.api7.ai/api7-gateway/install/rpm-from-docker.md): When the Dashboard does not yet generate an RPM data-plane script, extract the connection parameters from the Docker script to onboard an api7-gateway RPM. #### rpm-quickstart Bring up an API7 Enterprise control plane on a single host in minutes with the bundled quickstart.sh for evaluation and PoC. - [Single-Host RPM Evaluation Quickstart](https://docs.api7.ai/api7-gateway/install/rpm-quickstart.md): Bring up an API7 Enterprise control plane on a single host in minutes with the bundled quickstart.sh for evaluation and PoC. #### supported-versions-and-interoperability Version compatibility matrix for API7 Enterprise components and infrastructure. - [Supported Versions and Interoperability](https://docs.api7.ai/api7-gateway/install/supported-versions-and-interoperability.md): Version compatibility matrix for API7 Enterprise components and infrastructure. #### system-requirements Hardware, operating system, and network requirements for installing API7 Gateway. - [System Requirements](https://docs.api7.ai/api7-gateway/install/system-requirements.md): Hardware, operating system, and network requirements for installing API7 Gateway. ### key-concepts #### architecture Deep dive into the decoupled control plane and data plane architecture of API7 Enterprise. - [Architecture](https://docs.api7.ai/api7-gateway/key-concepts/architecture.md): Deep dive into the decoupled control plane and data plane architecture of API7 Enterprise. #### consumers-and-credentials Identity management and authentication using Consumers and Credentials. - [Consumers and Credentials](https://docs.api7.ai/api7-gateway/key-concepts/consumers-and-credentials.md): Identity management and authentication using Consumers and Credentials. #### gateway-groups Logical grouping of data plane instances for environment isolation and configuration management. - [Gateway Groups](https://docs.api7.ai/api7-gateway/key-concepts/gateway-groups.md): Logical grouping of data plane instances for environment isolation and configuration management. #### overview Introduction to the core abstractions and entities in API7 Enterprise. - [Key Concepts Overview](https://docs.api7.ai/api7-gateway/key-concepts/overview.md): Introduction to the core abstractions and entities in API7 Enterprise. #### plugins Modular components to intercept and modify API traffic in API7 Gateway. - [Plugins](https://docs.api7.ai/api7-gateway/key-concepts/plugins.md): Modular components to intercept and modify API traffic in API7 Gateway. #### service-discovery Dynamic upstream resolution in API7 Gateway — automatically discover backend endpoints from Kubernetes Services, Nacos, and Consul registries without hardcoding IPs. - [Service Discovery](https://docs.api7.ai/api7-gateway/key-concepts/service-discovery.md): Dynamic upstream resolution in API7 Gateway — automatically discover backend endpoints from Kubernetes Services, Nacos, and Consul registries without hardcoding IPs. #### services-and-routes Understand how to group and route API traffic using Services and Routes. - [Services and Routes](https://docs.api7.ai/api7-gateway/key-concepts/services-and-routes.md): Understand how to group and route API traffic using Services and Routes. #### ssl-certificates Understanding how API7 Gateway manages SSL/TLS certificates and terminates secure connections. - [SSL Certificates](https://docs.api7.ai/api7-gateway/key-concepts/ssl-certificates.md): Understanding how API7 Gateway manages SSL/TLS certificates and terminates secure connections. #### stream-routes Understand stream routes in API7 Gateway for proxying TCP and UDP (Layer 4) traffic, including matching rules, supported plugins, and the relationship with stream services. - [Stream Routes](https://docs.api7.ai/api7-gateway/key-concepts/stream-routes.md): Understand stream routes in API7 Gateway for proxying TCP and UDP (Layer 4) traffic, including matching rules, supported plugins, and the relationship with stream services. #### upstreams-and-load-balancing Definitions of backend targets, including load balancing algorithms and health checks. - [Upstreams and Load Balancing](https://docs.api7.ai/api7-gateway/key-concepts/upstreams-and-load-balancing.md): Definitions of backend targets, including load balancing algorithms and health checks. ### observability #### alerts Configure alert policies and contact points in API7 Gateway to get notified by email or webhook when gateway instances go offline, certificates expire, or error rates breach a threshold. - [Configure Alerts](https://docs.api7.ai/api7-gateway/observability/alerts.md): Configure alert policies and contact points in API7 Gateway to get notified by email or webhook when gateway instances go offline, certificates expire, or error rates breach a threshold. #### consumer-label-based-logging Include consumer labels in API7 Gateway access logs for per-consumer traffic tracking and analysis. - [Include Consumer Labels in Access Logs](https://docs.api7.ai/api7-gateway/observability/consumer-label-based-logging.md): Include consumer labels in API7 Gateway access logs for per-consumer traffic tracking and analysis. #### debug-sessions Find out exactly what the gateway did to a single request — which plugins ran, in what order, which one was slow, and what it logged. Capture on demand, or automatically when an alert fires. - [Capture Request Traces with Debug Sessions](https://docs.api7.ai/api7-gateway/observability/debug-sessions.md): Find out exactly what the gateway did to a single request — which plugins ran, in what order, which one was slow, and what it logged. Capture on demand, or automatically when an alert fires. #### external-prometheus Configure API7 Gateway to use an external Prometheus in Docker Compose, remove the bundled instance, and route Dashboard Monitoring queries to the replacement. - [Use an Existing Prometheus](https://docs.api7.ai/api7-gateway/observability/external-prometheus.md): Configure API7 Gateway to use an external Prometheus in Docker Compose, remove the bundled instance, and route Dashboard Monitoring queries to the replacement. #### kubernetes-error-log-forwarding Forward API7 Gateway error logs from Kubernetes to Splunk by using the Splunk OpenTelemetry Collector. - [Send Kubernetes Error Logs to Splunk](https://docs.api7.ai/api7-gateway/observability/kubernetes-error-log-forwarding.md): Forward API7 Gateway error logs from Kubernetes to Splunk by using the Splunk OpenTelemetry Collector. #### kubernetes-log-collection Collect API7 Gateway access and error logs on Kubernetes with the OpenTelemetry Collector or Filebeat, either from container output or from log files written inside the pod. - [Collect Gateway Logs on Kubernetes](https://docs.api7.ai/api7-gateway/observability/kubernetes-log-collection.md): Collect API7 Gateway access and error logs on Kubernetes with the OpenTelemetry Collector or Filebeat, either from container output or from log files written inside the pod. #### logging Understand the access and error logs that API7 Gateway produces, how to configure their format and verbosity, and how to forward them to a centralized log management system. - [Configure Centralized Logging](https://docs.api7.ai/api7-gateway/observability/logging.md): Understand the access and error logs that API7 Gateway produces, how to configure their format and verbosity, and how to forward them to a centralized log management system. #### metrics Monitor API7 Gateway metrics in the Dashboard, inspect the data-plane metrics endpoint, or send metrics to Prometheus through remote write. - [Monitor Metrics](https://docs.api7.ai/api7-gateway/observability/metrics.md): Monitor API7 Gateway metrics in the Dashboard, inspect the data-plane metrics endpoint, or send metrics to Prometheus through remote write. #### metrics-reference Look up the core Prometheus metric families and built-in labels exported by API7 Gateway data planes. - [Data Plane Metrics Reference](https://docs.api7.ai/api7-gateway/observability/metrics-reference.md): Look up the core Prometheus metric families and built-in labels exported by API7 Gateway data planes. #### splunk-integration Send API7 Gateway access logs to Splunk using the HTTP Event Collector (HEC) logging plugin. - [Send Access Logs to Splunk](https://docs.api7.ai/api7-gateway/observability/splunk-integration.md): Send API7 Gateway access logs to Splunk using the HTTP Event Collector (HEC) logging plugin. #### tracing Configure API7 Gateway distributed tracing with OpenTelemetry, export sampled spans to an OTLP/HTTP endpoint, and correlate trace IDs with access logs. - [Configure Distributed Tracing](https://docs.api7.ai/api7-gateway/observability/tracing.md): Configure API7 Gateway distributed tracing with OpenTelemetry, export sampled spans to an OTLP/HTTP endpoint, and correlate trace IDs with access logs. ### overview Discover API7 Gateway, a dynamic, high-performance API gateway for cloud-native environments, built on Apache APISIX. Learn about its architecture, features, and deployment models. - [API7 Gateway](https://docs.api7.ai/api7-gateway/overview.md): Discover API7 Gateway, a dynamic, high-performance API gateway for cloud-native environments, built on Apache APISIX. Learn about its architecture, features, and deployment models. ### release-notes Review the latest updates, features, improvements, and bug fixes for each version of API7 Gateway in release notes. - [API7 Gateway Release Notes](https://docs.api7.ai/api7-gateway/release-notes.md): Review the latest updates, features, improvements, and bug fixes for each version of API7 Gateway in release notes. ### scalability #### autoscale-on-kubernetes Autoscale API7 Gateway data plane pods on Kubernetes with a Horizontal Pod Autoscaler (HPA) to handle changing traffic automatically. - [Autoscale Data Plane on Kubernetes](https://docs.api7.ai/api7-gateway/scalability/autoscale-on-kubernetes.md): Autoscale API7 Gateway data plane pods on Kubernetes with a Horizontal Pod Autoscaler (HPA) to handle changing traffic automatically. ### security-and-compliance #### access-control-lists Restrict API access using the consumer-restriction plugin in API7 Gateway with consumer, service, or route allow and deny lists. - [Access Control Lists](https://docs.api7.ai/api7-gateway/security-and-compliance/access-control-lists.md): Restrict API access using the consumer-restriction plugin in API7 Gateway with consumer, service, or route allow and deny lists. #### audit-logs Track all administrative changes in the API7 Control Plane with detailed audit logs. Learn how to review, manage, and export audit trails for security and compliance. - [Audit Logs](https://docs.api7.ai/api7-gateway/security-and-compliance/audit-logs.md): Track all administrative changes in the API7 Control Plane with detailed audit logs. Learn how to review, manage, and export audit trails for security and compliance. #### authenticate - [Client mTLS Authentication](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/client-mtls.md): Configure mutual TLS (mTLS) on API7 Gateway to authenticate API clients with X.509 certificates before allowing access to your APIs. - [Mutual TLS between Control Plane and Data Plane](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/mutual-tls-cp-dp.md): Learn how API7 Gateway uses a robust, PKI-based mutual TLS (mTLS) model to secure all communication between the Control Plane and Data Plane. - [SCIM Provisioning for Dashboard](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/scim.md): Configure SCIM provisioning for API7 Gateway Dashboard with supported identity providers. - [SCIM Provisioning with Microsoft Entra ID](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/scim-microsoft-entra-id.md): Configure SCIM provisioning with Microsoft Entra ID for API7 Gateway Dashboard. - [SCIM Provisioning with Okta](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/scim-okta.md): Configure SCIM provisioning with Okta for API7 Gateway Dashboard. - [Upstream mTLS](https://docs.api7.ai/api7-gateway/security-and-compliance/authenticate/upstream-mtls.md): Configure mutual TLS between API7 Gateway and upstream services by creating certificate objects and referencing them from an HTTPS upstream. #### ip-restrictions-control-plane Restrict which client IP addresses can reach the API7 Control Plane (Dashboard and Admin API) using the Control Plane's built-in IP allow list, with complementary network-level controls for defence in depth. - [IP Restrictions for Control Plane](https://docs.api7.ai/api7-gateway/security-and-compliance/ip-restrictions-control-plane.md): Restrict which client IP addresses can reach the API7 Control Plane (Dashboard and Admin API) using the Control Plane's built-in IP allow list, with complementary network-level controls for defence in depth. #### oauth-oidc Secure your APIs with modern token-based authentication. Learn how to integrate API7 Gateway with OAuth 2.0 and OpenID Connect (OIDC) providers like Okta and Keycloak. - [OAuth 2.0 and OIDC](https://docs.api7.ai/api7-gateway/security-and-compliance/oauth-oidc.md): Secure your APIs with modern token-based authentication. Learn how to integrate API7 Gateway with OAuth 2.0 and OpenID Connect (OIDC) providers like Okta and Keycloak. #### open-source-licenses API7 Gateway's commitment to open-source software and license compliance. Review the major open-source components used and their respective licenses. - [Open Source Licenses](https://docs.api7.ai/api7-gateway/security-and-compliance/open-source-licenses.md): API7 Gateway's commitment to open-source software and license compliance. Review the major open-source components used and their respective licenses. #### overview Learn how API7 Gateway provides comprehensive security and compliance features to protect your APIs, including authentication, authorization, encryption, and auditing capabilities. - [Security and Compliance Overview](https://docs.api7.ai/api7-gateway/security-and-compliance/overview.md): Learn how API7 Gateway provides comprehensive security and compliance features to protect your APIs, including authentication, authorization, encryption, and auditing capabilities. #### permission-policies-and-boundaries Author permission policies in API7 Gateway using the native JSON document format. Learn the statement structure, allowed actions, ARN-style resources, label-based conditions, and how permission boundaries enforce maximum allowable permissions. - [Permission Policies and Boundaries](https://docs.api7.ai/api7-gateway/security-and-compliance/permission-policies-and-boundaries.md): Author permission policies in API7 Gateway using the native JSON document format. Learn the statement structure, allowed actions, ARN-style resources, label-based conditions, and how permission boundaries enforce maximum allowable permissions. #### role-based-access-control Manage user access to the API7 Gateway control plane with Role-Based Access Control. Assign users to roles, attach permission policies, and enforce least-privilege access across gateway groups. - [Role-Based Access Control (RBAC)](https://docs.api7.ai/api7-gateway/security-and-compliance/role-based-access-control.md): Manage user access to the API7 Gateway control plane with Role-Based Access Control. Assign users to roles, attach permission policies, and enforce least-privilege access across gateway groups. #### secure-credentials Protect your sensitive information with API7 Gateway's secure credentials management. Learn how to manage SSL certificates and integrate with external secret managers like HashiCorp Vault. - [Secure Credentials Management](https://docs.api7.ai/api7-gateway/security-and-compliance/secure-credentials.md): Protect your sensitive information with API7 Gateway's secure credentials management. Learn how to manage SSL certificates and integrate with external secret managers like HashiCorp Vault. #### sso-dashboard Centralize user access to the API7 Dashboard using Single Sign-On (SSO). Supports OIDC, SAML, LDAP, and CAS protocols with automatic role mapping. - [SSO for Dashboard](https://docs.api7.ai/api7-gateway/security-and-compliance/sso-dashboard.md): Centralize user access to the API7 Dashboard using Single Sign-On (SSO). Supports OIDC, SAML, LDAP, and CAS protocols with automatic role mapping. #### sso-ldap Configure Single Sign-On (SSO) for the API7 Dashboard using LDAP, allowing users to authenticate with their existing directory service credentials. - [SSO with LDAP](https://docs.api7.ai/api7-gateway/security-and-compliance/sso-ldap.md): Configure Single Sign-On (SSO) for the API7 Dashboard using LDAP, allowing users to authenticate with their existing directory service credentials. #### sso-oidc Configure Single Sign-On (SSO) for the API7 Dashboard using OpenID Connect (OIDC), with provider-specific guidance for Keycloak, Microsoft Entra ID, and Auth0. - [SSO with OIDC](https://docs.api7.ai/api7-gateway/security-and-compliance/sso-oidc.md): Configure Single Sign-On (SSO) for the API7 Dashboard using OpenID Connect (OIDC), with provider-specific guidance for Keycloak, Microsoft Entra ID, and Auth0. #### sso-saml Configure Single Sign-On (SSO) for the API7 Dashboard using SAML 2.0, with provider-specific guidance for Microsoft Entra ID and Okta. - [SSO with SAML](https://docs.api7.ai/api7-gateway/security-and-compliance/sso-saml.md): Configure Single Sign-On (SSO) for the API7 Dashboard using SAML 2.0, with provider-specific guidance for Microsoft Entra ID and Okta. #### trust-center The API7 Trust Center is your centralized resource for all security and compliance-related information, including certifications, security reports, and best practice guides. - [Trust Center](https://docs.api7.ai/api7-gateway/security-and-compliance/trust-center.md): The API7 Trust Center is your centralized resource for all security and compliance-related information, including certifications, security reports, and best practice guides. #### verify-image-signatures Verify API7 Enterprise container image signatures with Cosign and keyless OIDC-based verification. Protect your supply chain by confirming every image was built and signed by API7.ai. - [Verify Image Signatures](https://docs.api7.ai/api7-gateway/security-and-compliance/verify-image-signatures.md): Verify API7 Enterprise container image signatures with Cosign and keyless OIDC-based verification. Protect your supply chain by confirming every image was built and signed by API7.ai. #### vulnerability-scanning Learn about API7.ai's security testing and vulnerability scanning practices for API7 Gateway, including our CVE reporting and patching processes. - [Vulnerability Scanning](https://docs.api7.ai/api7-gateway/security-and-compliance/vulnerability-scanning.md): Learn about API7.ai's security testing and vulnerability scanning practices for API7 Gateway, including our CVE reporting and patching processes. #### web-application-firewall Learn when to use a Web Application Firewall with API7 Gateway, how it fits into your security model, and where to find the current documented integration path. - [Web Application Firewall (WAF)](https://docs.api7.ai/api7-gateway/security-and-compliance/web-application-firewall.md): Learn when to use a Web Application Firewall with API7 Gateway, how it fits into your security model, and where to find the current documented integration path. ### troubleshooting Diagnose and resolve common issues with API7 Gateway deployments, including connectivity problems, configuration errors, and performance degradation. - [Troubleshoot API7 Gateway](https://docs.api7.ai/api7-gateway/troubleshooting.md): Diagnose and resolve common issues with API7 Gateway deployments, including connectivity problems, configuration errors, and performance degradation. ### upgrade-guides #### backup-and-restore Back up and restore API7 Gateway CP data and gateway-group configuration with database-native tools and ADC. - [Backup and Restoration](https://docs.api7.ai/api7-gateway/upgrade-guides/backup-and-restore.md): Back up and restore API7 Gateway CP data and gateway-group configuration with database-native tools and ADC. #### cluster-migration Move API7 Gateway to a new cluster at the same product version with independent databases, staged traffic shifting, and a recoverable rollback plan. - [Migrate API7 Gateway to a New Cluster](https://docs.api7.ai/api7-gateway/upgrade-guides/cluster-migration.md): Move API7 Gateway to a new cluster at the same product version with independent databases, staged traffic shifting, and a recoverable rollback plan. #### dual-cluster Upgrade API7 Gateway with independent source and target clusters, controlled traffic shifting, write reconciliation, validation, and conditional rollback. - [Dual-Cluster Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/dual-cluster.md): Upgrade API7 Gateway with independent source and target clusters, controlled traffic shifting, write reconciliation, validation, and conditional rollback. #### in-place Upgrade the API7 Gateway Control Plane against its existing database with a write freeze, source shutdown, target validation, and recoverable rollback. - [Control Plane In-Place Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/in-place.md): Upgrade the API7 Gateway Control Plane against its existing database with a write freeze, source shutdown, target validation, and recoverable rollback. #### lts-upgrades Choose the supported API7 Gateway route and exact version anchors for upgrading from a predecessor LTS release to this LTS release. - [Choose an LTS Upgrade Path](https://docs.api7.ai/api7-gateway/upgrade-guides/lts-upgrades.md): Choose the supported API7 Gateway route and exact version anchors for upgrading from a predecessor LTS release to this LTS release. #### rolling-upgrade Replace API7 Gateway Data Plane nodes gradually with capacity planning, canary validation, add-before-drain rollout, traffic checks, and rollback. - [Data Plane Rolling Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/rolling-upgrade.md): Replace API7 Gateway Data Plane nodes gradually with capacity planning, canary validation, add-before-drain rollout, traffic checks, and rollback. #### upgrade Plan an API7 Gateway upgrade by confirming the supported version path, selecting deployment strategies, preparing backups, and rehearsing rollback. - [Plan an API7 Gateway Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/upgrade.md): Plan an API7 Gateway upgrade by confirming the supported version path, selecting deployment strategies, preparing backups, and rehearsing rollback. #### upgrade-3.8-to-3.10 Upgrade API7 Gateway from 3.8.23 to 3.10.8 on Helm and Kubernetes with external PostgreSQL, validation, and backup-based rollback. - [Upgrade from 3.8 LTS to 3.10 LTS](https://docs.api7.ai/api7-gateway/upgrade-guides/upgrade-3.8-to-3.10.md): Upgrade API7 Gateway from 3.8.23 to 3.10.8 on Helm and Kubernetes with external PostgreSQL, validation, and backup-based rollback. #### upgrade-3.9-to-3.10 Upgrade API7 Gateway directly from 3.9.21 to 3.10.8 on Helm and Kubernetes with external PostgreSQL 15.x, validation, and rollback. - [Upgrade from 3.9 LTS to 3.10 LTS](https://docs.api7.ai/api7-gateway/upgrade-guides/upgrade-3.9-to-3.10.md): Upgrade API7 Gateway directly from 3.9.21 to 3.10.8 on Helm and Kubernetes with external PostgreSQL 15.x, validation, and rollback. ### version-support-policy API7 Enterprise version support lifecycle, LTS policy, and upgrade guidance. Learn how long each release is supported and which versions are currently designated as LTS. - [Version Support Policy](https://docs.api7.ai/api7-gateway/version-support-policy.md): API7 Enterprise version support lifecycle, LTS policy, and upgrade guidance. Learn how long each release is supported and which versions are currently designated as LTS. ## apisix ### reference #### admin-api The Apache APISIX Admin API is a RESTful interface for managing all APISIX gateway resources — routes, upstreams, services, consumers, SSL certificates, plugins, and more. APISIX Admin API allows... - [Apache APISIX Admin API](https://docs.api7.ai/apisix/reference/admin-api.md): The Apache APISIX Admin API is a RESTful interface for managing all APISIX gateway resources — routes, upstreams, services, consumers, SSL certificates, plugins, and more. APISIX Admin API allows... #### control-api Use the APISIX Control API to inspect or control the runtime state of one APISIX instance. It is enabled by default at http://127.0.0.1:9090; configure apisix.enable control and apisix.control in... - [APISIX Control API](https://docs.api7.ai/apisix/reference/control-api.md): Use the APISIX Control API to inspect or control the runtime state of one APISIX instance. It is enabled by default at http://127.0.0.1:9090; configure apisix.enable control and apisix.control in... #### a6-cli Understand how the separately installed a6 CLI manages Apache APISIX through the Admin API and how it differs from other management tools. - [a6 CLI](https://docs.api7.ai/apisix/reference/a6-cli.md): Understand how the separately installed a6 CLI manages Apache APISIX through the Admin API and how it differs from other management tools. #### adc Use API Declarative CLI (ADC) to manage Apache APISIX configuration declaratively. - [API Declarative CLI (ADC)](https://docs.api7.ai/apisix/reference/adc.md): Use API Declarative CLI (ADC) to manage Apache APISIX configuration declaratively. #### api-standalone-usage Learn about api-driven standalone mode usage in Apache APISIX, which stores gateway configurations entirely in memory rather than in a configuration file. - [API-Driven Standalone Mode Usage](https://docs.api7.ai/apisix/reference/api-standalone-usage.md): Learn about api-driven standalone mode usage in Apache APISIX, which stores gateway configurations entirely in memory rather than in a configuration file. #### apisix-cli Discover the APISIX Command Line Interface (CLI), a tool designed for easy management and control of APISIX instances. - [APISIX CLI](https://docs.api7.ai/apisix/reference/apisix-cli.md): Discover the APISIX Command Line Interface (CLI), a tool designed for easy management and control of APISIX instances. #### apisix-expressions Learn about APISIX expressions, which combine variables and operators for route matching, request filtering, and other functionalities. - [APISIX Expressions](https://docs.api7.ai/apisix/reference/apisix-expressions.md): Learn about APISIX expressions, which combine variables and operators for route matching, request filtering, and other functionalities. #### apisix-mcp Use APISIX-MCP to expose Apache APISIX resource operations and gateway test requests to MCP-compatible AI clients and agents. - [APISIX Model Context Protocol (APISIX-MCP)](https://docs.api7.ai/apisix/reference/apisix-mcp.md): Use APISIX-MCP to expose Apache APISIX resource operations and gateway test requests to MCP-compatible AI clients and agents. #### batch-processor Understand how APISIX batches logging and telemetry entries, limits pending work, and controls memory use when a destination slows down or becomes unavailable. - [Batch Processor](https://docs.api7.ai/apisix/reference/batch-processor.md): Understand how APISIX batches logging and telemetry entries, limits pending work, and controls memory use when a destination slows down or becomes unavailable. #### built-in-variables Discover built-in variables in Apache APISIX that provide access to request-specific information for plugin configurations and routing. - [Built-In Variables](https://docs.api7.ai/apisix/reference/built-in-variables.md): Discover built-in variables in Apache APISIX that provide access to request-specific information for plugin configurations and routing. #### configuration-files Understand the configuration files in Apache APISIX, detailing how to customize parameters for various environments. - [Configuration Files](https://docs.api7.ai/apisix/reference/configuration-files.md): Understand the configuration files in Apache APISIX, detailing how to customize parameters for various environments. #### environment-variables Explore environment variables in Apache APISIX, which enable configurable settings during deployments for enhanced flexibility. - [Environment Variables](https://docs.api7.ai/apisix/reference/environment-variables.md): Explore environment variables in Apache APISIX, which enable configurable settings during deployments for enhanced flexibility. #### file-standalone-configurations Learn about file-driven standalone configurations in Apache APISIX, which allow the gateway to load gateway configurations from a YAML or JSON file. - [File-Driven Standalone Mode Configurations](https://docs.api7.ai/apisix/reference/file-standalone-configurations.md): Learn about file-driven standalone configurations in Apache APISIX, which allow the gateway to load gateway configurations from a YAML or JSON file. #### helm-chart Learn where to find Apache APISIX Helm chart values and how Helm values are rendered into gateway configuration. - [Helm Chart](https://docs.api7.ai/apisix/reference/helm-chart.md): Learn where to find Apache APISIX Helm chart values and how Helm values are rendered into gateway configuration. #### plugin-common-configurations Explore common plugin configurations in Apache APISIX, which enable universal settings for all plugins via meta attributes. - [Plugin Common Configurations](https://docs.api7.ai/apisix/reference/plugin-common-configurations.md): Explore common plugin configurations in Apache APISIX, which enable universal settings for all plugins via meta attributes. #### router-options Understand router options in Apache APISIX, which detail how to adjust routing behaviors for API request handling. - [Router Options](https://docs.api7.ai/apisix/reference/router-options.md): Understand router options in Apache APISIX, which detail how to adjust routing behaviors for API request handling. ### documentation Explore the comprehensive Apache APISIX documentation, covering setup, guides, plugins, and key concepts for effective API management and gateway functionality. - [Apache APISIX Documentation](https://docs.api7.ai/apisix/documentation.md): Explore the comprehensive Apache APISIX documentation, covering setup, guides, plugins, and key concepts for effective API management and gateway functionality. ### getting-started Learn how to quickly install and set up Apache APISIX, a dynamic and high-performance API gateway, to streamline your API lifecycle management. - [Get APISIX](https://docs.api7.ai/apisix/getting-started.md): Learn how to quickly install and set up Apache APISIX, a dynamic and high-performance API gateway, to streamline your API lifecycle management. #### configure-routes Learn how to define routes in Apache APISIX to manage traffic, match client requests, and forward them to upstream services effectively. - [Configure Routes](https://docs.api7.ai/apisix/getting-started/configure-routes.md): Learn how to define routes in Apache APISIX to manage traffic, match client requests, and forward them to upstream services effectively. #### key-authentication Explore how to configure key authentication in Apache APISIX, allowing secure access to your APIs by managing consumer credentials effectively. - [Key Authentication](https://docs.api7.ai/apisix/getting-started/key-authentication.md): Explore how to configure key authentication in Apache APISIX, allowing secure access to your APIs by managing consumer credentials effectively. #### load-balancing Understand how to implement load balancing in Apache APISIX, utilizing various algorithms to distribute incoming requests across multiple upstream services. - [Load Balancing](https://docs.api7.ai/apisix/getting-started/load-balancing.md): Understand how to implement load balancing in Apache APISIX, utilizing various algorithms to distribute incoming requests across multiple upstream services. #### management-options Compare the Admin API, ADC, a6 CLI, and APISIX-MCP to choose an APISIX resource management workflow for interactive use or automation. - [Management Options](https://docs.api7.ai/apisix/getting-started/management-options.md): Compare the Admin API, ADC, a6 CLI, and APISIX-MCP to choose an APISIX resource management workflow for interactive use or automation. #### rate-limiting Implement rate limiting in Apache APISIX to control traffic flow, protect your APIs from misuse, and ensure fair usage by setting request limits. - [Rate Limiting](https://docs.api7.ai/apisix/getting-started/rate-limiting.md): Implement rate limiting in Apache APISIX to control traffic flow, protect your APIs from misuse, and ensure fair usage by setting request limits. ### how-apisix-works Understand how Apache APISIX handles a request end-to-end, from configuration store to upstream selection, and how its router and hot-reload design let it scale to thousands of routes without a restart. - [How APISIX Works](https://docs.api7.ai/apisix/how-apisix-works.md): Understand how Apache APISIX handles a request end-to-end, from configuration store to upstream selection, and how its router and hot-reload design let it scale to thousands of routes without a restart. ### how-to-guide #### ai-gateway - [Configure Prompt Decorators](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/configure-prompt-decorators.md): Learn how to configure APISIX prompt decorators to prepend and append instructions to OpenAI Chat Completions and Responses API requests at the gateway. - [Implement Prompt Guardrails](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/implement-prompt-guardrails.md): Discover how to implement prompt guardrails in Apache APISIX to protect user privacy and discourage unintended model behaviors when using large language models (LLMs). - [Pre-Define Prompt Templates](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/pre-define-prompt-templates.md): Learn how to configure reusable Chat Completions and Responses API prompt templates in APISIX using client-supplied values, OpenAI web search, and tool use. - [Proxy Amazon Bedrock Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-amazon-bedrock-requests.md): Learn how to configure APISIX to authenticate with Amazon Bedrock and proxy Converse and ConverseStream requests with the ai-proxy plugin. - [Proxy Anthropic Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-anthropic-requests.md): Configure Apache APISIX to proxy OpenAI-compatible and native Anthropic Messages requests to Claude models with the ai-proxy plugin. - [Proxy Azure OpenAI Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-azure-openai-requests.md): Learn how to configure APISIX to authenticate with Azure OpenAI and proxy streaming and non-streaming Chat Completions and Responses API requests. - [Proxy Gemini Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-gemini-requests.md): Learn how to configure Apache APISIX to proxy requests to Google Gemini with the ai-proxy plugin, enabling access to Gemini models via an OpenAI-compatible API without specifying a custom endpoint. - [Proxy OpenAI Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-openai-requests.md): Learn how to configure APISIX to authenticate with OpenAI and proxy Chat Completions, Responses API, and Embeddings requests with the ai-proxy plugin. - [Proxy OpenRouter Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-openrouter-requests.md): Learn how to configure Apache APISIX to proxy requests to OpenRouter with the ai-proxy plugin, enabling access to many model providers via an OpenAI-compatible API without specifying a custom endpoint. - [Proxy Gemini Enterprise Agent Platform Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-vertex-ai-requests.md): Configure Apache APISIX to proxy requests to Gemini Enterprise Agent Platform with service-account authentication and an OpenAI-compatible API. #### authentication - [Authorize M2M Requests with Amazon Cognito](https://docs.api7.ai/apisix/how-to-guide/authentication/authorize-m2m-requests-with-amazon-cognito.md): Configure Apache APISIX to validate Amazon Cognito access tokens and authorize machine-to-machine API requests by client and custom scope. - [Authorize M2M Requests with Auth0](https://docs.api7.ai/apisix/how-to-guide/authentication/authorize-m2m-requests-with-auth0.md): Configure Apache APISIX to validate Auth0 access tokens and authorize machine-to-machine API requests with audience and scope restrictions. - [Authorize M2M Requests with Keycloak](https://docs.api7.ai/apisix/how-to-guide/authentication/authorize-m2m-requests-with-keycloak.md): Configure Apache APISIX to validate Keycloak access tokens and authorize machine-to-machine API requests by audience and client scope. - [Authorize M2M Requests with Microsoft Entra ID (Azure AD)](https://docs.api7.ai/apisix/how-to-guide/authentication/authorize-m2m-requests-with-microsoft-entra-id.md): Configure Apache APISIX to validate Microsoft Entra ID access tokens and authorize machine-to-machine API requests with application roles. - [Implement Basic Authentication](https://docs.api7.ai/apisix/how-to-guide/authentication/implement-basic-auth.md): Learn how to set up basic authentication in Apache APISIX, allowing clients to authenticate using a username and password combination securely. - [Implement HMAC Authentication](https://docs.api7.ai/apisix/how-to-guide/authentication/implement-hmac-auth.md): Explore the process of setting up HMAC authentication in Apache APISIX, ensuring secure API requests through cryptographic signatures using shared secret keys. - [Implement JWT Authentication](https://docs.api7.ai/apisix/how-to-guide/authentication/implement-jwt-auth.md): Understand how to implement JWT authentication in Apache APISIX, allowing secure and stateless authentication of API clients using JSON Web Tokens. - [Implement Key Authentication](https://docs.api7.ai/apisix/how-to-guide/authentication/implement-key-auth.md): Learn how to set up key authentication in Apache APISIX, allowing you to issue unique API keys to consumers for effective access control to your APIs. - [Secure OIDC with PAR and DPoP](https://docs.api7.ai/apisix/how-to-guide/authentication/secure-oidc-with-par-and-dpop.md): Configure APISIX and Keycloak to secure an OIDC authorization code flow with PAR, PKCE, DPoP-bound tokens, and private-key JWT authentication. - [Secure WebSocket Traffic](https://docs.api7.ai/apisix/how-to-guide/authentication/secure-websocket-traffic.md): Learn how to authenticate WebSocket upgrade requests in Apache APISIX so that only authorized clients can establish persistent connections. - [Set Up SSO with Amazon Cognito](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-amazon-cognito.md): Configure Apache APISIX with Amazon Cognito for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. - [Set Up SSO with Auth0](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-auth0.md): Configure Apache APISIX with Auth0 for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. - [Set Up SSO with Microsoft Entra ID (Azure AD)](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-azure-ad.md): Configure Apache APISIX with Microsoft Entra ID for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. - [Set Up SSO with Google](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-google.md): Configure Apache APISIX with Google for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. - [Set Up SSO with Keycloak](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-keycloak.md): Configure Apache APISIX with Keycloak for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. - [Set Up SSO with Okta](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-okta.md): Configure Apache APISIX with Okta for browser-based single sign-on using the OpenID Connect Authorization Code flow with PKCE. #### custom-plugins - [Create a Custom Plugin in Lua](https://docs.api7.ai/apisix/how-to-guide/custom-plugins/create-plugin-in-lua.md): Discover how to develop custom Lua plugins for Apache APISIX to extend its functionality. - [Use Wasm Plugins in APISIX](https://docs.api7.ai/apisix/how-to-guide/custom-plugins/wasm-plugins.md): Learn how to implement WebAssembly (Wasm) plugins in Apache APISIX, leveraging Proxy-Wasm specifications for enhanced capabilities. #### observability - [Log Consumer Label in Access Log](https://docs.api7.ai/apisix/how-to-guide/observability/log-consumer-label-in-access-log.md): Learn how to configure Apache APISIX to log consumer labels in access log, enhancing API management and security. - [Log with ClickHouse](https://docs.api7.ai/apisix/how-to-guide/observability/log-with-clickhouse.md): Learn how to configure Apache APISIX to log access information to ClickHouse, facilitating efficient log management and analysis. - [Log with Elasticsearch](https://docs.api7.ai/apisix/how-to-guide/observability/log-with-elasticsearch.md): Understand how to integrate Apache APISIX with Elasticsearch to collect and index logs, providing powerful search and visualization capabilities through the ELK stack. - [Monitor APISIX Metrics with Datadog](https://docs.api7.ai/apisix/how-to-guide/observability/monitor-apisix-with-datadog.md): Explore the process of integrating Datadog with Apache APISIX to monitor metrics, enabling enhanced observability and alerting capabilities. - [Monitor APISIX Metrics with Prometheus](https://docs.api7.ai/apisix/how-to-guide/observability/monitor-apisix-with-prometheus.md): Understand how to enable Prometheus in Apache APISIX for metrics collection, allowing you to monitor system performance and health effectively. - [Trace Requests with Zipkin](https://docs.api7.ai/apisix/how-to-guide/observability/trace-with-zipkin.md): Configure Apache APISIX request tracing with the Zipkin plugin, export sampled spans through the Zipkin v2 API, and analyze request flow and latency. #### security - [Manage Secrets in AWS Secrets Manager](https://docs.api7.ai/apisix/how-to-guide/security/secrets-management/manage-secrets-in-aws.md): Discover how to use AWS Secrets Manager with Apache APISIX to securely store and manage sensitive credentials, ensuring automated rotation and secure access. - [Manage Secrets in GCP Secret Manager](https://docs.api7.ai/apisix/how-to-guide/security/secrets-management/manage-secrets-in-gcp-secret-manager.md): Understand how to integrate GCP Secret Manager with Apache APISIX for centralized management of secrets like API keys and passwords, with secure retrieval mechanisms. - [Manage Secrets in HashiCorp Vault](https://docs.api7.ai/apisix/how-to-guide/security/secrets-management/manage-secrets-in-hashicorp-vault.md): Learn how to integrate HashiCorp Vault with Apache APISIX for secure management of sensitive information, including API keys and passwords, and how to retrieve these secrets within your application. - [Integrate with Coraza](https://docs.api7.ai/apisix/how-to-guide/security/waf/integrate-with-coraza.md): Explore the integration of Coraza Web Application Firewall (WAF) with Apache APISIX to enhance security, providing robust protection against various cyber attacks. #### service-discovery - [Integrate with HashiCorp Consul](https://docs.api7.ai/apisix/how-to-guide/service-discovery/consul-integration.md): Learn how to set up HashiCorp Consul for service discovery and integrate it with Apache APISIX to dynamically route and load balance traffic across microservices. - [Integrate with Netflix Eureka](https://docs.api7.ai/apisix/how-to-guide/service-discovery/eureka-integration.md): Set up Netflix Eureka service discovery with Apache APISIX to route and load balance traffic across available, dynamically registered service instances. - [Integrate with Kubernetes Service Discovery](https://docs.api7.ai/apisix/how-to-guide/service-discovery/kubernetes-service-discovery.md): Configure Apache APISIX to discover Kubernetes Endpoints or EndpointSlices securely and route requests to services in one or more clusters. #### traffic-management - [Implement API Versioning](https://docs.api7.ai/apisix/how-to-guide/traffic-management/api-versioning.md): Learn to implement API versioning in Apache APISIX using path, query, and header strategies for better API management. - [Manage Traffic Conditionally](https://docs.api7.ai/apisix/how-to-guide/traffic-management/conditional-traffic-management.md): Explore how to implement conditional traffic management in Apache APISIX, enabling dynamic routing and actions based on request characteristics such as headers or parameters. - [Configure Upstream Slow Start](https://docs.api7.ai/apisix/how-to-guide/traffic-management/configure-upstream-slow-start.md): Gradually increase traffic to newly added APISIX upstream nodes with slow start, giving applications time to warm caches before taking their full load. - [Configure Upstream Health Checks](https://docs.api7.ai/apisix/how-to-guide/traffic-management/health-check.md): Learn how to configure both active and passive health checks for upstream services in Apache APISIX, ensuring that requests are only forwarded to healthy services. - [Configure HTTP/3 QUIC Between Client and APISIX](https://docs.api7.ai/apisix/how-to-guide/traffic-management/http3-quic.md): Learn how to configure HTTP/3 connections in Apache APISIX to leverage the benefits of QUIC for improved performance and reduced latency. - [Proxy Transport Layer (L4) Traffic](https://docs.api7.ai/apisix/how-to-guide/traffic-management/proxy-transport-layer-l4-traffic.md): Explore how to configure Apache APISIX to handle transport layer (L4) TCP and UDP traffic, allowing for efficient proxying of various types of network traffic. - [Proxy WebSocket Connections](https://docs.api7.ai/apisix/how-to-guide/traffic-management/proxy-websocket.md): Learn how to configure Apache APISIX to proxy WebSocket upgrade requests and maintain persistent, bidirectional client connections. - [Configure Rate Limiting](https://docs.api7.ai/apisix/how-to-guide/traffic-management/rate-limiting.md): Understand how to set up rate limiting in Apache APISIX using various plugins to control access to your APIs and protect them from excessive requests. - [Configure HTTPS Between Client and APISIX](https://docs.api7.ai/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-https-between-client-and-apisix.md): Discover how to configure HTTPS between clients and Apache APISIX to enhance API security. - [Configure mTLS Between APISIX and Upstream](https://docs.api7.ai/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-mtls-between-apisix-and-upstream.md): Discover how to configure mutual TLS between Apache APISIX and upstream services for enhanced API security. - [Configure mTLS Between Client and APISIX](https://docs.api7.ai/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-mtls-between-client-and-apisix.md): Discover how to configure mutual TLS between clients and Apache APISIX for enhanced API security. - [Configure Upstream HTTPS](https://docs.api7.ai/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-upstream-https.md): Discover how to connect to upstream services on HTTPS ports in Apache APISIX, to secure communication and enhance API security. - [Implement Traffic Mirroring](https://docs.api7.ai/apisix/how-to-guide/traffic-management/traffic-mirroring.md): Understand how to set up traffic mirroring in Apache APISIX, allowing you to duplicate incoming traffic to a secondary service for testing or analysis without affecting the primary service. #### transformation - [Convert Between JSON and SOAP XML](https://docs.api7.ai/apisix/how-to-guide/transformation/convert-json-to-xml.md): Convert JSON requests to SOAP XML and SOAP responses to JSON with the APISIX body-transformer plugin and a reproducible example service. - [Transcode HTTP to gRPC](https://docs.api7.ai/apisix/how-to-guide/transformation/transcode-http-to-grpc.md): Configure APISIX to transcode HTTP requests to gRPC and return gRPC responses as JSON with the grpc-transcode plugin. ### install #### docker Learn how to install Apache APISIX using Docker, providing a straightforward method for deploying and managing your API gateway in a containerized environment. - [Install APISIX with Docker](https://docs.api7.ai/apisix/install/docker.md): Learn how to install Apache APISIX using Docker, providing a straightforward method for deploying and managing your API gateway in a containerized environment. - [Build Your Own Docker Images](https://docs.api7.ai/apisix/install/docker/build-custom-images.md): Learn how to build custom Docker images for Apache APISIX, allowing for tailored configurations to meet your specific deployment needs. #### kubernetes - [Install APISIX on ROSA](https://docs.api7.ai/apisix/install/kubernetes/rosa.md): Follow the steps to install Apache APISIX on Red Hat OpenShift Service on AWS (ROSA), a fully managed service for deploying OpenShift clusters. ### key-concepts #### consumer-groups Understand the concept of consumer groups in Apache APISIX, which allow for the management of multiple consumers with shared configurations. - [Consumer Groups](https://docs.api7.ai/apisix/key-concepts/consumer-groups.md): Understand the concept of consumer groups in Apache APISIX, which allow for the management of multiple consumers with shared configurations. #### consumers Understand the concept of consumers in Apache APISIX, which represent users or applications that interact with the API gateway and its services. - [Consumers](https://docs.api7.ai/apisix/key-concepts/consumers.md): Understand the concept of consumers in Apache APISIX, which represent users or applications that interact with the API gateway and its services. #### credentials Understand the concept of credentials in Apache APISIX, which manage authentication configurations for consumers to enhance security and access control. - [Credentials](https://docs.api7.ai/apisix/key-concepts/credentials.md): Understand the concept of credentials in Apache APISIX, which manage authentication configurations for consumers to enhance security and access control. #### plugin-configs Understand the concept of plugin configs in Apache APISIX, which centralize plugin configurations to enhance efficiency in API management. - [Plugin Configs](https://docs.api7.ai/apisix/key-concepts/plugin-configs.md): Understand the concept of plugin configs in Apache APISIX, which centralize plugin configurations to enhance efficiency in API management. #### plugin-global-rules Understand the concept of global rules in Apache APISIX, which allow plugins to be executed on every incoming request for consistent API behavior. - [Plugin Global Rules](https://docs.api7.ai/apisix/key-concepts/plugin-global-rules.md): Understand the concept of global rules in Apache APISIX, which allow plugins to be executed on every incoming request for consistent API behavior. #### plugin-metadata Understand the concept of plugin metadata in Apache APISIX, which manages shared configurations for plugins, ensuring consistency across multiple instances. - [Plugin Metadata](https://docs.api7.ai/apisix/key-concepts/plugin-metadata.md): Understand the concept of plugin metadata in Apache APISIX, which manages shared configurations for plugins, ensuring consistency across multiple instances. #### plugins Understand the concept of plugins in Apache APISIX, which extend functionality for traffic management, security, and observability in API operations. - [Plugins](https://docs.api7.ai/apisix/key-concepts/plugins.md): Understand the concept of plugins in Apache APISIX, which extend functionality for traffic management, security, and observability in API operations. #### protos Understand the concept of protos in Apache APISIX, which facilitates efficient data serialization and communication between services. - [Protos](https://docs.api7.ai/apisix/key-concepts/protos.md): Understand the concept of protos in Apache APISIX, which facilitates efficient data serialization and communication between services. #### routes Understand the concept of routes in Apache APISIX, which define paths to upstream services and facilitate effective traffic management. - [Routes](https://docs.api7.ai/apisix/key-concepts/routes.md): Understand the concept of routes in Apache APISIX, which define paths to upstream services and facilitate effective traffic management. #### secrets Understand the concept of secrets in Apache APISIX, which enable secure storage and management of sensitive information like API keys. - [Secrets](https://docs.api7.ai/apisix/key-concepts/secrets.md): Understand the concept of secrets in Apache APISIX, which enable secure storage and management of sensitive information like API keys. #### services Understand the concept of services in Apache APISIX, which represent backend applications and streamline API management by reducing configuration redundancies. - [Services](https://docs.api7.ai/apisix/key-concepts/services.md): Understand the concept of services in Apache APISIX, which represent backend applications and streamline API management by reducing configuration redundancies. #### ssl-certificates Understand the concept of SSL certificates in Apache APISIX, which ensure secure communication between clients and the API gateway. - [SSL Certificates](https://docs.api7.ai/apisix/key-concepts/ssl-certificates.md): Understand the concept of SSL certificates in Apache APISIX, which ensure secure communication between clients and the API gateway. #### stream-routes Understand the concept of stream routes in Apache APISIX, which manage TCP/UDP traffic, enhancing the gateway's capabilities for various protocols. - [Stream Routes](https://docs.api7.ai/apisix/key-concepts/stream-routes.md): Understand the concept of stream routes in Apache APISIX, which manage TCP/UDP traffic, enhancing the gateway's capabilities for various protocols. #### upstreams Understand the concept of upstreams in Apache APISIX, which manage backend service addresses for efficient load balancing and service discovery. - [Upstreams](https://docs.api7.ai/apisix/key-concepts/upstreams.md): Understand the concept of upstreams in Apache APISIX, which manage backend service addresses for efficient load balancing and service discovery. ### migration #### nginx-to-apisix Follow the guide for migrating from NGINX to Apache APISIX, ensuring a smooth transition while leveraging the benefits of the API gateway. - [Migrate from NGINX to APISIX](https://docs.api7.ai/apisix/migration/nginx-to-apisix.md): Follow the guide for migrating from NGINX to Apache APISIX, ensuring a smooth transition while leveraging the benefits of the API gateway. ### networking #### port-reference Explore the default port configurations for Apache APISIX, detailing the ports used for various protocols and services within the API gateway. - [Port Reference](https://docs.api7.ai/apisix/networking/port-reference.md): Explore the default port configurations for Apache APISIX, detailing the ports used for various protocols and services within the API gateway. ### production #### deployment-modes Understand the various deployment modes of Apache APISIX, including traditional, decoupled, and standalone modes, to optimize your API gateway deployment strategy. - [Deployment Modes](https://docs.api7.ai/apisix/production/deployment-modes.md): Understand the various deployment modes of Apache APISIX, including traditional, decoupled, and standalone modes, to optimize your API gateway deployment strategy. #### etcd - [Operate etcd in Production](https://docs.api7.ai/apisix/production/etcd/operations.md): Plan, secure, monitor, maintain, and recover the etcd cluster that stores Apache APISIX configuration in production environments. #### performance - [Performance Testing Benchmarks](https://docs.api7.ai/apisix/production/performance/performance-testing.md): Explore methods for conducting performance testing on Apache APISIX, ensuring your API gateway can handle expected traffic loads effectively. #### recovery - [Back Up and Restore etcd](https://docs.api7.ai/apisix/production/recovery/etcd-backup-restore.md): Discover best practices for backing up and restoring etcd in Apache APISIX, ensuring data integrity and availability for your API configurations. #### scaling - [Autoscale APISIX Gateway (AWS EC2)](https://docs.api7.ai/apisix/production/scaling/autoscale-apisix-gateway-aws.md): Learn how to autoscale APISIX Gateway on AWS EC2 using Auto Scaling Group (ASG) to maintain consistent API performance under varying traffic loads. - [Autoscale APISIX Gateway (K8s)](https://docs.api7.ai/apisix/production/scaling/autoscale-apisix-gateway-k8s.md): Learn how to autoscale APISIX Gateway on Kubernetes using a Horizontal Pod Autoscaler (HPA) to maintain consistent API performance under varying traffic loads. #### security - [Admin API Key](https://docs.api7.ai/apisix/production/security/admin-api-key.md): Learn about the importance of configuring Admin API keys in Apache APISIX, ensuring secure access to Admin API endpoints and managing permissions effectively. - [Data Encryption with Keyring](https://docs.api7.ai/apisix/production/security/data-encryption-with-keyring.md): Understand the significance of data encryption in Apache APISIX and how to secure sensitive information using keyrings for enhanced protection. - [IP Restriction](https://docs.api7.ai/apisix/production/security/ip-restriction.md): Discover how to implement IP restriction in Apache APISIX to control access to resources, enhancing security by allowing only authorized IP addresses. - [Configure mTLS between APISIX and etcd](https://docs.api7.ai/apisix/production/security/mtls/configure-mtls-between-apisix-and-etcd.md): Learn how to configure mutual TLS between Apache APISIX and etcd, ensuring secure communication and authentication between these components. - [Configure mTLS between Client and APISIX Admin API](https://docs.api7.ai/apisix/production/security/mtls/configure-mtls-between-client-and-admin-api.md): Explore the steps to set up mutual TLS between clients and the APISIX Admin API, enhancing API security through two-way authentication. #### serve-static-resources Understand how to configure Apache APISIX to serve static resources efficiently, improving performance and resource management for your APIs. - [Serve Static Resources](https://docs.api7.ai/apisix/production/serve-static-resources.md): Understand how to configure Apache APISIX to serve static resources efficiently, improving performance and resource management for your APIs. #### upgrade - [Canary Deployment](https://docs.api7.ai/apisix/production/upgrade/canary-deployment.md): Learn about the canary deployment strategy in Apache APISIX, allowing for gradual rollouts of new features while minimizing risk. ### troubleshooting #### debug-mode Enable and configure debug mode in Apache APISIX to inspect runtime behavior, log details, and troubleshoot issues effectively. - [Use Debug Mode](https://docs.api7.ai/apisix/troubleshooting/debug-mode.md): Enable and configure debug mode in Apache APISIX to inspect runtime behavior, log details, and troubleshoot issues effectively. #### set-breakpoints Learn how to use the APISIX inspect plugin to capture local variables and function-scoped captured values at any line of Lua source in a running worker, without restarting APISIX or modifying source code. - [Set Breakpoints](https://docs.api7.ai/apisix/troubleshooting/set-breakpoints.md): Learn how to use the APISIX inspect plugin to capture local variables and function-scoped captured values at any line of Lua source in a running worker, without restarting APISIX or modifying source code. ## hub Explore plugin documentation for Apache APISIX and API7 Gateway, including configuration references and examples for gateway and Ingress Controller workflows. - [Welcome to API Gateway Plugin Hub](https://docs.api7.ai/hub.md): Explore plugin documentation for Apache APISIX and API7 Gateway, including configuration references and examples for gateway and Ingress Controller workflows. ### acl The acl plugin authorizes requests by matching consumer or external user labels against allow and deny policies. - [acl](https://docs.api7.ai/hub/acl.md): The acl plugin authorizes requests by matching consumer or external user labels against allow and deny policies. #### configuration Parameters - [ACL](https://docs.api7.ai/hub/acl/configuration.md): Parameters ### ai-aliyun-content-moderation The ai-aliyun-content-moderation plugin uses Aliyun to evaluate selected request roles and LLM responses, including streaming responses, against a risk threshold. - [ai-aliyun-content-moderation](https://docs.api7.ai/hub/ai-aliyun-content-moderation.md): The ai-aliyun-content-moderation plugin uses Aliyun to evaluate selected request roles and LLM responses, including streaming responses, against a risk threshold. #### configuration Parameters - [AI Aliyun Content Moderation](https://docs.api7.ai/hub/ai-aliyun-content-moderation/configuration.md): Parameters ### ai-aws-content-moderation The ai-aws-content-moderation plugin uses Amazon Comprehend to detect toxicity in selected request roles and LLM responses, including streaming responses. - [ai-aws-content-moderation](https://docs.api7.ai/hub/ai-aws-content-moderation.md): The ai-aws-content-moderation plugin uses Amazon Comprehend to detect toxicity in selected request roles and LLM responses, including streaming responses. #### configuration Parameters - [AI AWS Content Moderation](https://docs.api7.ai/hub/ai-aws-content-moderation/configuration.md): Parameters ### ai-cache The ai-cache plugin stores exact and semantically similar LLM responses in Redis, reducing response latency and repeated upstream model usage. - [ai-cache](https://docs.api7.ai/hub/ai-cache.md): The ai-cache plugin stores exact and semantically similar LLM responses in Redis, reducing response latency and repeated upstream model usage. #### configuration Parameters - [AI Cache](https://docs.api7.ai/hub/ai-cache/configuration.md): Parameters ### ai-lakera-guard The ai-lakera-guard plugin screens AI traffic through the Lakera Guard API to detect prompt injection and other unsafe content in requests and LLM responses. - [ai-lakera-guard](https://docs.api7.ai/hub/ai-lakera-guard.md): The ai-lakera-guard plugin screens AI traffic through the Lakera Guard API to detect prompt injection and other unsafe content in requests and LLM responses. #### configuration Parameters - [AI Lakera Guard](https://docs.api7.ai/hub/ai-lakera-guard/configuration.md): Parameters ### ai-prompt-decorator The ai-prompt-decorator plugin decorates user prompts to LLMs by prefixing and appending pre-engineered prompts, streamlining API operation and content generation. - [ai-prompt-decorator](https://docs.api7.ai/hub/ai-prompt-decorator.md): The ai-prompt-decorator plugin decorates user prompts to LLMs by prefixing and appending pre-engineered prompts, streamlining API operation and content generation. #### configuration Parameters - [AI Prompt Decorator](https://docs.api7.ai/hub/ai-prompt-decorator/configuration.md): Parameters ### ai-prompt-guard The ai-prompt-guard plugin safeguards prompts to LLM using allow/deny patterns, ensuring only approved inputs pass. It can check the latest message or full history. - [ai-prompt-guard](https://docs.api7.ai/hub/ai-prompt-guard.md): The ai-prompt-guard plugin safeguards prompts to LLM using allow/deny patterns, ensuring only approved inputs pass. It can check the latest message or full history. #### configuration Parameters - [AI Prompt Guard](https://docs.api7.ai/hub/ai-prompt-guard/configuration.md): Parameters ### ai-prompt-template The ai-prompt-template plugin supports pre-configured templates for user inputs to LLMs in a "fill in the blank" fashion, streamlining API management. - [ai-prompt-template](https://docs.api7.ai/hub/ai-prompt-template.md): The ai-prompt-template plugin supports pre-configured templates for user inputs to LLMs in a "fill in the blank" fashion, streamlining API management. #### configuration Parameters - [AI Prompt Template](https://docs.api7.ai/hub/ai-prompt-template/configuration.md): Parameters ### ai-proxy The ai-proxy plugin connects LLM and embedding providers through a common configuration for OpenAI, DeepSeek, Anthropic, and other compatible APIs. - [ai-proxy](https://docs.api7.ai/hub/ai-proxy.md): The ai-proxy plugin connects LLM and embedding providers through a common configuration for OpenAI, DeepSeek, Anthropic, and other compatible APIs. #### configuration Static Configurations - [AI Proxy](https://docs.api7.ai/hub/ai-proxy/configuration.md): Static Configurations ### ai-proxy-multi The ai-proxy-multi plugin distributes AI requests across OpenAI, DeepSeek, and other compatible APIs with load balancing, retries, fallbacks, and health checks. - [ai-proxy-multi](https://docs.api7.ai/hub/ai-proxy-multi.md): The ai-proxy-multi plugin distributes AI requests across OpenAI, DeepSeek, and other compatible APIs with load balancing, retries, fallbacks, and health checks. #### configuration Static Configurations - [AI Proxy Multi](https://docs.api7.ai/hub/ai-proxy-multi/configuration.md): Static Configurations ### ai-proxy-protocol-reference Understand how ai-proxy and ai-proxy-multi detect client request protocols and convert Anthropic Messages requests to OpenAI Chat Completions. - [Protocol Reference](https://docs.api7.ai/hub/ai-proxy-protocol-reference.md): Understand how ai-proxy and ai-proxy-multi detect client request protocols and convert Anthropic Messages requests to OpenAI Chat Completions. ### ai-rag The ai-rag plugin retrieves context with Azure OpenAI embeddings and Azure AI Search before an LLM request is proxied. - [ai-rag](https://docs.api7.ai/hub/ai-rag.md): The ai-rag plugin retrieves context with Azure OpenAI embeddings and Azure AI Search before an LLM request is proxied. #### configuration Plugin Parameters - [AI RAG](https://docs.api7.ai/hub/ai-rag/configuration.md): Plugin Parameters ### ai-rate-limiting The ai-rate-limiting plugin enforces token-based rate limiting for LLM service requests, preventing overuse, optimizing API consumption, and ensuring efficient resource allocation. - [ai-rate-limiting](https://docs.api7.ai/hub/ai-rate-limiting.md): The ai-rate-limiting plugin enforces token-based rate limiting for LLM service requests, preventing overuse, optimizing API consumption, and ensuring efficient resource allocation. #### configuration Parameters - [AI Rate Limiting](https://docs.api7.ai/hub/ai-rate-limiting/configuration.md): Parameters ### ai-request-rewrite The ai-request-rewrite plugin forwards client requests to LLM services for processing before sending them upstream, enabling AI-driven redaction, enrichment, and reformatting. - [ai-request-rewrite](https://docs.api7.ai/hub/ai-request-rewrite.md): The ai-request-rewrite plugin forwards client requests to LLM services for processing before sending them upstream, enabling AI-driven redaction, enrichment, and reformatting. #### configuration Parameters - [AI Request Rewrite](https://docs.api7.ai/hub/ai-request-rewrite/configuration.md): Parameters ### attach-consumer-label The attach-consumer-label plugin attaches custom consumer labels to authenticated requests, for upstream services to implement additional business logics. - [attach-consumer-label](https://docs.api7.ai/hub/attach-consumer-label.md): The attach-consumer-label plugin attaches custom consumer labels to authenticated requests, for upstream services to implement additional business logics. #### configuration Parameters - [Attach Consumer Label](https://docs.api7.ai/hub/attach-consumer-label/configuration.md): Parameters ### authz-keycloak The authz-keycloak plugin delegates UMA permission decisions to Keycloak Authorization Services for APISIX and API7 Gateway requests. - [authz-keycloak](https://docs.api7.ai/hub/authz-keycloak.md): The authz-keycloak plugin delegates UMA permission decisions to Keycloak Authorization Services for APISIX and API7 Gateway requests. #### configuration Parameters - [Authz Keycloak](https://docs.api7.ai/hub/authz-keycloak/configuration.md): Parameters ### aws-lambda The aws-lambda plugin invokes AWS Lambda function URLs and Amazon API Gateway endpoints with SigV4 signing, API key forwarding, and path preservation. - [aws-lambda](https://docs.api7.ai/hub/aws-lambda.md): The aws-lambda plugin invokes AWS Lambda function URLs and Amazon API Gateway endpoints with SigV4 signing, API key forwarding, and path preservation. #### configuration Parameters - [AWS Lambda](https://docs.api7.ai/hub/aws-lambda/configuration.md): Parameters ### basic-auth The basic-auth plugin provides basic access authentication, requiring clients to authenticate before accessing upstream resources, enhancing API security. - [basic-auth](https://docs.api7.ai/hub/basic-auth.md): The basic-auth plugin provides basic access authentication, requiring clients to authenticate before accessing upstream resources, enhancing API security. #### configuration Parameters - [Basic Auth](https://docs.api7.ai/hub/basic-auth/configuration.md): Parameters ### body-transformer The body-transformer plugin uses templates to transform request and response bodies between formats required by clients and upstream services. - [body-transformer](https://docs.api7.ai/hub/body-transformer.md): The body-transformer plugin uses templates to transform request and response bodies between formats required by clients and upstream services. #### configuration Parameters - [Body Transformer](https://docs.api7.ai/hub/body-transformer/configuration.md): Parameters ### chaitin-waf The chaitin-waf plugin sends requests to SafeLine for web threat detection, with monitoring and blocking modes, response reporting, and diagnostic headers. - [chaitin-waf](https://docs.api7.ai/hub/chaitin-waf.md): The chaitin-waf plugin sends requests to SafeLine for web threat detection, with monitoring and blocking modes, response reporting, and diagnostic headers. #### configuration Parameters - [Chaitin WAF](https://docs.api7.ai/hub/chaitin-waf/configuration.md): Parameters ### clickhouse-logger The clickhouse-logger plugin pushes request and response logs to ClickHouse databases in batches, allowing for customizable log formats to enhance data management. - [clickhouse-logger](https://docs.api7.ai/hub/clickhouse-logger.md): The clickhouse-logger plugin pushes request and response logs to ClickHouse databases in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [ClickHouse Logger](https://docs.api7.ai/hub/clickhouse-logger/configuration.md): Parameters ### consumer-restriction The consumer-restriction plugin controls access by consumer, route, service, or APISIX consumer group; API7 Gateway does not support consumer-group matching. - [consumer-restriction](https://docs.api7.ai/hub/consumer-restriction.md): The consumer-restriction plugin controls access by consumer, route, service, or APISIX consumer group; API7 Gateway does not support consumer-group matching. #### configuration Parameters - [Consumer Restriction](https://docs.api7.ai/hub/consumer-restriction/configuration.md): Parameters ### cors The cors plugin enables cross-origin resource sharing, allowing servers to specify permitted origins and instructing browsers to load resources from those origins, enhancing API accessibility. - [cors](https://docs.api7.ai/hub/cors.md): The cors plugin enables cross-origin resource sharing, allowing servers to specify permitted origins and instructing browsers to load resources from those origins, enhancing API accessibility. #### configuration Parameters - [CORS](https://docs.api7.ai/hub/cors/configuration.md): Parameters ### data-mask The data-mask plugin removes or replaces sensitive information in request headers, bodies, and URL queries for logging purposes, enhancing data privacy and security. - [data-mask](https://docs.api7.ai/hub/data-mask.md): The data-mask plugin removes or replaces sensitive information in request headers, bodies, and URL queries for logging purposes, enhancing data privacy and security. #### configuration Parameters - [Data Mask](https://docs.api7.ai/hub/data-mask/configuration.md): Parameters ### datadog The datadog plugin sends APISIX and API7 Gateway request metrics to Datadog through DogStatsD for monitoring traffic, latency, status, and payload size. - [datadog](https://docs.api7.ai/hub/datadog.md): The datadog plugin sends APISIX and API7 Gateway request metrics to Datadog through DogStatsD for monitoring traffic, latency, status, and payload size. #### configuration Parameters - [Datadog](https://docs.api7.ai/hub/datadog/configuration.md): Parameters ### degraphql The degraphql plugin maps HTTP routes to predefined GraphQL queries and forwards selected request values as GraphQL variables. - [degraphql](https://docs.api7.ai/hub/degraphql.md): The degraphql plugin maps HTTP routes to predefined GraphQL queries and forwards selected request values as GraphQL variables. #### configuration Parameters - [degraphql](https://docs.api7.ai/hub/degraphql/configuration.md): Parameters ### elasticsearch-logger The elasticsearch-logger plugin sends gateway request and response logs to Elasticsearch in batches and supports customizable log formats and index names. - [elasticsearch-logger](https://docs.api7.ai/hub/elasticsearch-logger.md): The elasticsearch-logger plugin sends gateway request and response logs to Elasticsearch in batches and supports customizable log formats and index names. #### configuration Parameters - [Elasticsearch Logger](https://docs.api7.ai/hub/elasticsearch-logger/configuration.md): Parameters ### error-log-collect The error-log-collect plugin captures the error logs produced while processing selected requests, including lower-severity entries that the configured log level would otherwise discard, and writes them to the gateway error log for targeted debugging. - [error-log-collect Enterprise](https://docs.api7.ai/hub/error-log-collect.md): The error-log-collect plugin captures the error logs produced while processing selected requests, including lower-severity entries that the configured log level would otherwise discard, and writes them to the gateway error log for targeted debugging. #### configuration Parameters - [Error Log Collect](https://docs.api7.ai/hub/error-log-collect/configuration.md): Parameters ### error-log-logger The error-log-logger plugin sends APISIX and API7 Gateway error logs to TCP, Apache SkyWalking, Apache Kafka, or ClickHouse servers. - [error-log-logger](https://docs.api7.ai/hub/error-log-logger.md): The error-log-logger plugin sends APISIX and API7 Gateway error logs to TCP, Apache SkyWalking, Apache Kafka, or ClickHouse servers. #### configuration Parameters - [Error Log Logger](https://docs.api7.ai/hub/error-log-logger/configuration.md): Parameters ### error-page The error-page plugin customizes gateway-generated 404, 500, 502, and 503 responses without modifying responses returned by upstream services. - [error-page](https://docs.api7.ai/hub/error-page.md): The error-page plugin customizes gateway-generated 404, 500, 502, and 503 responses without modifying responses returned by upstream services. #### configuration Parameters - [Error Page](https://docs.api7.ai/hub/error-page/configuration.md): Parameters ### exit-transformer The exit-transformer plugin customizes responses generated by gateway plugins or missing routes before APISIX sends them to clients. - [exit-transformer](https://docs.api7.ai/hub/exit-transformer.md): The exit-transformer plugin customizes responses generated by gateway plugins or missing routes before APISIX sends them to clients. #### configuration Parameters - [Exit Transformer](https://docs.api7.ai/hub/exit-transformer/configuration.md): Parameters ### fault-injection The fault-injection plugin tests application resiliency by simulating controlled faults or delays, making it ideal for chaos engineering and failure condition analysis. - [fault-injection](https://docs.api7.ai/hub/fault-injection.md): The fault-injection plugin tests application resiliency by simulating controlled faults or delays, making it ideal for chaos engineering and failure condition analysis. #### configuration Parameters - [Fault Injection](https://docs.api7.ai/hub/fault-injection/configuration.md): Parameters ### forward-auth The forward-auth plugin integrates with external authorization services, enhancing API security and access control. - [forward-auth](https://docs.api7.ai/hub/forward-auth.md): The forward-auth plugin integrates with external authorization services, enhancing API security and access control. #### configuration Parameters - [Forward Auth](https://docs.api7.ai/hub/forward-auth/configuration.md): Parameters ### google-cloud-logging The google-cloud-logging plugin sends request and response logs to Google Cloud Logging in batches and supports customizable log formats. - [google-cloud-logging](https://docs.api7.ai/hub/google-cloud-logging.md): The google-cloud-logging plugin sends request and response logs to Google Cloud Logging in batches and supports customizable log formats. #### configuration Parameters - [Google Cloud Logging](https://docs.api7.ai/hub/google-cloud-logging/configuration.md): Parameters ### graphql-limit-count The graphql-limit-count plugin uses fixed windows to limit accumulated GraphQL document cost, with selection depth as the default measure. - [graphql-limit-count](https://docs.api7.ai/hub/graphql-limit-count.md): The graphql-limit-count plugin uses fixed windows to limit accumulated GraphQL document cost, with selection depth as the default measure. #### configuration Parameters - [GraphQL Limit Count](https://docs.api7.ai/hub/graphql-limit-count/configuration.md): Parameters ### graphql-proxy-cache The graphql-proxy-cache plugin caches GraphQL query responses in memory or on disk to reduce upstream load and supports authenticated cache purging. - [graphql-proxy-cache](https://docs.api7.ai/hub/graphql-proxy-cache.md): The graphql-proxy-cache plugin caches GraphQL query responses in memory or on disk to reduce upstream load and supports authenticated cache purging. #### configuration Static Configurations - [GraphQL Proxy Cache](https://docs.api7.ai/hub/graphql-proxy-cache/configuration.md): Static Configurations ### grpc-transcode The grpc-transcode plugin translates HTTP requests into gRPC calls and converts protobuf responses and structured gRPC errors into JSON. - [grpc-transcode](https://docs.api7.ai/hub/grpc-transcode.md): The grpc-transcode plugin translates HTTP requests into gRPC calls and converts protobuf responses and structured gRPC errors into JSON. #### configuration Parameters - [gRPC Transcode](https://docs.api7.ai/hub/grpc-transcode/configuration.md): Parameters ### grpc-web The grpc-web plugin enables the gateway to handle gRPC-Web requests from browsers and JavaScript clients by translating them into standard gRPC calls and forwarding them to upstream gRPC services. - [grpc-web](https://docs.api7.ai/hub/grpc-web.md): The grpc-web plugin enables the gateway to handle gRPC-Web requests from browsers and JavaScript clients by translating them into standard gRPC calls and forwarding them to upstream gRPC services. #### configuration Parameters - [gRPC Web](https://docs.api7.ai/hub/grpc-web/configuration.md): Parameters ### hmac-auth The hmac-auth plugin supports HMAC authentication to ensure request integrity, preventing modifications during transmission and enhancing API security. - [hmac-auth](https://docs.api7.ai/hub/hmac-auth.md): The hmac-auth plugin supports HMAC authentication to ensure request integrity, preventing modifications during transmission and enhancing API security. #### configuration Parameters - [HMAC Auth](https://docs.api7.ai/hub/hmac-auth/configuration.md): Parameters ### http-logger The http-logger plugin sends request and response logs to HTTP or HTTPS endpoints in batches and supports customizable log formats. - [http-logger](https://docs.api7.ai/hub/http-logger.md): The http-logger plugin sends request and response logs to HTTP or HTTPS endpoints in batches and supports customizable log formats. #### configuration Parameters - [HTTP Logger](https://docs.api7.ai/hub/http-logger/configuration.md): Parameters ### ip-restriction The ip-restriction plugin restricts access to upstream resources based on an IP address whitelist or blacklist, improving API security. - [ip-restriction](https://docs.api7.ai/hub/ip-restriction.md): The ip-restriction plugin restricts access to upstream resources based on an IP address whitelist or blacklist, improving API security. #### configuration Parameters - [IP Restriction](https://docs.api7.ai/hub/ip-restriction/configuration.md): Parameters ### jwe-decrypt The jwe-decrypt plugin decrypts a JWE compact serialization token and forwards the plaintext in a configured request header. - [jwe-decrypt](https://docs.api7.ai/hub/jwe-decrypt.md): The jwe-decrypt plugin decrypts a JWE compact serialization token and forwards the plaintext in a configured request header. #### configuration Parameters - [JWE Decrypt](https://docs.api7.ai/hub/jwe-decrypt/configuration.md): Parameters ### jwt-auth The jwt-auth plugin authenticates consumers by validating signed JSON Web Tokens from request headers, query parameters, or cookies before proxying requests. - [jwt-auth](https://docs.api7.ai/hub/jwt-auth.md): The jwt-auth plugin authenticates consumers by validating signed JSON Web Tokens from request headers, query parameters, or cookies before proxying requests. #### configuration Parameters - [JWT Auth](https://docs.api7.ai/hub/jwt-auth/configuration.md): Parameters ### kafka-logger The kafka-logger plugin pushes request and response logs as JSON objects to Apache Kafka clusters in batches, allowing for customizable log formats to enhance data management. - [kafka-logger](https://docs.api7.ai/hub/kafka-logger.md): The kafka-logger plugin pushes request and response logs as JSON objects to Apache Kafka clusters in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [Kafka Logger](https://docs.api7.ai/hub/kafka-logger/configuration.md): Parameters ### key-auth The key-auth plugin allows clients to authenticate using an authentication key before accessing upstream resources, enhancing API security measures. - [key-auth](https://docs.api7.ai/hub/key-auth.md): The key-auth plugin allows clients to authenticate using an authentication key before accessing upstream resources, enhancing API security measures. #### configuration Parameters - [Key Auth](https://docs.api7.ai/hub/key-auth/configuration.md): Parameters ### ldap-auth-advanced The ldap-auth-advanced plugin authenticates clients against LDAP, optionally maps directory users to consumers, and supports LDAP, Basic, StartTLS, and LDAPS. - [ldap-auth-advanced](https://docs.api7.ai/hub/ldap-auth-advanced.md): The ldap-auth-advanced plugin authenticates clients against LDAP, optionally maps directory users to consumers, and supports LDAP, Basic, StartTLS, and LDAPS. #### configuration Parameters - [LDAP Auth Advanced](https://docs.api7.ai/hub/ldap-auth-advanced/configuration.md): Parameters ### limit-conn The limit-conn plugin delays or rejects excess concurrent HTTP, WebSocket, and TCP connections in APISIX and API7 Gateway to prevent overload. - [limit-conn](https://docs.api7.ai/hub/limit-conn.md): The limit-conn plugin delays or rejects excess concurrent HTTP, WebSocket, and TCP connections in APISIX and API7 Gateway to prevent overload. #### configuration Parameters - [Limit Conn](https://docs.api7.ai/hub/limit-conn/configuration.md): Parameters ### limit-count The limit-count plugin enforces API rate limiting with a fixed window algorithm, restricting requests within a time interval. Requests over the quota are rejected. - [limit-count](https://docs.api7.ai/hub/limit-count.md): The limit-count plugin enforces API rate limiting with a fixed window algorithm, restricting requests within a time interval. Requests over the quota are rejected. #### configuration Parameters - [Limit Count](https://docs.api7.ai/hub/limit-count/configuration.md): Parameters ### limit-count-advanced The limit-count-advanced plugin enforces API rate limiting with a fixed window or sliding window algorithm, restricting requests within a time window. Requests over the quota are rejected. - [limit-count-advanced Enterprise](https://docs.api7.ai/hub/limit-count-advanced.md): The limit-count-advanced plugin enforces API rate limiting with a fixed window or sliding window algorithm, restricting requests within a time window. Requests over the quota are rejected. #### configuration Parameters - [Limit Count Advanced](https://docs.api7.ai/hub/limit-count-advanced/configuration.md): Parameters ### limit-req The limit-req plugin enforces API rate limiting with a leaky bucket algorithm to rate limit requests, enabling effective throttling to manage traffic flow. - [limit-req](https://docs.api7.ai/hub/limit-req.md): The limit-req plugin enforces API rate limiting with a leaky bucket algorithm to rate limit requests, enabling effective throttling to manage traffic flow. #### configuration Parameters - [Limit Req](https://docs.api7.ai/hub/limit-req/configuration.md): Parameters ### loki-logger The loki-logger plugin sends APISIX and API7 Gateway request and response logs to Grafana Loki in batches with customizable log formats. - [loki-logger](https://docs.api7.ai/hub/loki-logger.md): The loki-logger plugin sends APISIX and API7 Gateway request and response logs to Grafana Loki in batches with customizable log formats. #### configuration Parameters - [Loki Logger](https://docs.api7.ai/hub/loki-logger/configuration.md): Parameters ### mcp-tools-acl The mcp-tools-acl plugin provides per-consumer access control for MCP tool calls on routes powered by openapi-to-mcp, supporting rule-based allowlist and denylist modes with optional expression conditions. - [mcp-tools-acl Enterprise](https://docs.api7.ai/hub/mcp-tools-acl.md): The mcp-tools-acl plugin provides per-consumer access control for MCP tool calls on routes powered by openapi-to-mcp, supporting rule-based allowlist and denylist modes with optional expression conditions. #### configuration Parameters - [MCP Tools ACL](https://docs.api7.ai/hub/mcp-tools-acl/configuration.md): Parameters ### mocking The mocking plugin simulates API responses without forwarding requests to upstream services, offering customization of status codes, response bodies, headers, and more for API testing and development. - [mocking](https://docs.api7.ai/hub/mocking.md): The mocking plugin simulates API responses without forwarding requests to upstream services, offering customization of status codes, response bodies, headers, and more for API testing and development. #### configuration Parameters - [Mocking](https://docs.api7.ai/hub/mocking/configuration.md): Parameters ### mqtt-proxy The mqtt-proxy plugin validates MQTT connections and proxies them to MQTT brokers, with client-ID-aware consistent-hash load balancing. - [mqtt-proxy](https://docs.api7.ai/hub/mqtt-proxy.md): The mqtt-proxy plugin validates MQTT connections and proxies them to MQTT brokers, with client-ID-aware consistent-hash load balancing. #### configuration Parameters - [MQTT Proxy](https://docs.api7.ai/hub/mqtt-proxy/configuration.md): Parameters ### multi-auth The multi-auth plugin enables consumers using diverse authentication methods to share the same route or service, streamlining API lifecycle management. - [multi-auth](https://docs.api7.ai/hub/multi-auth.md): The multi-auth plugin enables consumers using diverse authentication methods to share the same route or service, streamlining API lifecycle management. #### configuration Parameters - [Multi Auth](https://docs.api7.ai/hub/multi-auth/configuration.md): Parameters ### oas-validator The oas-validator plugin checks incoming HTTP requests against an OpenAPI specification before they are forwarded to upstream services. - [oas-validator](https://docs.api7.ai/hub/oas-validator.md): The oas-validator plugin checks incoming HTTP requests against an OpenAPI specification before they are forwarded to upstream services. #### configuration Parameters - [OAS Validator](https://docs.api7.ai/hub/oas-validator/configuration.md): Parameters ### opa The OPA plugin integrates with Open Policy Agent, enabling unified policy definition and enforcement for authorization in API operations. - [OPA](https://docs.api7.ai/hub/opa.md): The OPA plugin integrates with Open Policy Agent, enabling unified policy definition and enforcement for authorization in API operations. #### configuration Parameters - [OPA](https://docs.api7.ai/hub/opa/configuration.md): Parameters ### openapi-to-mcp Expose OpenAPI services as MCP tools with APISIX or API7 Gateway, using Streamable HTTP or SSE and configurable upstream request headers. - [openapi-to-mcp](https://docs.api7.ai/hub/openapi-to-mcp.md): Expose OpenAPI services as MCP tools with APISIX or API7 Gateway, using Streamable HTTP or SSE and configurable upstream request headers. #### configuration Static Configurations - [OpenAPI to MCP](https://docs.api7.ai/hub/openapi-to-mcp/configuration.md): Static Configurations ### openid-connect The openid-connect plugin integrates with OIDC providers like Keycloak and Auth0, simplifying user authentication in API management. - [openid-connect](https://docs.api7.ai/hub/openid-connect.md): The openid-connect plugin integrates with OIDC providers like Keycloak and Auth0, simplifying user authentication in API management. #### configuration Parameters - [OpenID Connect](https://docs.api7.ai/hub/openid-connect/configuration.md): Parameters ### opentelemetry The opentelemetry plugin exports sampled APISIX and API7 Gateway request traces to OpenTelemetry Collectors over OTLP/HTTP for distributed tracing. - [OpenTelemetry](https://docs.api7.ai/hub/opentelemetry.md): The opentelemetry plugin exports sampled APISIX and API7 Gateway request traces to OpenTelemetry Collectors over OTLP/HTTP for distributed tracing. #### configuration Parameters - [OpenTelemetry](https://docs.api7.ai/hub/opentelemetry/configuration.md): Parameters ### prometheus The Prometheus plugin integrates with Prometheus for metric collection and continuous monitoring, enhancing API observability. - [Prometheus](https://docs.api7.ai/hub/prometheus.md): The Prometheus plugin integrates with Prometheus for metric collection and continuous monitoring, enhancing API observability. #### configuration Static Configurations - [Prometheus](https://docs.api7.ai/hub/prometheus/configuration.md): Static Configurations ### proxy-buffering The proxy-buffering plugin disables NGINX response buffering for selected routes so streaming upstream responses are forwarded without proxy-buffering delays. - [proxy-buffering](https://docs.api7.ai/hub/proxy-buffering.md): The proxy-buffering plugin disables NGINX response buffering for selected routes so streaming upstream responses are forwarded without proxy-buffering delays. #### configuration Parameters - [Proxy Buffering](https://docs.api7.ai/hub/proxy-buffering/configuration.md): Parameters ### proxy-cache The proxy-cache plugin caches HTTP responses in memory or on disk to reduce upstream traffic and supports conditional caching and cache purging. - [proxy-cache](https://docs.api7.ai/hub/proxy-cache.md): The proxy-cache plugin caches HTTP responses in memory or on disk to reduce upstream traffic and supports conditional caching and cache purging. #### configuration Static Configurations - [Proxy Cache](https://docs.api7.ai/hub/proxy-cache/configuration.md): Static Configurations ### proxy-mirror The proxy-mirror plugin copies all incoming requests or a sampled portion to a secondary upstream for inspection, testing, or analysis. - [proxy-mirror](https://docs.api7.ai/hub/proxy-mirror.md): The proxy-mirror plugin copies all incoming requests or a sampled portion to a secondary upstream for inspection, testing, or analysis. #### configuration Static Configurations - [Proxy Mirror](https://docs.api7.ai/hub/proxy-mirror/configuration.md): Static Configurations ### proxy-rewrite The proxy-rewrite plugin offers flexible options to rewrite requests that API gateway forwards to upstream services, enhancing API management. - [proxy-rewrite](https://docs.api7.ai/hub/proxy-rewrite.md): The proxy-rewrite plugin offers flexible options to rewrite requests that API gateway forwards to upstream services, enhancing API management. #### configuration Parameters - [Proxy Rewrite](https://docs.api7.ai/hub/proxy-rewrite/configuration.md): Parameters ### public-api The public-api plugin exposes internal API endpoints, allowing external access while maintaining control over API management and security. - [public-api](https://docs.api7.ai/hub/public-api.md): The public-api plugin exposes internal API endpoints, allowing external access while maintaining control over API management and security. #### configuration Parameters - [Public API](https://docs.api7.ai/hub/public-api/configuration.md): Parameters ### real-ip The real-ip plugin enables the API gateway to fetch the client's real IP using the IP address from the HTTP header or query string, improving data quality. - [real-ip](https://docs.api7.ai/hub/real-ip.md): The real-ip plugin enables the API gateway to fetch the client's real IP using the IP address from the HTTP header or query string, improving data quality. #### configuration Parameters - [Real IP](https://docs.api7.ai/hub/real-ip/configuration.md): Parameters ### request-id The request-id plugin adds a unique ID to each request proxied through the API gateway, facilitating effective tracking of API requests for better API management. - [request-id](https://docs.api7.ai/hub/request-id.md): The request-id plugin adds a unique ID to each request proxied through the API gateway, facilitating effective tracking of API requests for better API management. #### configuration Parameters - [Request ID](https://docs.api7.ai/hub/request-id/configuration.md): Parameters ### request-validation The request-validation plugin checks requests for compliance before forwarding them to upstream services, enhancing security in API operations. - [request-validation](https://docs.api7.ai/hub/request-validation.md): The request-validation plugin checks requests for compliance before forwarding them to upstream services, enhancing security in API operations. #### configuration Parameters - [Request Validation](https://docs.api7.ai/hub/request-validation/configuration.md): Parameters ### response-rewrite The response-rewrite plugin allows rewriting of responses from API gateway and upstream services, providing flexibility in API responses. - [response-rewrite](https://docs.api7.ai/hub/response-rewrite.md): The response-rewrite plugin allows rewriting of responses from API gateway and upstream services, providing flexibility in API responses. #### configuration Parameters - [Response Rewrite](https://docs.api7.ai/hub/response-rewrite/configuration.md): Parameters ### rocketmq-logger The rocketmq-logger plugin sends APISIX and API7 Gateway request and response logs to Apache RocketMQ in batches with customizable formats. - [rocketmq-logger](https://docs.api7.ai/hub/rocketmq-logger.md): The rocketmq-logger plugin sends APISIX and API7 Gateway request and response logs to Apache RocketMQ in batches with customizable formats. #### configuration Parameters - [RocketMQ Logger](https://docs.api7.ai/hub/rocketmq-logger/configuration.md): Parameters ### saml-auth The saml-auth plugin provides SAML 2.0 single sign-on and single logout for APISIX and API7 Gateway routes using identity providers such as Keycloak. - [saml-auth](https://docs.api7.ai/hub/saml-auth.md): The saml-auth plugin provides SAML 2.0 single sign-on and single logout for APISIX and API7 Gateway routes using identity providers such as Keycloak. #### configuration Parameters - [SAML Auth](https://docs.api7.ai/hub/saml-auth/configuration.md): Parameters ### serverless-functions The serverless function plugins (pre-function and post-function) allow execution of user-defined logic at the start or end of specified execution phases in API gateway. - [Serverless Functions](https://docs.api7.ai/hub/serverless-functions.md): The serverless function plugins (pre-function and post-function) allow execution of user-defined logic at the start or end of specified execution phases in API gateway. #### configuration Parameters - [Serverless Functions](https://docs.api7.ai/hub/serverless-functions/configuration.md): Parameters ### skywalking The skywalking plugin sends APISIX and API7 Gateway request traces to Apache SkyWalking for distributed tracing, request analysis, and trace-log correlation. - [SkyWalking](https://docs.api7.ai/hub/skywalking.md): The skywalking plugin sends APISIX and API7 Gateway request traces to Apache SkyWalking for distributed tracing, request analysis, and trace-log correlation. #### configuration Static Configurations - [skywalking](https://docs.api7.ai/hub/skywalking/configuration.md): Static Configurations ### skywalking-logger The skywalking-logger plugin sends customizable APISIX and API7 Gateway request and response logs to a SkyWalking OAP server in batches for analysis. - [skywalking-logger](https://docs.api7.ai/hub/skywalking-logger.md): The skywalking-logger plugin sends customizable APISIX and API7 Gateway request and response logs to a SkyWalking OAP server in batches for analysis. #### configuration Parameters - [SkyWalking Logger](https://docs.api7.ai/hub/skywalking-logger/configuration.md): Parameters ### soap The soap plugin converts JSON requests into SOAP operations from a WSDL definition and returns upstream SOAP responses as JSON. - [soap Enterprise](https://docs.api7.ai/hub/soap.md): The soap plugin converts JSON requests into SOAP operations from a WSDL definition and returns upstream SOAP responses as JSON. #### configuration Static Configurations - [SOAP](https://docs.api7.ai/hub/soap/configuration.md): Static Configurations ### splunk-hec-logging The splunk-hec-logging plugin sends request and response logs to Splunk HTTP Event Collector in batches and supports customizable log formats. - [splunk-hec-logging](https://docs.api7.ai/hub/splunk-hec-logging.md): The splunk-hec-logging plugin sends request and response logs to Splunk HTTP Event Collector in batches and supports customizable log formats. #### configuration Parameters - [splunk-hec-logging](https://docs.api7.ai/hub/splunk-hec-logging/configuration.md): Parameters ### syslog The syslog plugin sends request and response logs to syslog servers in batches and supports customizable log formats. - [syslog](https://docs.api7.ai/hub/syslog.md): The syslog plugin sends request and response logs to syslog servers in batches and supports customizable log formats. #### configuration Parameters - [syslog](https://docs.api7.ai/hub/syslog/configuration.md): Parameters ### traffic-label The traffic-label plugin evaluates request expressions and applies weighted request-header changes for conditional traffic management. - [traffic-label](https://docs.api7.ai/hub/traffic-label.md): The traffic-label plugin evaluates request expressions and applies weighted request-header changes for conditional traffic management. #### configuration Parameters - [Traffic Label](https://docs.api7.ai/hub/traffic-label/configuration.md): Parameters ### traffic-split The traffic-split plugin directs traffic to multiple upstream services based on conditions or weights, providing a flexible approach for API release strategies and traffic management. - [traffic-split](https://docs.api7.ai/hub/traffic-split.md): The traffic-split plugin directs traffic to multiple upstream services based on conditions or weights, providing a flexible approach for API release strategies and traffic management. #### configuration Parameters - [Traffic Split](https://docs.api7.ai/hub/traffic-split/configuration.md): Parameters ### ua-restriction The ua-restriction plugin restricts access to upstream resources using an allowlist or denylist of user agents, preventing overload from web crawlers and enhancing API security. - [ua-restriction](https://docs.api7.ai/hub/ua-restriction.md): The ua-restriction plugin restricts access to upstream resources using an allowlist or denylist of user agents, preventing overload from web crawlers and enhancing API security. #### configuration Parameters - [UA Restriction](https://docs.api7.ai/hub/ua-restriction/configuration.md): Parameters ### workflow The workflow plugin enables conditional execution of user-defined actions on client traffic based on specific rules, allowing granular API traffic management. - [workflow](https://docs.api7.ai/hub/workflow.md): The workflow plugin enables conditional execution of user-defined actions on client traffic based on specific rules, allowing granular API traffic management. #### configuration Parameters - [Workflow](https://docs.api7.ai/hub/workflow/configuration.md): Parameters ### zipkin The zipkin plugin instruments the API gateway to send traces to Zipkin or compatible collectors like Jaeger and Apache SkyWalking, enhancing request tracing capabilities. - [zipkin](https://docs.api7.ai/hub/zipkin.md): The zipkin plugin instruments the API gateway to send traces to Zipkin or compatible collectors like Jaeger and Apache SkyWalking, enhancing request tracing capabilities. #### configuration Static Configurations - [Zipkin](https://docs.api7.ai/hub/zipkin/configuration.md): Static Configurations ## ingress-controller ### apply-plugins-to-l4-routes Learn how to attach APISIX stream plugins to Gateway API TCPRoute, UDPRoute, and TLSRoute resources by configuring and verifying an L4RoutePolicy. - [Apply Plugins to L4 Routes](https://docs.api7.ai/ingress-controller/apply-plugins-to-l4-routes.md): Learn how to attach APISIX stream plugins to Gateway API TCPRoute, UDPRoute, and TLSRoute resources by configuring and verifying an L4RoutePolicy. ### canary-releases Plan canary releases with APISIX or API7 Ingress Controller by coordinating workloads, weighted routes, analysis, promotion, and rollback. - [Canary Releases](https://docs.api7.ai/ingress-controller/canary-releases.md): Plan canary releases with APISIX or API7 Ingress Controller by coordinating workloads, weighted routes, analysis, promotion, and rollback. #### argo-rollouts Configure Argo Rollouts to shift APISIX or API7 Gateway traffic with HTTPRoute or ApisixRoute, then promote, analyze, and abort releases. - [Canary Releases with Argo Rollouts](https://docs.api7.ai/ingress-controller/canary-releases/argo-rollouts.md): Configure Argo Rollouts to shift APISIX or API7 Gateway traffic with HTTPRoute or ApisixRoute, then promote, analyze, and abort releases. #### flagger Use Flagger and APISIX metrics to automate canary analysis, promotion, and rollback through Gateway API HTTPRoute or ApisixRoute resources. - [Automated Canary Releases with Flagger](https://docs.api7.ai/ingress-controller/canary-releases/flagger.md): Use Flagger and APISIX metrics to automate canary analysis, promotion, and rollback through Gateway API HTTPRoute or ApisixRoute resources. ### common-use-cases Explore common use cases enabled by the gateway’s plugin ecosystem and learn how to configure these plugins using the Ingress Controller. - [Common Use Cases](https://docs.api7.ai/ingress-controller/common-use-cases.md): Explore common use cases enabled by the gateway’s plugin ecosystem and learn how to configure these plugins using the Ingress Controller. ### configure-upstream-health-checks Configure active and passive upstream health checks with APISIX or API7 Ingress Controller, then verify failure and recovery. - [Configure Upstream Health Checks](https://docs.api7.ai/ingress-controller/configure-upstream-health-checks.md): Configure active and passive upstream health checks with APISIX or API7 Ingress Controller, then verify failure and recovery. ### custom-plugins #### lua Load a custom Lua plugin into APISIX or API7 Gateway on Kubernetes, apply it with the Ingress Controller, and verify its response. - [Deploy Lua Custom Plugins](https://docs.api7.ai/ingress-controller/custom-plugins/lua.md): Load a custom Lua plugin into APISIX or API7 Gateway on Kubernetes, apply it with the Ingress Controller, and verify its response. #### wasm Learn how to load Wasm custom plugins into gateways in a Kubernetes environment and apply them to routes using APISIX Ingress Controller. - [Deploy Wasm Plugins](https://docs.api7.ai/ingress-controller/custom-plugins/wasm.md): Learn how to load Wasm custom plugins into gateways in a Kubernetes environment and apply them to routes using APISIX Ingress Controller. ### detect-upstream-protocol-appprotocol Learn how to use APISIX or API7 Ingress Controller to automatically configure upstream protocols based on the values of appProtocol. - [Detect Upstream Protocol with appProtocol](https://docs.api7.ai/ingress-controller/detect-upstream-protocol-appprotocol.md): Learn how to use APISIX or API7 Ingress Controller to automatically configure upstream protocols based on the values of appProtocol. ### documentation Explore API7 and APISIX Ingress Controller docs, covering installation, how-tos, troubleshooting, and reference for dynamic traffic routing via Ingress, Gateway API, and APISIX CRDs. - [Ingress Controller Documentation](https://docs.api7.ai/ingress-controller/documentation.md): Explore API7 and APISIX Ingress Controller docs, covering installation, how-tos, troubleshooting, and reference for dynamic traffic routing via Ingress, Gateway API, and APISIX CRDs. ### high-availability Configure APISIX or API7 Ingress Controller replicas, placement, leader election, and failover validation for a highly available deployment. - [High Availability](https://docs.api7.ai/ingress-controller/high-availability.md): Configure APISIX or API7 Ingress Controller replicas, placement, leader election, and failover validation for a highly available deployment. ### installation #### gitops Plan a GitOps deployment of APISIX or API7 Ingress Controller, including repository structure, resource ownership, CRDs, and credentials. - [Prepare for GitOps](https://docs.api7.ai/ingress-controller/installation/gitops.md): Plan a GitOps deployment of APISIX or API7 Ingress Controller, including repository structure, resource ownership, CRDs, and credentials. - [Manage with Argo CD](https://docs.api7.ai/ingress-controller/installation/gitops/argo-cd.md): Install APISIX or API7 Ingress Controller with Argo CD using stable webhook certificates, explicit CRD ownership, and safe reconciliation. - [Manage with Flux](https://docs.api7.ai/ingress-controller/installation/gitops/flux.md): Install APISIX or API7 Ingress Controller with Flux using HelmRelease resources, explicit CRD policies, drift detection, and verification. #### openshift Learn how to install API7 Ingress Controller on an OpenShift cluster, including prerequisites, configuration, and verification steps. - [Install API7 Ingress Controller on OpenShift](https://docs.api7.ai/ingress-controller/installation/openshift.md): Learn how to install API7 Ingress Controller on an OpenShift cluster, including prerequisites, configuration, and verification steps. ### production #### cross-namespace Configure secure cross-namespace references for Routes, backends, TLS Secrets, and Consumer credentials with APISIX or API7 Ingress Controller. - [Configure Cross-Namespace References](https://docs.api7.ai/ingress-controller/production/cross-namespace.md): Configure secure cross-namespace references for Routes, backends, TLS Secrets, and Consumer credentials with APISIX or API7 Ingress Controller. #### gateway-api-access-control Delegate Gateway API resource management safely between platform and application teams with Kubernetes RBAC for APISIX or API7 Ingress Controller. - [Delegate Gateway API Access with Kubernetes RBAC](https://docs.api7.ai/ingress-controller/production/gateway-api-access-control.md): Delegate Gateway API resource management safely between platform and application teams with Kubernetes RBAC for APISIX or API7 Ingress Controller. #### upgrade Upgrade APISIX Ingress Controller from 2.1.0 to 2.2.0 or API7 Ingress Controller from 2.1.0 or 2.2.0 to 2.2.1. - [Upgrade Ingress Controller](https://docs.api7.ai/ingress-controller/production/upgrade.md): Upgrade APISIX Ingress Controller from 2.1.0 to 2.2.0 or API7 Ingress Controller from 2.1.0 or 2.2.0 to 2.2.1. ### proxy-grpc-traffic Learn how to use APISIX or API7 Ingress Controller to configure routes to proxy gRPC traffic. - [Proxy gRPC Traffic](https://docs.api7.ai/ingress-controller/proxy-grpc-traffic.md): Learn how to use APISIX or API7 Ingress Controller to configure routes to proxy gRPC traffic. ### proxy-requests-to-a-service Deploy a sample HTTP service, configure an Ingress, Gateway API, or APISIX route with the Ingress Controller, and verify traffic through the gateway. - [Proxy Requests to a Service](https://docs.api7.ai/ingress-controller/proxy-requests-to-a-service.md): Deploy a sample HTTP service, configure an Ingress, Gateway API, or APISIX route with the Ingress Controller, and verify traffic through the gateway. ### proxy-tcp-traffic Learn how to configure APISIX or API7 Ingress Controller to proxy TCP traffic by port. - [Proxy TCP Traffic by Port](https://docs.api7.ai/ingress-controller/proxy-tcp-traffic.md): Learn how to configure APISIX or API7 Ingress Controller to proxy TCP traffic by port. ### proxy-tcp-traffic-over-tls Learn how to use APISIX or API7 Ingress Controller to configure routes to proxy TCP traffic over TLS by SNI. - [Proxy TCP Traffic over TLS by SNI](https://docs.api7.ai/ingress-controller/proxy-tcp-traffic-over-tls.md): Learn how to use APISIX or API7 Ingress Controller to configure routes to proxy TCP traffic over TLS by SNI. ### proxy-to-external-services Learn how to configure APISIX or API7 Ingress Controller to proxy requests to external services hosted outside your Kubernetes cluster. - [Proxy Requests to External Services](https://docs.api7.ai/ingress-controller/proxy-to-external-services.md): Learn how to configure APISIX or API7 Ingress Controller to proxy requests to external services hosted outside your Kubernetes cluster. ### proxy-to-weighted-backends Learn how to configure weighted routing to distribute traffic across multiple upstream services using APISIX or API7 Ingress Controller. - [Proxy Requests to Weighted Backends](https://docs.api7.ai/ingress-controller/proxy-to-weighted-backends.md): Learn how to configure weighted routing to distribute traffic across multiple upstream services using APISIX or API7 Ingress Controller. ### proxy-udp-traffic Learn how to configure APISIX or API7 Ingress Controller to proxy UDP traffic by port. - [Proxy UDP Traffic by Port](https://docs.api7.ai/ingress-controller/proxy-udp-traffic.md): Learn how to configure APISIX or API7 Ingress Controller to proxy UDP traffic by port. ### proxy-websocket-connection Configure APISIX or API7 Ingress Controller to proxy WebSocket connections with HTTPRoute or ApisixRoute resources. - [Proxy WebSocket Connections](https://docs.api7.ai/ingress-controller/proxy-websocket-connection.md): Configure APISIX or API7 Ingress Controller to proxy WebSocket connections with HTTPRoute or ApisixRoute resources. ### reference #### annotations Learn how annotations extend the functionality of Kubernetes Ingress and IngressClass resource in the Ingress Controller to configure routing, security, and gateway behaviors. - [Annotations](https://docs.api7.ai/ingress-controller/reference/annotations.md): Learn how annotations extend the functionality of Kubernetes Ingress and IngressClass resource in the Ingress Controller to configure routing, security, and gateway behaviors. #### configuration-file Configure APISIX or API7 Ingress Controller logging, leader election, metrics, synchronization, Gateway API, and webhook settings. - [Configuration File](https://docs.api7.ai/ingress-controller/reference/configuration-file.md): Configure APISIX or API7 Ingress Controller logging, leader election, metrics, synchronization, Gateway API, and webhook settings. #### crd-reference Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the Ingress Controller. - [Custom Resource Definitions API Reference](https://docs.api7.ai/ingress-controller/reference/crd-reference.md): Explore detailed reference documentation for the custom resource definitions (CRDs) supported by the Ingress Controller. #### examples Discover various examples showcasing the Ingress Controller resource configurations to help you effectively tailor settings for your environment. - [Configuration Examples](https://docs.api7.ai/ingress-controller/reference/examples.md): Discover various examples showcasing the Ingress Controller resource configurations to help you effectively tailor settings for your environment. #### helm-charts Learn about the Helm charts for deploying APISIX and API7 Ingress Controllers, including how they function and references for configurable chart values. - [Helm Charts](https://docs.api7.ai/ingress-controller/reference/helm-charts.md): Learn about the Helm charts for deploying APISIX and API7 Ingress Controllers, including how they function and references for configurable chart values. #### ingress-and-gateway-api-support Learn about the Gateway API and Ingress resources supported by the Ingress Controller and their current capabilities. - [Ingress and Gateway API Support](https://docs.api7.ai/ingress-controller/reference/ingress-and-gateway-api-support.md): Learn about the Gateway API and Ingress resources supported by the Ingress Controller and their current capabilities. ### release-notes Review shared and product-specific changes, upgrade requirements, compatibility, and important fixes for APISIX and API7 Ingress Controller releases. - [Release Notes](https://docs.api7.ai/ingress-controller/release-notes.md): Review shared and product-specific changes, upgrade requirements, compatibility, and important fixes for APISIX and API7 Ingress Controller releases. ### set-up-ingress-controller-and-gateway Deploy API7 Ingress Controller or APISIX Ingress Controller with a gateway on Kubernetes, verify the installation, and prepare to route traffic. - [Set Up Ingress Controller and Gateway](https://docs.api7.ai/ingress-controller/set-up-ingress-controller-and-gateway.md): Deploy API7 Ingress Controller or APISIX Ingress Controller with a gateway on Kubernetes, verify the installation, and prepare to route traffic. ### tls-and-mtls #### configure-downstream-https Learn how to use APISIX or API7 Ingress Controller to configure the gateway to accept HTTPS traffic from clients. - [Configure HTTPS Between Client and Gateway](https://docs.api7.ai/ingress-controller/tls-and-mtls/configure-downstream-https.md): Learn how to use APISIX or API7 Ingress Controller to configure the gateway to accept HTTPS traffic from clients. #### configure-downstream-mtls Learn how to use APISIX or API7 Ingress Controller to configure the gateway to require mutual TLS (mTLS) from clients. - [Configure mTLS Between Client and Gateway](https://docs.api7.ai/ingress-controller/tls-and-mtls/configure-downstream-mtls.md): Learn how to use APISIX or API7 Ingress Controller to configure the gateway to require mutual TLS (mTLS) from clients. #### configure-upstream-mtls Learn how to use APISIX or API7 Ingress Controller to configure the gateway to forward traffic to upstream services over mutual TLS (mTLS). - [Configure mTLS Between Gateway and Upstream](https://docs.api7.ai/ingress-controller/tls-and-mtls/configure-upstream-mtls.md): Learn how to use APISIX or API7 Ingress Controller to configure the gateway to forward traffic to upstream services over mutual TLS (mTLS). #### proxy-to-https-upstream Learn how to use APISIX or API7 Ingress Controller to configure the gateway to forward traffic to upstream services over HTTPS. - [Proxy Requests to HTTPS Upstream Services](https://docs.api7.ai/ingress-controller/tls-and-mtls/proxy-to-https-upstream.md): Learn how to use APISIX or API7 Ingress Controller to configure the gateway to forward traffic to upstream services over HTTPS. ### troubleshooting #### admission-webhook Learn about the admission webhook, the error and warning messages it may return when applying Ingress Controller resources, and how to resolve them. - [Understand the Admission Webhook](https://docs.api7.ai/ingress-controller/troubleshooting/admission-webhook.md): Learn about the admission webhook, the error and warning messages it may return when applying Ingress Controller resources, and how to resolve them. #### common-issues Learn how to identify and resolve common issues in APISIX or API7 Ingress Controller with practical guidance for effective troubleshooting. - [Common Issues and Solutions](https://docs.api7.ai/ingress-controller/troubleshooting/common-issues.md): Learn how to identify and resolve common issues in APISIX or API7 Ingress Controller with practical guidance for effective troubleshooting. #### configuration-synchronization Learn how to inspect and troubleshoot configuration translation and synchronization in APISIX or API7 Ingress Controller. - [Troubleshoot Manifest Translation and Synchronization](https://docs.api7.ai/ingress-controller/troubleshooting/configuration-synchronization.md): Learn how to inspect and troubleshoot configuration translation and synchronization in APISIX or API7 Ingress Controller. #### gateway-debug-mode Learn how to enable gateway debug mode in a Kubernetes environment to troubleshoot and monitor the gateway’s runtime behavior effectively. - [Enable Gateway Debug Mode](https://docs.api7.ai/ingress-controller/troubleshooting/gateway-debug-mode.md): Learn how to enable gateway debug mode in a Kubernetes environment to troubleshoot and monitor the gateway’s runtime behavior effectively.