# API7 Docs > Official documentation for AISIX AI Gateway, AISIX Cloud, Apache APISIX, API7 Gateway, API7 and APISIX Ingress Controllers, and gateway plugins. ## ai-gateway Route AI requests through a dedicated gateway layer with centralized provider keys, model aliases, routing, and traffic policy. - [AISIX AI Gateway](https://docs.api7.ai/ai-gateway.md): Route AI requests through a dedicated gateway layer with centralized provider keys, model aliases, routing, and traffic policy. ### reference #### 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. #### 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 AI Gateway environment variables used for configuration files, startup overrides, AISIX gateways, and runtime tuning. - [Environment Variables](https://docs.api7.ai/ai-gateway/reference/environment-variables.md): Reference for AISIX AI Gateway environment variables used for configuration files, startup overrides, AISIX gateways, 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. #### metrics Reference for Prometheus metrics exposed by AISIX AI Gateway. - [Metrics Reference](https://docs.api7.ai/ai-gateway/reference/metrics.md): Reference for Prometheus metrics exposed by AISIX AI Gateway. #### on-premises-configuration Reference for Docker Compose environment variables and Helm values used to run the AISIX Cloud control plane in your infrastructure. - [On-Premises Configuration](https://docs.api7.ai/ai-gateway/reference/on-premises-configuration.md): Reference for Docker Compose environment variables and Helm values used to run the AISIX Cloud control plane in your infrastructure. #### ports Reference for default AISIX gateway and AISIX Cloud 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 AISIX Cloud 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 AISIX AI 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 AISIX AI Gateway with resources.yaml using this reference for supported collections, fields, environment interpolation, and validation rules. ### agent-gateway #### agent-access-control Scope each caller API key to the A2A agents it may reach in AISIX AI Gateway, using exact agent names or a wildcard. Access is denied by default. - [Control Agent Access](https://docs.api7.ai/ai-gateway/agent-gateway/agent-access-control.md): Scope each caller API key to the A2A agents it may reach in AISIX AI Gateway, using exact agent names or a wildcard. Access is denied by default. #### observability Read the usage events and Prometheus metrics that A2A agent calls emit in AISIX AI 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 AISIX AI Gateway, tagged so you can isolate A2A traffic from model traffic. #### overview Expose upstream agents that use the Agent-to-Agent protocol through AISIX AI Gateway with caller API key access control, upstream authentication, rate limits, budgets, and telemetry. - [Agent Gateway Overview](https://docs.api7.ai/ai-gateway/agent-gateway/overview.md): Expose upstream agents that use the Agent-to-Agent protocol through AISIX AI Gateway with caller API key access control, upstream authentication, rate limits, budgets, and telemetry. #### traffic-controls Apply caller API key rate limits and budgets to A2A agent calls in AISIX AI Gateway, using the same controls that govern model traffic. - [Rate Limits and Budgets](https://docs.api7.ai/ai-gateway/agent-gateway/traffic-controls.md): Apply caller API key rate limits and budgets to A2A agent calls in AISIX AI Gateway, using the same controls that govern model traffic. #### upstream-authentication Configure how AISIX AI Gateway authenticates to each upstream A2A agent with no credential, a bearer token, or an API key. The credential is held gateway-side and never reaches the caller. - [Upstream Authentication](https://docs.api7.ai/ai-gateway/agent-gateway/upstream-authentication.md): Configure how AISIX AI Gateway authenticates to each upstream A2A agent with no credential, a bearer token, or an API key. The credential is held gateway-side and never reaches the caller. ### cloud #### admin-tokens Create and manage AISIX Cloud admin tokens for organization-level automation, including scopes, expiration, rotation, revocation, and SCIM access. - [Admin Tokens](https://docs.api7.ai/ai-gateway/cloud/admin-tokens.md): Create and manage AISIX Cloud admin tokens for organization-level automation, including scopes, expiration, rotation, revocation, and SCIM access. #### connect-a-gateway Add an AISIX gateway as the data plane for an AISIX Cloud environment with dashboard-issued mTLS credentials, deployment snippets, and connection verification. - [Connect an AISIX Gateway](https://docs.api7.ai/ai-gateway/cloud/connect-a-gateway.md): Add an AISIX gateway as the data plane for an AISIX Cloud environment with dashboard-issued mTLS credentials, deployment snippets, and connection verification. #### custom-roles Understand the built-in owner, admin, and member roles, and define org-scoped custom roles with fine-grained read/write permissions in the AISIX Cloud control plane. - [Roles and Custom Roles](https://docs.api7.ai/ai-gateway/cloud/custom-roles.md): Understand the built-in owner, admin, and member roles, and define org-scoped custom roles with fine-grained read/write permissions in the AISIX Cloud control plane. #### high-availability Design a highly available 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 Cloud traffic path with redundant AISIX gateways, resilient control-plane connectivity, and upstream failover. #### kubernetes Deploy and scale AISIX gateways as AISIX Cloud data planes on Kubernetes using the api7/aisix Helm chart, a HorizontalPodAutoscaler, or KEDA. - [Deploy AISIX Gateways on Kubernetes](https://docs.api7.ai/ai-gateway/cloud/kubernetes.md): Deploy and scale AISIX gateways as AISIX Cloud data planes on Kubernetes using the api7/aisix Helm chart, a HorizontalPodAutoscaler, or KEDA. #### logging-and-auditing Understand how the AISIX Cloud control plane records gateway requests and resource changes. - [Logging and Auditing](https://docs.api7.ai/ai-gateway/cloud/logging-and-auditing.md): Understand how the AISIX Cloud control plane records gateway requests and resource changes. #### members Add organization members for AISIX Cloud control-plane access or API key ownership. - [Members](https://docs.api7.ai/ai-gateway/cloud/members.md): Add organization members for AISIX Cloud control-plane access or API key ownership. #### model-pricing Understand how the AISIX Cloud control plane derives 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 the AISIX Cloud control plane derives per-request cost, and set prices for models the catalog does not cover. #### offline-resilience Understand AISIX gateway behavior during temporary control-plane connectivity loss. - [Offline Resilience](https://docs.api7.ai/ai-gateway/cloud/offline-resilience.md): Understand AISIX gateway behavior during temporary control-plane connectivity loss. #### organizations-and-environments Create and understand AISIX Cloud organizations and environments, including how environment resources reach connected AISIX gateways. - [Organizations and Environments](https://docs.api7.ai/ai-gateway/cloud/organizations-and-environments.md): Create and understand AISIX Cloud organizations and environments, including how environment resources reach connected AISIX gateways. #### overview Learn how AISIX Cloud adds centralized management while AISIX gateways serve AI traffic directly in your environment. - [AISIX Cloud](https://docs.api7.ai/ai-gateway/cloud/overview.md): Learn how AISIX Cloud adds centralized management while AISIX gateways serve AI traffic directly in your environment. #### playground Understand what AISIX Cloud playground requests can validate compared with gateway requests. - [Playground](https://docs.api7.ai/ai-gateway/cloud/playground.md): Understand what AISIX Cloud playground requests can validate compared with gateway requests. #### resource-projection Understand how AISIX Cloud projects 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 Cloud projects environment resources, then verify publication, gateway application, and caller-visible behavior. #### scim-directory-sync Provision AISIX organization members automatically from your identity provider with SCIM 2.0. - [SCIM Directory Sync](https://docs.api7.ai/ai-gateway/cloud/scim-directory-sync.md): Provision AISIX organization members automatically from your identity provider with SCIM 2.0. #### usage-reporting Understand how the AISIX Cloud control plane reports gateway usage, spend, and budget-related signals. - [Usage Reporting](https://docs.api7.ai/ai-gateway/cloud/usage-reporting.md): Understand how the AISIX Cloud control plane reports 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. #### 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 AI Gateway 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 AI Gateway with correct listener exposure, configuration-source isolation, and credential handling. #### performance-and-sizing Expected AISIX AI 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 AI Gateway proxy overhead and throughput, and how to size CPU for your request volume. #### production Prepare AISIX AI Gateway for production traffic by planning capacity, dependencies, network exposure, health checks, recovery, and shutdown. - [Production Readiness](https://docs.api7.ai/ai-gateway/deployment/production.md): Prepare AISIX AI Gateway for production traffic by planning capacity, dependencies, network exposure, health checks, recovery, and shutdown. #### startup-configuration Configure AISIX AI Gateway startup settings, including its resource source, listeners, runtime dependencies, observability, and AISIX Cloud connection. - [Startup Configuration](https://docs.api7.ai/ai-gateway/deployment/startup-configuration.md): Configure AISIX AI Gateway startup settings, including its resource source, listeners, runtime dependencies, observability, and AISIX Cloud connection. #### thread-per-core-workers Configure AISIX AI 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 AI 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 AISIX Cloud control-plane mTLS for AISIX AI Gateway. - [TLS and mTLS](https://docs.api7.ai/ai-gateway/deployment/tls-and-mtls.md): Configure listener TLS, upstream trust, etcd mTLS, and AISIX Cloud control-plane mTLS for AISIX AI Gateway. #### troubleshooting Diagnose startup, configuration, caller access, policy, upstream, and AISIX gateway failures in AISIX AI Gateway. - [Troubleshooting](https://docs.api7.ai/ai-gateway/deployment/troubleshooting.md): Diagnose startup, configuration, caller access, policy, upstream, and AISIX gateway failures in AISIX AI Gateway. #### url-rewriting Map legacy or external URL shapes onto AISIX AI 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 AI Gateway endpoints with entry-level rewrite rules, so existing clients migrate without configuration changes. ### endpoints #### anthropic-messages Understand how AISIX AI 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 AISIX AI Gateway handles Anthropic-style Messages requests, including caller keys, model aliases, upstream translation, token counting, and errors. #### audio Learn how AISIX AI Gateway handles OpenAI-style audio transcription, translation, and speech endpoints. - [Speech and Audio](https://docs.api7.ai/ai-gateway/endpoints/audio.md): Learn how AISIX AI 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 AISIX AI 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 AISIX AI Gateway, with gateway-managed provider routing and batch usage attribution. #### embeddings Learn how AISIX AI 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 AISIX AI Gateway handles the OpenAI-compatible embeddings endpoint, including request format and provider limits. #### image-generation Learn how AISIX AI Gateway handles the OpenAI image generation endpoint and provider support. - [Image Generation](https://docs.api7.ai/ai-gateway/endpoints/image-generation.md): Learn how AISIX AI 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 AISIX AI Gateway handles OpenAI-compatible requests, including caller keys, model aliases, route support, and error handling. - [OpenAI-Compatible API](https://docs.api7.ai/ai-gateway/endpoints/openai-compatible-chat.md): Understand how AISIX AI Gateway handles OpenAI-compatible requests, including caller keys, model aliases, route support, and error handling. #### overview See the caller-facing endpoint families AISIX exposes on the proxy listener. - [Supported Endpoints](https://docs.api7.ai/ai-gateway/endpoints/overview.md): See the caller-facing endpoint families AISIX exposes on the proxy listener. #### provider-passthrough Forward provider-native requests through AISIX AI Gateway without endpoint translation, and understand identifiers, credentials, limits, and errors. - [Provider Passthrough](https://docs.api7.ai/ai-gateway/endpoints/provider-passthrough.md): Forward provider-native requests through AISIX AI Gateway without endpoint translation, and understand identifiers, credentials, limits, and errors. #### realtime Connect OpenAI Realtime WebSocket clients through AISIX AI 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 AISIX AI 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 AISIX AI Gateway proxies rerank requests through supported rerank providers. - [Rerank](https://docs.api7.ai/ai-gateway/endpoints/rerank.md): Learn how AISIX AI Gateway proxies rerank requests through supported rerank providers. #### responses-api Learn how AISIX AI Gateway handles the OpenAI Responses API and provider support. - [Responses API](https://docs.api7.ai/ai-gateway/endpoints/responses-api.md): Learn how AISIX AI Gateway handles the OpenAI Responses API and provider support. #### streaming Understand streaming behavior on AISIX AI Gateway, including OpenAI-style and Anthropic-style streaming paths. - [Streaming](https://docs.api7.ai/ai-gateway/endpoints/streaming.md): Understand streaming behavior on AISIX AI Gateway, including OpenAI-style and Anthropic-style streaming paths. #### text-completions Learn how AISIX AI Gateway handles OpenAI-compatible text-completions requests. - [Text Completions](https://docs.api7.ai/ai-gateway/endpoints/text-completions.md): Learn how AISIX AI Gateway handles OpenAI-compatible text-completions requests. #### tool-calling Understand tool-calling behavior on AISIX AI 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 AISIX AI Gateway, including OpenAI-compatible requests and Anthropic translation. #### video-generation Generate videos through the AISIX AI 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 AI Gateway /v1/videos endpoint with asynchronous task submission, status polling, and video download. ### getting-started #### aisix-cloud-quickstart Deploy the AISIX Cloud control plane with Docker Compose, configure a model, and send your first request through an attached AISIX gateway. - [AISIX Cloud Quickstart](https://docs.api7.ai/ai-gateway/getting-started/aisix-cloud-quickstart.md): Deploy the AISIX Cloud control plane 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 AISIX AI 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 AISIX AI Gateway through the /v1/messages proxy API. #### gateway-quickstart Run an open-source AISIX gateway in one container, declare provider keys, models, and caller API keys in a resources.yaml file, and send your first request. - [Open-Source AISIX Gateway Quickstart](https://docs.api7.ai/ai-gateway/getting-started/gateway-quickstart.md): Run an open-source AISIX gateway 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 AISIX AI 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 AISIX AI Gateway through the OpenAI-compatible proxy API. #### products-and-deployment-options Compare the open-source AISIX gateway with the On-Premises and Hybrid Cloud control-plane deployment options for AISIX Cloud. - [AISIX Products and Deployment Options](https://docs.api7.ai/ai-gateway/getting-started/products-and-deployment-options.md): Compare the open-source AISIX gateway with the On-Premises and Hybrid Cloud control-plane deployment options for AISIX Cloud. ### integrations Connect coding agents, application frameworks, and AI libraries to AISIX AI Gateway. - [Integrations](https://docs.api7.ai/ai-gateway/integrations.md): Connect coding agents, application frameworks, and AI libraries to AISIX AI Gateway. #### coding-agents Connect coding agents and AI coding tools to AISIX AI Gateway for governed model and tool traffic. - [Coding Agents](https://docs.api7.ai/ai-gateway/integrations/coding-agents.md): Connect coding agents and AI coding tools to AISIX AI Gateway for governed model and tool traffic. - [Claude Code](https://docs.api7.ai/ai-gateway/integrations/coding-agents/claude-code.md): Configure Claude Code to send Anthropic Messages traffic through AISIX AI Gateway. - [Cline](https://docs.api7.ai/ai-gateway/integrations/coding-agents/cline.md): Configure Cline to send OpenAI-compatible model traffic through AISIX AI Gateway. - [Codex](https://docs.api7.ai/ai-gateway/integrations/coding-agents/codex.md): Configure Codex to send Responses API traffic through AISIX AI Gateway. - [Cursor](https://docs.api7.ai/ai-gateway/integrations/coding-agents/cursor.md): Configure Cursor to send OpenAI-compatible chat traffic through AISIX AI Gateway. #### frameworks - [CrewAI](https://docs.api7.ai/ai-gateway/integrations/frameworks/crewai.md): Configure CrewAI to send OpenAI-compatible chat traffic through AISIX AI Gateway. - [Haystack](https://docs.api7.ai/ai-gateway/integrations/frameworks/haystack.md): Configure Haystack to send OpenAI Responses API traffic through AISIX AI Gateway. - [Instructor](https://docs.api7.ai/ai-gateway/integrations/frameworks/instructor.md): Configure Instructor to send OpenAI Responses API structured-output requests through AISIX AI 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 AISIX AI Gateway. - [LlamaIndex](https://docs.api7.ai/ai-gateway/integrations/frameworks/llamaindex.md): Configure LlamaIndex to send OpenAI Responses API traffic through AISIX AI 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 AISIX AI 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 AISIX AI Gateway. - [Pydantic AI](https://docs.api7.ai/ai-gateway/integrations/frameworks/pydantic-ai.md): Configure Pydantic AI to send OpenAI Responses API traffic through AISIX AI 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 AISIX AI Gateway. ### mcp-gateway #### access-policies Manage MCP tool access across AISIX Cloud environments and teams, then let caller API keys inherit, narrow, or reject shared policy grants. - [Manage MCP Access with Policies](https://docs.api7.ai/ai-gateway/mcp-gateway/access-policies.md): Manage MCP tool access across AISIX Cloud environments and teams, then let caller API keys inherit, narrow, or reject shared policy grants. #### guardrails Inspect MCP tool-call arguments and tool results with the same guardrails that govern model traffic in AISIX AI Gateway, and block a call before it reaches the upstream server. - [Guardrails](https://docs.api7.ai/ai-gateway/mcp-gateway/guardrails.md): Inspect MCP tool-call arguments and tool results with the same guardrails that govern model traffic in AISIX AI Gateway, and block a call before it reaches the upstream server. #### observability Read the usage events and Prometheus metrics that MCP tool calls emit in AISIX AI Gateway, tagged so you can isolate MCP traffic from model traffic. - [Observability](https://docs.api7.ai/ai-gateway/mcp-gateway/observability.md): Read the usage events and Prometheus metrics that MCP tool calls emit in AISIX AI Gateway, tagged so you can isolate MCP traffic from model traffic. #### openapi-servers Register a REST API with its OpenAPI document so AISIX AI 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 AISIX AI Gateway generates MCP tools from its operations and executes tool calls as HTTP requests. #### overview Expose upstream MCP servers through AISIX AI Gateway with caller API key access control, upstream authentication, guardrails, and telemetry. - [MCP Gateway Overview](https://docs.api7.ai/ai-gateway/mcp-gateway/overview.md): Expose upstream MCP servers through AISIX AI Gateway with caller API key access control, upstream authentication, guardrails, and telemetry. #### server-review Review MCP server registrations and changes in 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 Cloud before publishing them to gateways, and revoke approvals that no longer hold. #### setup Register an upstream MCP server in AISIX Cloud or 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 Cloud or 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 AISIX AI 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 AISIX AI Gateway, using exact names, per-server wildcards, or a global wildcard. #### traffic-controls Configure MCP request and concurrency limits in AISIX AI Gateway, plus AISIX Cloud budgets, 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 AISIX AI Gateway, plus AISIX Cloud budgets, using the caller API key boundary. #### upstream-authentication Configure how AISIX AI 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 AISIX AI Gateway authenticates to each upstream MCP server with no credential, a bearer token, an API key, or OAuth 2.0 client credentials. ### 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 gateway deployments with in-place and gradual workflows that keep caller API keys and model aliases stable. - [Provider Key Rotation](https://docs.api7.ai/ai-gateway/models/provider-key-rotation.md): Rotate upstream provider credentials across AISIX gateway deployments with in-place and gradual workflows that keep caller API keys and model aliases 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. #### 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 Configure AISIX gateways to inject request-context headers and forward approved client headers to AI providers while protecting reserved headers. - [Upstream Request Headers](https://docs.api7.ai/ai-gateway/models/upstream-request-headers.md): Configure AISIX gateways to inject request-context headers and forward approved client headers to AI providers while protecting reserved headers. ### observability #### 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. #### metrics-and-logs Monitor AISIX gateway traffic with Prometheus metrics, structured access logs, response headers, and exportable per-attempt usage events. - [Metrics and Logs](https://docs.api7.ai/ai-gateway/observability/metrics-and-logs.md): Monitor AISIX gateway traffic with Prometheus metrics, structured access logs, response headers, and exportable per-attempt usage events. ### on-premises #### deployment Plan production resources and install the AISIX Cloud control plane in your infrastructure with Docker Compose, Helm, or an offline package. - [On-Premises Installation](https://docs.api7.ai/ai-gateway/on-premises/deployment.md): Plan production resources and install the AISIX Cloud control plane in your infrastructure with Docker Compose, Helm, or an offline package. #### external-database Provision external PostgreSQL and a least-privilege role for an AISIX Cloud control plane 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 an AISIX Cloud control plane installed with Helm, without granting superuser access. ### 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 gateway deployments. Configure account-scoped endpoints, API credentials, @cf model IDs, aliases, and caller access. - [Cloudflare Workers AI](https://docs.api7.ai/ai-gateway/providers/cloudflare-workers-ai.md): Connect Cloudflare Workers AI to AISIX gateway deployments. Configure account-scoped endpoints, API credentials, @cf model IDs, aliases, 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, image generation, video, and reranking. - [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, image generation, video, and reranking. #### 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 gateway deployments through its OpenAI-compatible API. Configure explicit endpoints, credentials, model aliases, and caller access. - [DeepInfra](https://docs.api7.ai/ai-gateway/providers/deepinfra.md): Connect DeepInfra to AISIX gateway deployments through its OpenAI-compatible API. Configure explicit 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 gateway deployments. Configure serverless-inference credentials, model aliases, caller API keys, and access controls. - [DigitalOcean Gradient AI](https://docs.api7.ai/ai-gateway/providers/digitalocean-gradient-ai.md): Connect DigitalOcean Gradient AI to AISIX gateway deployments. Configure serverless-inference credentials, model aliases, caller API keys, and access controls. #### fireworks-ai Connect Fireworks AI to AISIX gateway deployments through its OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. - [Fireworks AI](https://docs.api7.ai/ai-gateway/providers/fireworks-ai.md): Connect Fireworks AI to AISIX gateway deployments through its OpenAI-compatible API. Configure provider credentials, model aliases, caller keys, and access controls. #### 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 Google Vertex AI to AISIX. Configure service-account credentials, global or regional endpoints, model aliases, and understand adapter limits. - [Google Vertex AI](https://docs.api7.ai/ai-gateway/providers/google-vertex-ai.md): Connect Google Vertex AI to AISIX. Configure service-account credentials, global or regional endpoints, model aliases, and understand adapter limits. #### groq Connect Groq to AISIX. Configure credentials and model aliases, then understand chat, Responses, audio, batch, and provider-specific limits. - [Groq](https://docs.api7.ai/ai-gateway/providers/groq.md): Connect Groq to AISIX. Configure credentials and model aliases, then understand chat, Responses, audio, batch, and provider-specific limits. #### huggingface Connect Hugging Face Inference Providers to AISIX. Configure router credentials and model aliases, then understand route and provider boundaries. - [Hugging Face](https://docs.api7.ai/ai-gateway/providers/huggingface.md): Connect Hugging Face Inference Providers to AISIX. Configure router credentials and model aliases, then understand route and provider boundaries. #### 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 gateway deployments through the OpenAI-compatible API. Configure the explicit endpoint, credentials, aliases, and caller access. - [MiniMax](https://docs.api7.ai/ai-gateway/providers/minimax.md): Connect MiniMax models to AISIX gateway deployments through the OpenAI-compatible API. Configure the explicit endpoint, credentials, aliases, and caller access. #### mistral Connect Mistral AI to AISIX for chat and compatible endpoints, with model aliases, structured-response boundaries, and native API passthrough. - [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 native API passthrough. #### 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 native API passthrough. - [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 native API passthrough. #### novita-ai Connect Novita AI to AISIX through its OpenAI-compatible API, with model aliases, endpoint compatibility, batch workflows, and native passthrough. - [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 native passthrough. #### 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 a local or private Ollama server to AISIX gateway deployments through its OpenAI-compatible API. Configure endpoints, model aliases, and caller access. - [Ollama](https://docs.api7.ai/ai-gateway/providers/ollama.md): Connect a local or private Ollama server to AISIX gateway deployments through its OpenAI-compatible API. Configure endpoints, model aliases, and caller access. #### openai Connect OpenAI models 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 models 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 gateway deployments through its OpenAI-compatible API. Configure credentials, namespaced model IDs, aliases, and caller access. - [OpenRouter](https://docs.api7.ai/ai-gateway/providers/openrouter.md): Connect OpenRouter to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, namespaced model IDs, aliases, 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 gateway deployments through the OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. - [OVHcloud AI Endpoints](https://docs.api7.ai/ai-gateway/providers/ovhcloud-ai-endpoints.md): Connect OVHcloud AI Endpoints to AISIX gateway deployments through the OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. #### perplexity Connect Perplexity Sonar models to AISIX gateway deployments through the OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. - [Perplexity](https://docs.api7.ai/ai-gateway/providers/perplexity.md): Connect Perplexity Sonar models to AISIX gateway deployments through the OpenAI-compatible API. Configure credentials, model aliases, caller keys, and access controls. #### qwen Connect Alibaba Cloud Qwen models to AISIX gateway deployments. Configure regional DashScope endpoints, credentials, model aliases, and caller access. - [Qwen (Alibaba Cloud)](https://docs.api7.ai/ai-gateway/providers/qwen.md): Connect Alibaba Cloud Qwen models to AISIX gateway deployments. Configure regional DashScope endpoints, credentials, model aliases, 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 OpenAI-compatible server to AISIX gateway deployments. Configure endpoint credentials, served model aliases, caller keys, and access controls. - [vLLM](https://docs.api7.ai/ai-gateway/providers/vllm.md): Connect a private vLLM OpenAI-compatible server to AISIX gateway deployments. Configure endpoint credentials, served model aliases, caller keys, and access controls. #### volcengine-ark Connect Volcengine Ark to AISIX gateway deployments for Doubao chat and Seedance video generation. Configure credentials, model aliases, and caller access. - [Volcengine Ark (Doubao)](https://docs.api7.ai/ai-gateway/providers/volcengine-ark.md): Connect Volcengine Ark to AISIX gateway deployments for Doubao chat and Seedance video generation. Configure credentials, model aliases, and caller access. #### wandb-inference Connect Weights & Biases Inference to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, model aliases, and caller access. - [Weights & Biases Inference](https://docs.api7.ai/ai-gateway/providers/wandb-inference.md): Connect Weights & Biases Inference to AISIX gateway deployments through its OpenAI-compatible API. Configure credentials, model aliases, and caller access. #### xai Connect xAI Grok models to AISIX gateway deployments through the OpenAI-compatible API. Configure regional endpoints, credentials, aliases, and caller access. - [xAI (Grok)](https://docs.api7.ai/ai-gateway/providers/xai.md): Connect xAI Grok models to AISIX gateway deployments through the OpenAI-compatible API. Configure regional endpoints, credentials, aliases, 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 New features, improvements, and fixes in each AISIX AI Gateway release. - [Release Notes](https://docs.api7.ai/ai-gateway/release-notes.md): New features, improvements, and fixes in each AISIX AI Gateway release. ### 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 AI 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 AI 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. ### traffic-controls #### budget-alerts Configure AISIX Cloud budget alerts to notify operators through webhooks or Slack when AI spending crosses a defined percentage of a budget limit. - [Budget Alerts and Notifications](https://docs.api7.ai/ai-gateway/traffic-controls/budget-alerts.md): Configure AISIX Cloud budget alerts to notify operators through webhooks or Slack when AI spending crosses a defined percentage of a budget limit. #### budgets Configure AISIX Cloud budgets 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 AISIX Cloud budgets 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 Cloud and open-source AISIX gateway deployments. - [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 Cloud and open-source AISIX gateway deployments. #### 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 — departments, groups, applications — to caller API keys with priority-ordered rules, so whole classes of identities share governed access with per-identity usage attribution. - [JWT Claim Mappings](https://docs.api7.ai/ai-gateway/traffic-controls/claim-mappings.md): Map verified JWT claims — departments, groups, applications — to caller API keys with priority-ordered rules, so whole classes of identities share governed access with 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 AISIX Cloud 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 AISIX Cloud 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 AISIX Cloud or a resources file, then verify blocking and PII anonymization in AISIX AI 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 AISIX Cloud 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. - [Built-in Keyword Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/keyword.md): Configure built-in AISIX keyword guardrails through AISIX Cloud 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 AISIX Cloud or a resources file, then verify prompt-injection blocking and PII masking in AISIX AI Gateway. - [OpenAI Moderation Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/openai-moderation.md): Configure OpenAI Moderation through AISIX Cloud or a resources file, then verify blocking and tune per-category thresholds in AISIX AI 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 AISIX Cloud or a resources file, then verify masking, blocking, and custom sensitive-data patterns. - [Microsoft Presidio Guardrails](https://docs.api7.ai/ai-gateway/traffic-controls/guardrails/presidio.md): Configure Microsoft Presidio through AISIX Cloud or a resources file, then verify PII anonymization and blocking with self-hosted analysis. #### jwt-authentication Configure OIDC trust and JWT authentication in AISIX gateway deployments, including issuer discovery, claim validation, and external identity mapping to caller API keys. - [JWT Authentication](https://docs.api7.ai/ai-gateway/traffic-controls/jwt-authentication.md): Configure OIDC trust and JWT authentication in AISIX gateway deployments, including issuer discovery, claim validation, and external 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 where rate limits, budgets, guardrails, and caching fit in the AISIX request path. - [Traffic Controls](https://docs.api7.ai/ai-gateway/traffic-controls/overview.md): Understand where rate limits, budgets, guardrails, and caching fit in the AISIX request path. #### prompt-caching Enable automatic Anthropic prompt caching in AISIX Cloud or 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 Cloud or 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 Cloud and the open-source AISIX gateway. - [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 Cloud and the open-source AISIX gateway. #### 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. ## 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 Enterprise AI Traffic to Vertex AI](https://docs.api7.ai/api7-gateway/3.9.x/ai-gateway/llm-providers/vertex-ai.md): Securely proxy Google Cloud Vertex AI requests through API7 Gateway with service account auth and regional routing. - [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. - [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 via the built-in Dashboard page or by scraping the Prometheus endpoint exposed by the data plane. - [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): Enable distributed tracing in API7 Gateway with the OpenTelemetry plugin. Configure the OTLP collector, sampling strategy, and per-route spans to visualize request flows and analyze latency bottlenecks. #### 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 (ACLs)](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. Configure allowlists and denylists keyed by consumer name, consumer group ID, service ID, or route ID for granular security. - [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): Learn how to back up and restore your API7 Gateway data with step-by-step instructions for database backup, declarative configuration backup, and data restoration procedures. - [API Gateway Cluster Migration](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/cluster-migration.md): A step-by-step guide for migrating your API7 Gateway deployment to a new cluster with zero downtime. - [Dual-Cluster Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/dual-cluster.md): Step-by-step guide for performing a dual-cluster upgrade of API7 Gateway, covering new cluster deployment, traffic shifting, and rollback procedures. - [In-Place Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/in-place.md): Step-by-step guide for performing an in-place upgrade of API7 Gateway Control Plane, covering database reuse, configuration updates, and verification procedures. - [Rolling Upgrade](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/rolling-upgrade.md): Step-by-step guide for performing a rolling upgrade of API7 Gateway Data Plane nodes, ensuring zero downtime while maintaining API request processing and service continuity. - [Upgrade API7 Gateway](https://docs.api7.ai/api7-gateway/3.9.x/upgrade-guides/upgrade.md): Comprehensive guide for upgrading API7 Gateway, covering in-place CP upgrade, rolling DP upgrade, data backup, and stability considerations. #### 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-agent-skills Manage API7 Gateway with AI coding agents like Claude Code and Cursor. Agent skills that configure your API7 Enterprise Edition gateway from natural language. - [AI Agent Skills for API7 Gateway](https://docs.api7.ai/api7-gateway/ai-agent-skills.md): Manage API7 Gateway with AI coding agents like Claude Code and Cursor. Agent skills that configure your API7 Enterprise Edition gateway from natural language. #### a7-persona-developer Persona skill for API developers building and testing APIs on API7 Enterprise Edition (API7 EE) using the a7 CLI. Provides decision frameworks for servi… - [a7-persona-developer](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-persona-developer.md): Persona skill for API developers building and testing APIs on API7 Enterprise Edition (API7 EE) using the a7 CLI. Provides decision frameworks for servi… #### a7-persona-operator Persona skill for platform operators and DevOps engineers managing API7 Enterprise Edition (API7 EE) instances using the a7 CLI. Provides decision frame… - [a7-persona-operator](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-persona-operator.md): Persona skill for platform operators and DevOps engineers managing API7 Enterprise Edition (API7 EE) instances using the a7 CLI. Provides decision frame… #### a7-plugin-ai-content-moderation Skill for configuring API7 Enterprise Edition AI content moderation plugins via the a7 CLI. Covers both ai-aws-content-moderation (AWS Comprehend, reque… - [a7-plugin-ai-content-moderation](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ai-content-moderation.md): Skill for configuring API7 Enterprise Edition AI content moderation plugins via the a7 CLI. Covers both ai-aws-content-moderation (AWS Comprehend, reque… #### a7-plugin-ai-prompt-decorator Skill for configuring the API7 Enterprise Edition ai-prompt-decorator plugin via the a7 CLI. Covers prepending and appending system/user/assistant messa… - [a7-plugin-ai-prompt-decorator](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ai-prompt-decorator.md): Skill for configuring the API7 Enterprise Edition ai-prompt-decorator plugin via the a7 CLI. Covers prepending and appending system/user/assistant messa… #### a7-plugin-ai-prompt-template Skill for configuring the API7 Enterprise Edition ai-prompt-template plugin via the a7 CLI. Covers defining reusable prompt templates with variable plac… - [a7-plugin-ai-prompt-template](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ai-prompt-template.md): Skill for configuring the API7 Enterprise Edition ai-prompt-template plugin via the a7 CLI. Covers defining reusable prompt templates with variable plac… #### a7-plugin-ai-proxy Skill for configuring the API7 Enterprise Edition ai-proxy plugin via the a7 CLI. Covers proxying requests to LLM providers (OpenAI, Azure OpenAI, DeepS… - [a7-plugin-ai-proxy](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ai-proxy.md): Skill for configuring the API7 Enterprise Edition ai-proxy plugin via the a7 CLI. Covers proxying requests to LLM providers (OpenAI, Azure OpenAI, DeepS… #### a7-plugin-basic-auth Skill for configuring the API7 Enterprise Edition (API7 EE) basic-auth plugin via the a7 CLI. Covers HTTP Basic Authentication setup on routes, consumer… - [a7-plugin-basic-auth](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-basic-auth.md): Skill for configuring the API7 Enterprise Edition (API7 EE) basic-auth plugin via the a7 CLI. Covers HTTP Basic Authentication setup on routes, consumer… #### a7-plugin-consumer-restriction Skill for configuring the API7 Enterprise Edition consumer-restriction plugin via the a7 CLI. Covers restricting access by consumer name, service ID, or… - [a7-plugin-consumer-restriction](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-consumer-restriction.md): Skill for configuring the API7 Enterprise Edition consumer-restriction plugin via the a7 CLI. Covers restricting access by consumer name, service ID, or… #### a7-plugin-cors Skill for configuring the API7 Enterprise Edition (API7 EE) cors plugin via the a7 CLI. Covers Cross-Origin Resource Sharing setup on routes, allow_orig… - [a7-plugin-cors](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-cors.md): Skill for configuring the API7 Enterprise Edition (API7 EE) cors plugin via the a7 CLI. Covers Cross-Origin Resource Sharing setup on routes, allow_orig… #### a7-plugin-datadog Skill for configuring the API7 Enterprise Edition datadog plugin via the a7 CLI. Covers pushing custom metrics to Datadog via DogStatsD, metric tags, ba… - [a7-plugin-datadog](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-datadog.md): Skill for configuring the API7 Enterprise Edition datadog plugin via the a7 CLI. Covers pushing custom metrics to Datadog via DogStatsD, metric tags, ba… #### a7-plugin-ext-plugin Skill for configuring the API7 Enterprise Edition external plugin system (ext-plugin-pre-req, ext-plugin-post-req, ext-plugin-post-resp) via the a7 CLI.… - [a7-plugin-ext-plugin](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ext-plugin.md): Skill for configuring the API7 Enterprise Edition external plugin system (ext-plugin-pre-req, ext-plugin-post-req, ext-plugin-post-resp) via the a7 CLI.… #### a7-plugin-fault-injection Skill for configuring the API7 Enterprise Edition fault-injection plugin via the a7 CLI. Covers injecting delays and HTTP aborts for chaos engineering,… - [a7-plugin-fault-injection](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-fault-injection.md): Skill for configuring the API7 Enterprise Edition fault-injection plugin via the a7 CLI. Covers injecting delays and HTTP aborts for chaos engineering,… #### a7-plugin-grpc-transcode Skill for configuring the API7 Enterprise Edition (API7 EE) grpc-transcode plugin via the a7 CLI. Covers converting RESTful HTTP requests to gRPC, proto… - [a7-plugin-grpc-transcode](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-grpc-transcode.md): Skill for configuring the API7 Enterprise Edition (API7 EE) grpc-transcode plugin via the a7 CLI. Covers converting RESTful HTTP requests to gRPC, proto… #### a7-plugin-hmac-auth Skill for configuring the API7 Enterprise Edition (API7 EE) hmac-auth plugin via the a7 CLI. Covers HMAC signature authentication, consumer credential b… - [a7-plugin-hmac-auth](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-hmac-auth.md): Skill for configuring the API7 Enterprise Edition (API7 EE) hmac-auth plugin via the a7 CLI. Covers HMAC signature authentication, consumer credential b… #### a7-plugin-http-logger Skill for configuring the API7 Enterprise Edition (API7 EE) http-logger plugin via the a7 CLI. Covers pushing access logs to HTTP/HTTPS endpoints in bat… - [a7-plugin-http-logger](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-http-logger.md): Skill for configuring the API7 Enterprise Edition (API7 EE) http-logger plugin via the a7 CLI. Covers pushing access logs to HTTP/HTTPS endpoints in bat… #### a7-plugin-ip-restriction Skill for configuring the API7 Enterprise Edition (API7 EE) ip-restriction plugin via the a7 CLI. Covers IP whitelist/blacklist setup on routes, CIDR ra… - [a7-plugin-ip-restriction](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-ip-restriction.md): Skill for configuring the API7 Enterprise Edition (API7 EE) ip-restriction plugin via the a7 CLI. Covers IP whitelist/blacklist setup on routes, CIDR ra… #### a7-plugin-jwt-auth Skill for configuring the API7 Enterprise Edition (API7 EE) jwt-auth plugin via the a7 CLI. Covers JWT token authentication, HS256/RS256 algorithm selec… - [a7-plugin-jwt-auth](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-jwt-auth.md): Skill for configuring the API7 Enterprise Edition (API7 EE) jwt-auth plugin via the a7 CLI. Covers JWT token authentication, HS256/RS256 algorithm selec… #### a7-plugin-kafka-logger Skill for configuring the API7 Enterprise Edition (API7 EE) kafka-logger plugin via the a7 CLI. Covers pushing access logs to Apache Kafka topics, broke… - [a7-plugin-kafka-logger](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-kafka-logger.md): Skill for configuring the API7 Enterprise Edition (API7 EE) kafka-logger plugin via the a7 CLI. Covers pushing access logs to Apache Kafka topics, broke… #### a7-plugin-key-auth Skill for configuring the API7 Enterprise Edition (API7 EE) key-auth plugin via the a7 CLI. Covers API key authentication setup on routes, consumer cred… - [a7-plugin-key-auth](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-key-auth.md): Skill for configuring the API7 Enterprise Edition (API7 EE) key-auth plugin via the a7 CLI. Covers API key authentication setup on routes, consumer cred… #### a7-plugin-limit-count Skill for configuring the API7 Enterprise Edition (API7 EE) limit-count plugin via the a7 CLI. Covers fixed-window rate limiting, count/time_window conf… - [a7-plugin-limit-count](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-limit-count.md): Skill for configuring the API7 Enterprise Edition (API7 EE) limit-count plugin via the a7 CLI. Covers fixed-window rate limiting, count/time_window conf… #### a7-plugin-limit-req Skill for configuring the API7 Enterprise Edition (API7 EE) limit-req plugin via the a7 CLI. Covers leaky-bucket rate limiting, rate/burst configuration… - [a7-plugin-limit-req](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-limit-req.md): Skill for configuring the API7 Enterprise Edition (API7 EE) limit-req plugin via the a7 CLI. Covers leaky-bucket rate limiting, rate/burst configuration… #### a7-plugin-openid-connect Skill for configuring the API7 Enterprise Edition (API7 EE) openid-connect plugin via the a7 CLI. Covers OIDC authorization code flow, bearer token vali… - [a7-plugin-openid-connect](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-openid-connect.md): Skill for configuring the API7 Enterprise Edition (API7 EE) openid-connect plugin via the a7 CLI. Covers OIDC authorization code flow, bearer token vali… #### a7-plugin-prometheus Skill for configuring the API7 Enterprise Edition (API7 EE) prometheus plugin via the a7 CLI. Covers enabling Prometheus metrics export on routes and gl… - [a7-plugin-prometheus](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-prometheus.md): Skill for configuring the API7 Enterprise Edition (API7 EE) prometheus plugin via the a7 CLI. Covers enabling Prometheus metrics export on routes and gl… #### a7-plugin-proxy-rewrite Skill for configuring the API7 Enterprise Edition (API7 EE) proxy-rewrite plugin via the a7 CLI. Covers rewriting request URI, host, method, headers, an… - [a7-plugin-proxy-rewrite](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-proxy-rewrite.md): Skill for configuring the API7 Enterprise Edition (API7 EE) proxy-rewrite plugin via the a7 CLI. Covers rewriting request URI, host, method, headers, an… #### a7-plugin-redirect Skill for configuring the API7 Enterprise Edition (API7 EE) redirect plugin via the a7 CLI. Covers URI redirects, HTTP-to-HTTPS redirection, regex-based… - [a7-plugin-redirect](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-redirect.md): Skill for configuring the API7 Enterprise Edition (API7 EE) redirect plugin via the a7 CLI. Covers URI redirects, HTTP-to-HTTPS redirection, regex-based… #### a7-plugin-response-rewrite Skill for configuring the API7 Enterprise Edition (API7 EE) response-rewrite plugin via the a7 CLI. Covers rewriting response status codes, headers, and… - [a7-plugin-response-rewrite](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-response-rewrite.md): Skill for configuring the API7 Enterprise Edition (API7 EE) response-rewrite plugin via the a7 CLI. Covers rewriting response status codes, headers, and… #### a7-plugin-serverless Skill for configuring the API7 Enterprise Edition serverless-pre-function and serverless-post-function plugins via the a7 CLI. Covers inline Lua functio… - [a7-plugin-serverless](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-serverless.md): Skill for configuring the API7 Enterprise Edition serverless-pre-function and serverless-post-function plugins via the a7 CLI. Covers inline Lua functio… #### a7-plugin-skywalking Skill for configuring the API7 Enterprise Edition (API7 EE) skywalking plugin via the a7 CLI. Covers distributed tracing with Apache SkyWalking OAP, sam… - [a7-plugin-skywalking](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-skywalking.md): Skill for configuring the API7 Enterprise Edition (API7 EE) skywalking plugin via the a7 CLI. Covers distributed tracing with Apache SkyWalking OAP, sam… #### a7-plugin-traffic-split Skill for configuring the API7 Enterprise Edition (API7 EE) traffic-split plugin via the a7 CLI. Covers weighted traffic splitting between upstreams wit… - [a7-plugin-traffic-split](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-traffic-split.md): Skill for configuring the API7 Enterprise Edition (API7 EE) traffic-split plugin via the a7 CLI. Covers weighted traffic splitting between upstreams wit… #### a7-plugin-wolf-rbac Skill for configuring the API7 Enterprise Edition (API7 EE) wolf-rbac plugin via the a7 CLI. Covers integration with the Wolf RBAC server for role-based… - [a7-plugin-wolf-rbac](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-wolf-rbac.md): Skill for configuring the API7 Enterprise Edition (API7 EE) wolf-rbac plugin via the a7 CLI. Covers integration with the Wolf RBAC server for role-based… #### a7-plugin-zipkin Skill for configuring the API7 Enterprise Edition (API7 EE) zipkin plugin via the a7 CLI. Covers distributed tracing with Zipkin, Jaeger, or any Zipkin-… - [a7-plugin-zipkin](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-plugin-zipkin.md): Skill for configuring the API7 Enterprise Edition (API7 EE) zipkin plugin via the a7 CLI. Covers distributed tracing with Zipkin, Jaeger, or any Zipkin-… #### a7-recipe-api-versioning Recipe skill for implementing API versioning strategies using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers URI path versioning, header-based… - [a7-recipe-api-versioning](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-api-versioning.md): Recipe skill for implementing API versioning strategies using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers URI path versioning, header-based… #### a7-recipe-blue-green Recipe skill for implementing blue-green deployments using the a7 CLI in API7 Enterprise Edition. Covers creating two service-backed environments, switc… - [a7-recipe-blue-green](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-blue-green.md): Recipe skill for implementing blue-green deployments using the a7 CLI in API7 Enterprise Edition. Covers creating two service-backed environments, switc… #### a7-recipe-canary Recipe skill for implementing canary releases using the a7 CLI in API7 Enterprise Edition. Covers gradual traffic shifting with the traffic-split plugin… - [a7-recipe-canary](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-canary.md): Recipe skill for implementing canary releases using the a7 CLI in API7 Enterprise Edition. Covers gradual traffic shifting with the traffic-split plugin… #### a7-recipe-circuit-breaker Recipe skill for implementing circuit breaker patterns using the a7 CLI in API7 Enterprise Edition. Covers the api-breaker plugin, unhealthy thresholds,… - [a7-recipe-circuit-breaker](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-circuit-breaker.md): Recipe skill for implementing circuit breaker patterns using the a7 CLI in API7 Enterprise Edition. Covers the api-breaker plugin, unhealthy thresholds,… #### a7-recipe-graphql-proxy Recipe skill for implementing GraphQL proxying patterns using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers operation-based routing, per-oper… - [a7-recipe-graphql-proxy](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-graphql-proxy.md): Recipe skill for implementing GraphQL proxying patterns using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers operation-based routing, per-oper… #### a7-recipe-health-check Recipe skill for configuring backend health checks using the a7 CLI in API7 Enterprise Edition. Covers active health checks, passive health checks, comb… - [a7-recipe-health-check](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-health-check.md): Recipe skill for configuring backend health checks using the a7 CLI in API7 Enterprise Edition. Covers active health checks, passive health checks, comb… #### a7-recipe-mtls Recipe skill for configuring mutual TLS (mTLS) using the a7 CLI in API7 Enterprise Edition. Covers SSL certificate management, upstream mTLS to backend… - [a7-recipe-mtls](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-mtls.md): Recipe skill for configuring mutual TLS (mTLS) using the a7 CLI in API7 Enterprise Edition. Covers SSL certificate management, upstream mTLS to backend… #### a7-recipe-multi-tenant Recipe skill for implementing multi-tenant patterns using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers gateway-group isolation, consumer pol… - [a7-recipe-multi-tenant](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-recipe-multi-tenant.md): Recipe skill for implementing multi-tenant patterns using API7 Enterprise Edition (API7 EE) and the a7 CLI. Covers gateway-group isolation, consumer pol… #### a7-shared Core skill for working with the a7 CLI — the command-line tool for API7 Enterprise Edition. Provides project conventions, command patterns, dual-API arc… - [a7 Shared Skill](https://docs.api7.ai/api7-gateway/ai-agent-skills/a7-shared.md): Core skill for working with the a7 CLI — the command-line tool for API7 Enterprise Edition. Provides project conventions, command patterns, dual-API arc… ### 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 Enterprise AI Traffic to Vertex AI](https://docs.api7.ai/api7-gateway/ai-gateway/llm-providers/vertex-ai.md): Securely proxy Google Cloud Vertex AI requests through API7 Gateway with service account auth and regional routing. #### 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 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/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/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. - [Configure SSO for the Developer Portal](https://docs.api7.ai/api7-gateway/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/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. #### 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. #### 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. #### 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 via the built-in Dashboard page or by scraping the Prometheus endpoint exposed by the data plane. - [Monitor Metrics](https://docs.api7.ai/api7-gateway/observability/metrics.md): Monitor API7 Gateway metrics via the built-in Dashboard page or by scraping the Prometheus endpoint exposed by the data plane. #### 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 Enable distributed tracing in API7 Gateway with the OpenTelemetry plugin. Configure the OTLP collector, sampling strategy, and per-route spans to visualize request flows and analyze latency bottlenecks. - [Configure Distributed Tracing](https://docs.api7.ai/api7-gateway/observability/tracing.md): Enable distributed tracing in API7 Gateway with the OpenTelemetry plugin. Configure the OTLP collector, sampling strategy, and per-route spans to visualize request flows and analyze latency bottlenecks. ### 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. Configure allowlists and denylists keyed by consumer name, consumer group ID, service ID, or route ID for granular security. - [Access Control Lists (ACLs)](https://docs.api7.ai/api7-gateway/security-and-compliance/access-control-lists.md): Restrict API access using the consumer-restriction plugin in API7 Gateway. Configure allowlists and denylists keyed by consumer name, consumer group ID, service ID, or route ID for granular security. #### 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 (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-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 Learn how to back up and restore your API7 Gateway data with step-by-step instructions for database backup, declarative configuration backup, and data restoration procedures. - [Backup and Restoration](https://docs.api7.ai/api7-gateway/upgrade-guides/backup-and-restore.md): Learn how to back up and restore your API7 Gateway data with step-by-step instructions for database backup, declarative configuration backup, and data restoration procedures. #### cluster-migration A step-by-step guide for migrating your API7 Gateway deployment to a new cluster with zero downtime. - [API Gateway Cluster Migration](https://docs.api7.ai/api7-gateway/upgrade-guides/cluster-migration.md): A step-by-step guide for migrating your API7 Gateway deployment to a new cluster with zero downtime. #### dual-cluster Step-by-step guide for performing a dual-cluster upgrade of API7 Gateway, covering new cluster deployment, traffic shifting, and rollback procedures. - [Dual-Cluster Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/dual-cluster.md): Step-by-step guide for performing a dual-cluster upgrade of API7 Gateway, covering new cluster deployment, traffic shifting, and rollback procedures. #### in-place Step-by-step guide for performing an in-place upgrade of API7 Gateway Control Plane, covering database reuse, configuration updates, and verification procedures. - [In-Place Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/in-place.md): Step-by-step guide for performing an in-place upgrade of API7 Gateway Control Plane, covering database reuse, configuration updates, and verification procedures. #### rolling-upgrade Step-by-step guide for performing a rolling upgrade of API7 Gateway Data Plane nodes, ensuring zero downtime while maintaining API request processing and service continuity. - [Rolling Upgrade](https://docs.api7.ai/api7-gateway/upgrade-guides/rolling-upgrade.md): Step-by-step guide for performing a rolling upgrade of API7 Gateway Data Plane nodes, ensuring zero downtime while maintaining API request processing and service continuity. #### upgrade Comprehensive guide for upgrading API7 Gateway, covering in-place CP upgrade, rolling DP upgrade, data backup, and stability considerations. - [Upgrade API7 Gateway](https://docs.api7.ai/api7-gateway/upgrade-guides/upgrade.md): Comprehensive guide for upgrading API7 Gateway, covering in-place CP upgrade, rolling DP upgrade, data backup, and stability considerations. ### 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. #### 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. ### ai-agent-skills Manage Apache APISIX with AI coding agents like Claude Code and Cursor. Browse open-source agent skills that configure your API gateway from natural language. - [AI Agent Skills for Apache APISIX](https://docs.api7.ai/apisix/ai-agent-skills.md): Manage Apache APISIX with AI coding agents like Claude Code and Cursor. Browse open-source agent skills that configure your API gateway from natural language. #### a6-persona-developer Persona skill for API developers building and testing APIs on APISIX using the a6 CLI. Provides decision frameworks for API design, route configuration,… - [a6-persona-developer](https://docs.api7.ai/apisix/ai-agent-skills/a6-persona-developer.md): Persona skill for API developers building and testing APIs on APISIX using the a6 CLI. Provides decision frameworks for API design, route configuration,… #### a6-persona-operator Persona skill for platform operators and DevOps engineers managing APISIX instances using the a6 CLI. Provides decision frameworks for day-to-day operat… - [a6-persona-operator](https://docs.api7.ai/apisix/ai-agent-skills/a6-persona-operator.md): Persona skill for platform operators and DevOps engineers managing APISIX instances using the a6 CLI. Provides decision frameworks for day-to-day operat… #### a6-plugin-ai-content-moderation Skill for configuring APISIX AI content moderation plugins via the a6 CLI. Covers both ai-aws-content-moderation (AWS Comprehend, request-only) and ai-a… - [a6-plugin-ai-content-moderation](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ai-content-moderation.md): Skill for configuring APISIX AI content moderation plugins via the a6 CLI. Covers both ai-aws-content-moderation (AWS Comprehend, request-only) and ai-a… #### a6-plugin-ai-prompt-decorator Skill for configuring the Apache APISIX ai-prompt-decorator plugin via the a6 CLI. Covers prepending and appending system/user/assistant messages to LLM… - [a6-plugin-ai-prompt-decorator](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ai-prompt-decorator.md): Skill for configuring the Apache APISIX ai-prompt-decorator plugin via the a6 CLI. Covers prepending and appending system/user/assistant messages to LLM… #### a6-plugin-ai-prompt-template Skill for configuring the Apache APISIX ai-prompt-template plugin via the a6 CLI. Covers defining reusable prompt templates with variable placeholders,… - [a6-plugin-ai-prompt-template](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ai-prompt-template.md): Skill for configuring the Apache APISIX ai-prompt-template plugin via the a6 CLI. Covers defining reusable prompt templates with variable placeholders,… #### a6-plugin-ai-proxy Skill for configuring the Apache APISIX ai-proxy plugin via the a6 CLI. Covers authentication and proxying for Chat Completions, Responses, and Embeddings. - [a6-plugin-ai-proxy](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ai-proxy.md): Skill for configuring the Apache APISIX ai-proxy plugin via the a6 CLI. Covers authentication and proxying for Chat Completions, Responses, and Embeddings. #### a6-plugin-basic-auth Skill for configuring the Apache APISIX basic-auth plugin via the a6 CLI. Covers HTTP Basic Authentication setup on routes, consumer credential binding… - [a6-plugin-basic-auth](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-basic-auth.md): Skill for configuring the Apache APISIX basic-auth plugin via the a6 CLI. Covers HTTP Basic Authentication setup on routes, consumer credential binding… #### a6-plugin-consumer-restriction Skill for configuring the Apache APISIX consumer-restriction plugin via the a6 CLI. Covers restricting access by consumer name, consumer group ID, servi… - [a6-plugin-consumer-restriction](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-consumer-restriction.md): Skill for configuring the Apache APISIX consumer-restriction plugin via the a6 CLI. Covers restricting access by consumer name, consumer group ID, servi… #### a6-plugin-cors Skill for configuring the Apache APISIX cors plugin via the a6 CLI. Covers Cross-Origin Resource Sharing setup on routes, allow_origins, allow_methods,… - [a6-plugin-cors](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-cors.md): Skill for configuring the Apache APISIX cors plugin via the a6 CLI. Covers Cross-Origin Resource Sharing setup on routes, allow_origins, allow_methods,… #### a6-plugin-datadog Skill for configuring the Apache APISIX datadog plugin via the a6 CLI. Covers pushing custom metrics to Datadog via DogStatsD, metric tags, batching, pl… - [a6-plugin-datadog](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-datadog.md): Skill for configuring the Apache APISIX datadog plugin via the a6 CLI. Covers pushing custom metrics to Datadog via DogStatsD, metric tags, batching, pl… #### a6-plugin-ext-plugin Skill for configuring the Apache APISIX external plugin system (ext-plugin-pre-req, ext-plugin-post-req, ext-plugin-post-resp) via the a6 CLI. Covers Pl… - [a6-plugin-ext-plugin](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ext-plugin.md): Skill for configuring the Apache APISIX external plugin system (ext-plugin-pre-req, ext-plugin-post-req, ext-plugin-post-resp) via the a6 CLI. Covers Pl… #### a6-plugin-fault-injection Skill for configuring the Apache APISIX fault-injection plugin via the a6 CLI. Covers injecting delays and HTTP aborts for chaos engineering, percentage… - [a6-plugin-fault-injection](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-fault-injection.md): Skill for configuring the Apache APISIX fault-injection plugin via the a6 CLI. Covers injecting delays and HTTP aborts for chaos engineering, percentage… #### a6-plugin-grpc-transcode Skill for configuring the Apache APISIX grpc-transcode plugin via the a6 CLI. Covers converting RESTful HTTP requests to gRPC, proto file management, pb… - [a6-plugin-grpc-transcode](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-grpc-transcode.md): Skill for configuring the Apache APISIX grpc-transcode plugin via the a6 CLI. Covers converting RESTful HTTP requests to gRPC, proto file management, pb… #### a6-plugin-hmac-auth Skill for configuring the Apache APISIX hmac-auth plugin via the a6 CLI. Covers HMAC signature authentication, consumer credential binding with key_id/s… - [a6-plugin-hmac-auth](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-hmac-auth.md): Skill for configuring the Apache APISIX hmac-auth plugin via the a6 CLI. Covers HMAC signature authentication, consumer credential binding with key_id/s… #### a6-plugin-http-logger Skill for configuring the Apache APISIX http-logger plugin via the a6 CLI. Covers pushing access logs to HTTP/HTTPS endpoints in batches, custom log for… - [a6-plugin-http-logger](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-http-logger.md): Skill for configuring the Apache APISIX http-logger plugin via the a6 CLI. Covers pushing access logs to HTTP/HTTPS endpoints in batches, custom log for… #### a6-plugin-ip-restriction Skill for configuring the Apache APISIX ip-restriction plugin via the a6 CLI. Covers IP whitelist/blacklist setup on routes, CIDR range support, IPv4/IP… - [a6-plugin-ip-restriction](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-ip-restriction.md): Skill for configuring the Apache APISIX ip-restriction plugin via the a6 CLI. Covers IP whitelist/blacklist setup on routes, CIDR range support, IPv4/IP… #### a6-plugin-jwt-auth Skill for configuring the Apache APISIX jwt-auth plugin via the a6 CLI. Covers JWT token authentication, HS256/RS256 algorithm selection, consumer crede… - [a6-plugin-jwt-auth](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-jwt-auth.md): Skill for configuring the Apache APISIX jwt-auth plugin via the a6 CLI. Covers JWT token authentication, HS256/RS256 algorithm selection, consumer crede… #### a6-plugin-kafka-logger Skill for configuring the Apache APISIX kafka-logger plugin via the a6 CLI. Covers pushing access logs to Apache Kafka topics, broker configuration, SAS… - [a6-plugin-kafka-logger](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-kafka-logger.md): Skill for configuring the Apache APISIX kafka-logger plugin via the a6 CLI. Covers pushing access logs to Apache Kafka topics, broker configuration, SAS… #### a6-plugin-key-auth Skill for configuring the Apache APISIX key-auth plugin via the a6 CLI. Covers API key authentication setup on routes, consumer credential binding, key… - [a6-plugin-key-auth](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-key-auth.md): Skill for configuring the Apache APISIX key-auth plugin via the a6 CLI. Covers API key authentication setup on routes, consumer credential binding, key… #### a6-plugin-limit-count Skill for configuring the Apache APISIX limit-count plugin via the a6 CLI. Covers fixed-window rate limiting, count/time_window configuration, key types… - [a6-plugin-limit-count](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-limit-count.md): Skill for configuring the Apache APISIX limit-count plugin via the a6 CLI. Covers fixed-window rate limiting, count/time_window configuration, key types… #### a6-plugin-limit-req Skill for configuring the Apache APISIX limit-req plugin via the a6 CLI. Covers leaky-bucket rate limiting, rate/burst configuration, nodelay behavior,… - [a6-plugin-limit-req](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-limit-req.md): Skill for configuring the Apache APISIX limit-req plugin via the a6 CLI. Covers leaky-bucket rate limiting, rate/burst configuration, nodelay behavior,… #### a6-plugin-openid-connect Skill for configuring the Apache APISIX openid-connect plugin via the a6 CLI. Covers OIDC authorization code flow, bearer token validation, token intros… - [a6-plugin-openid-connect](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-openid-connect.md): Skill for configuring the Apache APISIX openid-connect plugin via the a6 CLI. Covers OIDC authorization code flow, bearer token validation, token intros… #### a6-plugin-prometheus Skill for configuring the Apache APISIX prometheus plugin via the a6 CLI. Covers enabling Prometheus metrics export on routes and globally, exposed metr… - [a6-plugin-prometheus](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-prometheus.md): Skill for configuring the Apache APISIX prometheus plugin via the a6 CLI. Covers enabling Prometheus metrics export on routes and globally, exposed metr… #### a6-plugin-proxy-rewrite Skill for configuring the Apache APISIX proxy-rewrite plugin via the a6 CLI. Covers rewriting request URI, host, method, headers, and scheme before forw… - [a6-plugin-proxy-rewrite](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-proxy-rewrite.md): Skill for configuring the Apache APISIX proxy-rewrite plugin via the a6 CLI. Covers rewriting request URI, host, method, headers, and scheme before forw… #### a6-plugin-redirect Skill for configuring the Apache APISIX redirect plugin via the a6 CLI. Covers URI redirects, HTTP-to-HTTPS redirection, regex-based URI rewriting, quer… - [a6-plugin-redirect](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-redirect.md): Skill for configuring the Apache APISIX redirect plugin via the a6 CLI. Covers URI redirects, HTTP-to-HTTPS redirection, regex-based URI rewriting, quer… #### a6-plugin-response-rewrite Skill for configuring the Apache APISIX response-rewrite plugin via the a6 CLI. Covers rewriting response status codes, headers, and body before returni… - [a6-plugin-response-rewrite](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-response-rewrite.md): Skill for configuring the Apache APISIX response-rewrite plugin via the a6 CLI. Covers rewriting response status codes, headers, and body before returni… #### a6-plugin-serverless Skill for configuring the Apache APISIX serverless-pre-function and serverless-post-function plugins via the a6 CLI. Covers inline Lua function executio… - [a6-plugin-serverless](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-serverless.md): Skill for configuring the Apache APISIX serverless-pre-function and serverless-post-function plugins via the a6 CLI. Covers inline Lua function executio… #### a6-plugin-skywalking Skill for configuring the Apache APISIX skywalking plugin via the a6 CLI. Covers distributed tracing with Apache SkyWalking OAP, sampling configuration,… - [a6-plugin-skywalking](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-skywalking.md): Skill for configuring the Apache APISIX skywalking plugin via the a6 CLI. Covers distributed tracing with Apache SkyWalking OAP, sampling configuration,… #### a6-plugin-traffic-split Skill for configuring the Apache APISIX traffic-split plugin via the a6 CLI. Covers weighted traffic splitting between upstreams with conditional match… - [a6-plugin-traffic-split](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-traffic-split.md): Skill for configuring the Apache APISIX traffic-split plugin via the a6 CLI. Covers weighted traffic splitting between upstreams with conditional match… #### a6-plugin-wolf-rbac Skill for configuring the Apache APISIX wolf-rbac plugin via the a6 CLI. Covers integration with the Wolf RBAC server for role-based access control, tok… - [a6-plugin-wolf-rbac](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-wolf-rbac.md): Skill for configuring the Apache APISIX wolf-rbac plugin via the a6 CLI. Covers integration with the Wolf RBAC server for role-based access control, tok… #### a6-plugin-zipkin Skill for configuring the Apache APISIX zipkin plugin via the a6 CLI. Covers distributed tracing with Zipkin, Jaeger, or any Zipkin-compatible collector… - [a6-plugin-zipkin](https://docs.api7.ai/apisix/ai-agent-skills/a6-plugin-zipkin.md): Skill for configuring the Apache APISIX zipkin plugin via the a6 CLI. Covers distributed tracing with Zipkin, Jaeger, or any Zipkin-compatible collector… #### a6-recipe-api-versioning Recipe skill for implementing API versioning strategies using the a6 CLI. Covers URI path versioning with proxy-rewrite, header-based versioning with tr… - [a6-recipe-api-versioning](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-api-versioning.md): Recipe skill for implementing API versioning strategies using the a6 CLI. Covers URI path versioning with proxy-rewrite, header-based versioning with tr… #### a6-recipe-blue-green Recipe skill for implementing blue-green deployments using the a6 CLI. Covers creating two upstream environments, switching traffic instantly via route… - [a6-recipe-blue-green](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-blue-green.md): Recipe skill for implementing blue-green deployments using the a6 CLI. Covers creating two upstream environments, switching traffic instantly via route… #### a6-recipe-canary Recipe skill for implementing canary releases using the a6 CLI. Covers gradual traffic shifting with the traffic-split plugin, header-based canary routi… - [a6-recipe-canary](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-canary.md): Recipe skill for implementing canary releases using the a6 CLI. Covers gradual traffic shifting with the traffic-split plugin, header-based canary routi… #### a6-recipe-circuit-breaker Recipe skill for implementing circuit breaker patterns using the a6 CLI. Covers the api-breaker plugin for automatic upstream circuit breaking, configur… - [a6-recipe-circuit-breaker](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-circuit-breaker.md): Recipe skill for implementing circuit breaker patterns using the a6 CLI. Covers the api-breaker plugin for automatic upstream circuit breaking, configur… #### a6-recipe-graphql-proxy Recipe skill for implementing GraphQL proxying patterns using the a6 CLI. Covers operation-based routing with built-in GraphQL variables, per-operation… - [a6-recipe-graphql-proxy](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-graphql-proxy.md): Recipe skill for implementing GraphQL proxying patterns using the a6 CLI. Covers operation-based routing with built-in GraphQL variables, per-operation… #### a6-recipe-health-check Recipe skill for configuring upstream health checks using the a6 CLI. Covers active health checks (HTTP probing), passive health checks (response analys… - [a6-recipe-health-check](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-health-check.md): Recipe skill for configuring upstream health checks using the a6 CLI. Covers active health checks (HTTP probing), passive health checks (response analys… #### a6-recipe-mtls Recipe skill for configuring mutual TLS (mTLS) using the a6 CLI. Covers SSL certificate management, upstream mTLS to backend services, client certificat… - [a6-recipe-mtls](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-mtls.md): Recipe skill for configuring mutual TLS (mTLS) using the a6 CLI. Covers SSL certificate management, upstream mTLS to backend services, client certificat… #### a6-recipe-multi-tenant Recipe skill for implementing multi-tenant API gateway patterns using the a6 CLI. Covers tenant isolation via Consumer Groups, host/path/header-based ro… - [a6-recipe-multi-tenant](https://docs.api7.ai/apisix/ai-agent-skills/a6-recipe-multi-tenant.md): Recipe skill for implementing multi-tenant API gateway patterns using the a6 CLI. Covers tenant isolation via Consumer Groups, host/path/header-based ro… #### a6-shared Core skill for working with the a6 CLI — the Apache APISIX command-line tool. Provides project conventions, command patterns, architecture overview, and… - [a6 Shared Skill](https://docs.api7.ai/apisix/ai-agent-skills/a6-shared.md): Core skill for working with the a6 CLI — the Apache APISIX command-line tool. Provides project conventions, command patterns, architecture overview, and… ### 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): Learn how to configure Apache APISIX to proxy requests to Anthropic with the ai-proxy plugin, enabling access to Claude models via an OpenAI-compatible API without specifying a custom endpoint. - [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 Vertex AI Requests](https://docs.api7.ai/apisix/how-to-guide/ai-gateway/proxy-vertex-ai-requests.md): Learn how to configure Apache APISIX to proxy requests to Google Vertex AI with the ai-proxy plugin, enabling access to Gemini models through an OpenAI-compatible API. #### authentication - [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 WebSocket Traffic](https://docs.api7.ai/apisix/how-to-guide/authentication/secure-websocket-traffic.md): Learn how to secure WebSocket traffic in Apache APISIX, implementing authentication mechanisms during the initial handshake to protect WebSocket connections. - [Set Up SSO with Amazon Cognito](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-amazon-cognito.md): Learn how to set up single sign-on (SSO) with Amazon Cognito in Apache APISIX, facilitating secure user authentication and access management. - [Set Up SSO with Auth0](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-auth0.md): Discover how to configure Apache APISIX to use Auth0 for single sign-on (SSO), enabling secure user authentication through various identity management features. - [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): Understand how to set up single sign-on (SSO) in Apache APISIX using Microsoft Entra ID (Azure AD) for secure authentication via OpenID Connect. - [Set Up SSO with Google](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-google.md): Explore how to integrate Apache APISIX with Google for single sign-on (SSO) using OpenID Connect, facilitating secure user authentication for your APIs. - [Set Up SSO with Keycloak](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-keycloak.md): Learn how to integrate Apache APISIX with Keycloak to implement single sign-on (SSO) using OpenID Connect for secure authentication processes. - [Set Up SSO with Okta](https://docs.api7.ai/apisix/how-to-guide/authentication/set-up-sso-with-okta.md): Discover how to configure Apache APISIX to work with Okta for single sign-on (SSO), enabling secure authentication processes using OpenID Connect. #### 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): Discover how to implement request tracing in Apache APISIX with Zipkin, enabling detailed monitoring of request flows and performance diagnostics. #### 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): Discover how to configure Netflix Eureka for service discovery and integrate it with Apache APISIX to manage service registration and routing seamlessly. #### 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 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): Discover how to enable Apache APISIX to proxy WebSocket connections, facilitating real-time, bidirectional communication between clients and servers. - [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 JSON to XML](https://docs.api7.ai/apisix/how-to-guide/transformation/convert-json-to-xml.md): Discover how to use the body-transformer plugin in Apache APISIX to convert JSON data to XML format and vice versa, facilitating data interchange between different systems. - [Transcode HTTP to gRPC](https://docs.api7.ai/apisix/how-to-guide/transformation/transcode-http-to-grpc.md): Learn how to use the grpc-transcode plugin in Apache APISIX to convert between RESTful HTTP requests and gRPC requests, enabling seamless integration of gRPC services. ### 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. #### 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 controls access to upstream resources by verifying if the user is on the access control lists, enhancing API management. - [acl](https://docs.api7.ai/hub/acl.md): The acl plugin controls access to upstream resources by verifying if the user is on the access control lists, enhancing API management. #### configuration Parameters - [ACL](https://docs.api7.ai/hub/acl/configuration.md): Parameters ### ai-aliyun-content-moderation The ai-aliyun-content-moderation plugin supports the integration with Aliyun to check prompt inputs for risk level when proxying to LLMs, rejecting requests that exceed the threshold. - [ai-aliyun-content-moderation](https://docs.api7.ai/hub/ai-aliyun-content-moderation.md): The ai-aliyun-content-moderation plugin supports the integration with Aliyun to check prompt inputs for risk level when proxying to LLMs, rejecting requests that exceed the 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 supports the integration with AWS Comprehend to check prompt inputs for toxicity when proxying to LLMs, rejecting requests that exceed the threshold. - [ai-aws-content-moderation](https://docs.api7.ai/hub/ai-aws-content-moderation.md): The ai-aws-content-moderation plugin supports the integration with AWS Comprehend to check prompt inputs for toxicity when proxying to LLMs, rejecting requests that exceed the threshold. #### configuration Parameters - [AI AWS Content Moderation](https://docs.api7.ai/hub/ai-aws-content-moderation/configuration.md): Parameters ### ai-cache The ai-cache plugin caches LLM responses in Redis and serves identical requests from the cache, reducing latency and upstream model usage. - [ai-cache Enterprise](https://docs.api7.ai/hub/ai-cache.md): The ai-cache plugin caches LLM responses in Redis and serves identical requests from the cache, reducing latency and 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 simplifies access to LLM and embedding models providers by converting plugin configurations into the required request format for OpenAI, DeepSeek, Anthropic, and other OpenAI-compatible APIs. - [ai-proxy](https://docs.api7.ai/hub/ai-proxy.md): The ai-proxy plugin simplifies access to LLM and embedding models providers by converting plugin configurations into the required request format for OpenAI, DeepSeek, Anthropic, and other OpenAI-compatible APIs. #### configuration Parameters - [AI Proxy](https://docs.api7.ai/hub/ai-proxy/configuration.md): Parameters ### ai-proxy-multi The ai-proxy-multi plugin extends the capabilities of ai-proxy with load balancing, retries, fallbacks, and health checks, simplifying the integration with OpenAI, DeepSeek, and other OpenAI-compatible APIs. - [ai-proxy-multi](https://docs.api7.ai/hub/ai-proxy-multi.md): The ai-proxy-multi plugin extends the capabilities of ai-proxy with load balancing, retries, fallbacks, and health checks, simplifying the integration with OpenAI, DeepSeek, and other OpenAI-compatible APIs. #### configuration Parameters - [AI Proxy Multi](https://docs.api7.ai/hub/ai-proxy-multi/configuration.md): Parameters ### ai-rag The ai-rag plugin enhances LLM outputs with Retrieval-Augmented Generation (RAG), efficiently retrieving relevant documents to improve accuracy and contextual relevance in responses. - [ai-rag](https://docs.api7.ai/hub/ai-rag.md): The ai-rag plugin enhances LLM outputs with Retrieval-Augmented Generation (RAG), efficiently retrieving relevant documents to improve accuracy and contextual relevance in responses. #### 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 integrates with Keycloak for user authentication and authorization, enhancing API security and management. - [authz-keycloak](https://docs.api7.ai/hub/authz-keycloak.md): The authz-keycloak plugin integrates with Keycloak for user authentication and authorization, enhancing API security and management. #### configuration Parameters - [Authz Keycloak](https://docs.api7.ai/hub/authz-keycloak/configuration.md): Parameters ### aws-lambda The aws-lambda plugin simplifies APISIX integration with AWS Lambda and Amazon API gateway, supporting authentication via IAM user credentials and API keys. - [aws-lambda](https://docs.api7.ai/hub/aws-lambda.md): The aws-lambda plugin simplifies APISIX integration with AWS Lambda and Amazon API gateway, supporting authentication via IAM user credentials and API keys. #### configuration Attributes - [AWS Lambda](https://docs.api7.ai/hub/aws-lambda/configuration.md): Attributes ### 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 converts request and response bodies between formats, such as JSON to XML, facilitating seamless data exchange. - [body-transformer](https://docs.api7.ai/hub/body-transformer.md): The body-transformer plugin converts request and response bodies between formats, such as JSON to XML, facilitating seamless data exchange. #### configuration Parameters - [Body Transformer](https://docs.api7.ai/hub/body-transformer/configuration.md): Parameters ### chaitin-waf The chaitin-waf plugin integrates with Chaitin WAF (SafeLine) to detect and block web threats, strengthening application security and protecting user data. - [chaitin-waf](https://docs.api7.ai/hub/chaitin-waf.md): The chaitin-waf plugin integrates with Chaitin WAF (SafeLine) to detect and block web threats, strengthening application security and protecting user data. #### 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 implements access controls based on consumer name, route ID, service ID, or consumer group ID, enhancing API security. - [consumer-restriction](https://docs.api7.ai/hub/consumer-restriction.md): The consumer-restriction plugin implements access controls based on consumer name, route ID, service ID, or consumer group ID, enhancing API security. #### 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 integrates with Datadog, sending metrics to DogStatsD in batches to improve API monitoring and API performance tracking. - [datadog](https://docs.api7.ai/hub/datadog.md): The datadog plugin integrates with Datadog, sending metrics to DogStatsD in batches to improve API monitoring and API performance tracking. #### configuration Parameters - [Datadog](https://docs.api7.ai/hub/datadog/configuration.md): Parameters ### degraphql The degraphql plugin enables communication with upstream GraphQL services through standard HTTP requests by mapping GraphQL queries to HTTP endpoints, simplifying API integration. - [degraphql](https://docs.api7.ai/hub/degraphql.md): The degraphql plugin enables communication with upstream GraphQL services through standard HTTP requests by mapping GraphQL queries to HTTP endpoints, simplifying API integration. #### configuration Parameters - [degraphql](https://docs.api7.ai/hub/degraphql/configuration.md): Parameters ### elasticsearch-logger The elasticsearch-logger plugin pushes request and response logs in batches to Elasticsearch, allowing for customizable log formats to enhance data management. - [elasticsearch-logger](https://docs.api7.ai/hub/elasticsearch-logger.md): The elasticsearch-logger plugin pushes request and response logs in batches to Elasticsearch, allowing for customizable log formats to enhance data management. #### 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 pushes APISIX's error logs to TCP, Apache SkyWalking, Apache Kafka, or ClickHouse servers, in batches. You can specify the severity level of which the plugin should send the corresponding logs. - [error-log-logger](https://docs.api7.ai/hub/error-log-logger.md): The error-log-logger plugin pushes APISIX's error logs to TCP, Apache SkyWalking, Apache Kafka, or ClickHouse servers, in batches. You can specify the severity level of which the plugin should send the corresponding logs. #### configuration Parameters - [Error Log Logger](https://docs.api7.ai/hub/error-log-logger/configuration.md): Parameters ### error-page The error-page plugin customizes the error page displayed when gateways encounter exceptions, enhancing user experience and business branding. - [error-page Enterprise](https://docs.api7.ai/hub/error-page.md): The error-page plugin customizes the error page displayed when gateways encounter exceptions, enhancing user experience and business branding. #### configuration Parameters - [Error Page](https://docs.api7.ai/hub/error-page/configuration.md): Parameters ### exit-transformer The exit-transformer plugin customizes API gateway responses based on status codes, headers, and bodies. When set as a global plugin, it also customizes responses for non-existent routes. - [exit-transformer Enterprise](https://docs.api7.ai/hub/exit-transformer.md): The exit-transformer plugin customizes API gateway responses based on status codes, headers, and bodies. When set as a global plugin, it also customizes responses for non-existent routes. #### 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 pushes request and response logs in batches to Google Cloud Logging Service and supports the customization of log formats. - [google-cloud-logging](https://docs.api7.ai/hub/google-cloud-logging.md): The google-cloud-logging plugin pushes request and response logs in batches to Google Cloud Logging Service and supports the customization of 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 employs a fixed window algorithm to restrict the rate of GraphQL requests based on the depth of queries or mutations, optimizing API performance and resource usage. - [graphql-limit-count](https://docs.api7.ai/hub/graphql-limit-count.md): The graphql-limit-count plugin employs a fixed window algorithm to restrict the rate of GraphQL requests based on the depth of queries or mutations, optimizing API performance and resource usage. #### configuration Parameters - [Graphql Limit Count](https://docs.api7.ai/hub/graphql-limit-count/configuration.md): Parameters ### graphql-proxy-cache The graphql-proxy-cache plugin enables caching of responses for GraphQL queries, improving API performance. - [graphql-proxy-cache](https://docs.api7.ai/hub/graphql-proxy-cache.md): The graphql-proxy-cache plugin enables caching of responses for GraphQL queries, improving API performance. #### configuration Static Configurations - [GraphQL Proxy Cache](https://docs.api7.ai/hub/graphql-proxy-cache/configuration.md): Static Configurations ### grpc-transcode The grpc-transcode plugin converts between HTTP and gRPC requests and responses, facilitating seamless communication between different API protocols. - [grpc-transcode](https://docs.api7.ai/hub/grpc-transcode.md): The grpc-transcode plugin converts between HTTP and gRPC requests and responses, facilitating seamless communication between different API protocols. #### 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 pushes request and response logs as JSON objects to HTTP(S) servers in batches, allowing for customizable log formats to enhance data management. - [http-logger](https://docs.api7.ai/hub/http-logger.md): The http-logger plugin pushes request and response logs as JSON objects to HTTP(S) servers in batches, allowing for customizable log formats to enhance data management. #### 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 JWE authorization headers in requests directed to routes or services, enhancing API security. - [jwe-decrypt](https://docs.api7.ai/hub/jwe-decrypt.md): The jwe-decrypt plugin decrypts JWE authorization headers in requests directed to routes or services, enhancing API security. #### configuration Parameters - [JWE Decrypt](https://docs.api7.ai/hub/jwe-decrypt/configuration.md): Parameters ### jwt-auth The jwt-auth plugin supports the use of JSON Web Token (JWT) for client authentication before accessing upstream resources, enhancing API security measures. - [jwt-auth](https://docs.api7.ai/hub/jwt-auth.md): The jwt-auth plugin supports the use of JSON Web Token (JWT) for client authentication before accessing upstream resources, enhancing API security measures. #### 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 an LDAP directory and maps the authenticated user onto a consumer, so directory identities can be used with per-consumer plugins, rate limits, and analytics. - [ldap-auth-advanced](https://docs.api7.ai/hub/ldap-auth-advanced.md): The ldap-auth-advanced plugin authenticates clients against an LDAP directory and maps the authenticated user onto a consumer, so directory identities can be used with per-consumer plugins, rate limits, and analytics. #### configuration Parameters - [LDAP Auth Advanced](https://docs.api7.ai/hub/ldap-auth-advanced/configuration.md): Parameters ### limit-conn The limit-conn plugin restricts the rate of requests by managing concurrent connections. Requests exceeding the threshold may be delayed or rejected, ensuring controlled API usage and preventing overload. - [limit-conn](https://docs.api7.ai/hub/limit-conn.md): The limit-conn plugin restricts the rate of requests by managing concurrent connections. Requests exceeding the threshold may be delayed or rejected, ensuring controlled API usage and preventing 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 request and response logs as JSON objects to Grafana Loki in batches via the Loki HTTP API, allowing for customizable log formats to enhance data management. - [loki-logger](https://docs.api7.ai/hub/loki-logger.md): The loki-logger plugin sends request and response logs as JSON objects to Grafana Loki in batches via the Loki HTTP API, allowing for customizable log formats to enhance data management. #### 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 supports proxying and load balancing MQTT requests to MQTT servers, enhancing API operation and management. - [mqtt-proxy](https://docs.api7.ai/hub/mqtt-proxy.md): The mqtt-proxy plugin supports proxying and load balancing MQTT requests to MQTT servers, enhancing API operation and management. #### 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 ensures requests and responses comply with defined Open API schemas, enhancing API management and operational integrity. - [oas-validator](https://docs.api7.ai/hub/oas-validator.md): The oas-validator plugin ensures requests and responses comply with defined Open API schemas, enhancing API management and operational integrity. #### 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 The openapi-to-mcp plugin lets API7 expose OpenAPI services through MCP, proxy requests with custom headers, and support real-time SSE streaming. - [openapi-to-mcp Enterprise](https://docs.api7.ai/hub/openapi-to-mcp.md): The openapi-to-mcp plugin lets API7 expose OpenAPI services through MCP, proxy requests with custom headers, and support real-time SSE streaming. #### 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 instruments the API gateway, sending traces to the OpenTelemetry collector for monitoring API operations per OpenTelemetry specs. - [OpenTelemetry](https://docs.api7.ai/hub/opentelemetry.md): The opentelemetry plugin instruments the API gateway, sending traces to the OpenTelemetry collector for monitoring API operations per OpenTelemetry specs. #### 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 dynamically disables NGINX proxy buffering, optimizing performance with SSE and other streaming upstream services in API gateway. - [proxy-buffering](https://docs.api7.ai/hub/proxy-buffering.md): The proxy-buffering plugin dynamically disables NGINX proxy buffering, optimizing performance with SSE and other streaming upstream services in API gateway. #### configuration Parameters - [Proxy Buffering](https://docs.api7.ai/hub/proxy-buffering/configuration.md): Parameters ### proxy-cache The proxy-cache plugin caches responses based on keys, supporting disk and memory caching for GET, POST, and HEAD requests, enhancing API performance. - [proxy-cache](https://docs.api7.ai/hub/proxy-cache.md): The proxy-cache plugin caches responses based on keys, supporting disk and memory caching for GET, POST, and HEAD requests, enhancing API performance. #### configuration Static Configurations - [Proxy Cache](https://docs.api7.ai/hub/proxy-cache/configuration.md): Static Configurations ### proxy-mirror The proxy-mirror plugin duplicates ingress traffic to API gateway, forwarding it to a designated upstream while keeping regular services uninterrupted. - [proxy-mirror](https://docs.api7.ai/hub/proxy-mirror.md): The proxy-mirror plugin duplicates ingress traffic to API gateway, forwarding it to a designated upstream while keeping regular services uninterrupted. #### 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 pushes request and response logs as JSON objects to RocketMQ clusters in batches, allowing for customizable log formats to enhance data management. - [rocketmq-logger](https://docs.api7.ai/hub/rocketmq-logger.md): The rocketmq-logger plugin pushes request and response logs as JSON objects to RocketMQ clusters in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [RocketMQ Logger](https://docs.api7.ai/hub/rocketmq-logger/configuration.md): Parameters ### saml-auth The saml-auth plugin enables user authentication via SAML 2.0 in the API gateway by interacting with identity providers (IdP), enhancing API security. - [saml-auth](https://docs.api7.ai/hub/saml-auth.md): The saml-auth plugin enables user authentication via SAML 2.0 in the API gateway by interacting with identity providers (IdP), enhancing API security. #### 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 integrates with Apache SkyWalking for effective request tracing, enhancing API observability. - [SkyWalking](https://docs.api7.ai/hub/skywalking.md): The skywalking plugin integrates with Apache SkyWalking for effective request tracing, enhancing API observability. #### configuration Static Configurations - [skywalking](https://docs.api7.ai/hub/skywalking/configuration.md): Static Configurations ### skywalking-logger The skywalking-logger pushes request and response logs as JSON objects to SkyWalking OAP server in batches, allowing for customizable log formats to enhance data management. - [skywalking-logger](https://docs.api7.ai/hub/skywalking-logger.md): The skywalking-logger pushes request and response logs as JSON objects to SkyWalking OAP server in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [SkyWalking Logger](https://docs.api7.ai/hub/skywalking-logger/configuration.md): Parameters ### soap The soap plugin simplifies transformation between RESTful HTTP requests and SOAP requests, including their corresponding responses, for better API interoperability. - [soap Enterprise](https://docs.api7.ai/hub/soap.md): The soap plugin simplifies transformation between RESTful HTTP requests and SOAP requests, including their corresponding responses, for better API interoperability. #### configuration Static Configurations - [SOAP](https://docs.api7.ai/hub/soap/configuration.md): Static Configurations ### splunk-hec-logging The splunk-hec-logging plugin serializes request and response context information to Splunk Event Data format and push to your Splunk HTTP Event Collector (HEC) in batches, allowing for customizable log formats to enhance data management. - [splunk-hec-logging](https://docs.api7.ai/hub/splunk-hec-logging.md): The splunk-hec-logging plugin serializes request and response context information to Splunk Event Data format and push to your Splunk HTTP Event Collector (HEC) in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [splunk-hec-logging](https://docs.api7.ai/hub/splunk-hec-logging/configuration.md): Parameters ### syslog The syslog plugin pushes request and response logs as JSON objects to syslog servers in batches, allowing for customizable log formats to enhance data management. - [syslog](https://docs.api7.ai/hub/syslog.md): The syslog plugin pushes request and response logs as JSON objects to syslog servers in batches, allowing for customizable log formats to enhance data management. #### configuration Parameters - [syslog](https://docs.api7.ai/hub/syslog/configuration.md): Parameters ### traffic-label The traffic-label plugin labels traffic based on user-defined rules, enabling actions based on labels and associated weights for improved API traffic management. - [traffic-label](https://docs.api7.ai/hub/traffic-label.md): The traffic-label plugin labels traffic based on user-defined rules, enabling actions based on labels and associated weights for improved API 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 ### 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 Learn how to configure APISIX or API7 Ingress Controller to configure upstream health checks. - [Configure Upstream Health Checks](https://docs.api7.ai/ingress-controller/configure-upstream-health-checks.md): Learn how to configure APISIX or API7 Ingress Controller to configure upstream health checks. ### custom-plugins #### lua Learn how to load Lua custom plugins into gateways in a Kubernetes environment and apply them to routes using APISIX or API7 Ingress Controller. - [Deploy Lua Custom Plugins](https://docs.api7.ai/ingress-controller/custom-plugins/lua.md): Learn how to load Lua custom plugins into gateways in a Kubernetes environment and apply them to routes using APISIX or API7 Ingress Controller. #### 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 Learn how to configure leader election for API7 or APISIX Ingress Controller to enable high availability in production. - [AIC High Availability](https://docs.api7.ai/ingress-controller/high-availability.md): Learn how to configure leader election for API7 or APISIX Ingress Controller to enable high availability in production. ### 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 Learn how to configure cross-namespace references in the Ingress Controller using Gateway API and ReferenceGrant. - [Configure Cross-Namespace References](https://docs.api7.ai/ingress-controller/production/cross-namespace.md): Learn how to configure cross-namespace references in the Ingress Controller using Gateway API and ReferenceGrant. ### 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 Learn how to create a route with the Ingress Controller to proxy requests to a sample HTTP upstream service and verify routing, enabling efficient API traffic management. - [Proxy Requests to a Service](https://docs.api7.ai/ingress-controller/proxy-requests-to-a-service.md): Learn how to create a route with the Ingress Controller to proxy requests to a sample HTTP upstream service and verify routing, enabling efficient API traffic management. ### 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 Learn how to configure APISIX or API7 Ingress Controller to configure routes to proxy WebSocket connections. - [Proxy WebSocket Connection](https://docs.api7.ai/ingress-controller/proxy-websocket-connection.md): Learn how to configure APISIX or API7 Ingress Controller to configure routes to proxy WebSocket connections. ### 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. ### set-up-ingress-controller-and-gateway Learn how to quickly deploy and configure API7 Ingress Controller or APISIX Ingress Controller for managing Kubernetes ingress traffic. - [Set Up Ingress Controller and Gateway](https://docs.api7.ai/ingress-controller/set-up-ingress-controller-and-gateway.md): Learn how to quickly deploy and configure API7 Ingress Controller or APISIX Ingress Controller for managing Kubernetes ingress 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 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.