API7 Gateway Release Notes

3.10.4

Release Date: 2026-07-27

Upgrade Notes

Upgrade note — logger body size limits are validated more strictly

max_req_body_bytes and max_resp_body_bytes are now validated as integers of at least 1 in the ClickHouse Logger, Elasticsearch Logger, File Logger, Loggly, Loki Logger, SkyWalking Logger, Alibaba Cloud Logging (SLS), and Syslog plugins. Values that earlier versions accepted — 0, negative numbers, and quoted numbers such as "1024" — are now rejected with HTTP 400.

After the upgrade, existing routes that carry such a value are listed as errors in the gateway group's compatibility report and are not published to the Data Plane; other routes are unaffected. Before upgrading, review these plugins' configurations for max_req_body_bytes or max_resp_body_bytes set to 0, a negative number, or a quoted number, and replace them with a positive integer, or remove the field to fall back to the default of 524288.

Upgrade note — structural Prometheus metric labels can no longer be disabled

The Prometheus plugin metadata now rejects disabled_labels entries that would remove a label the metric is built around — for example type on latency, or code on status. Earlier versions accepted these and produced metric series in which distinct measurements collapsed into one.

If your Prometheus plugin metadata disables one of these labels, any update to it after the upgrade is rejected with HTTP 400. Remove the structural entries from disabled_labels before upgrading. Non-structural labels such as route, service, and consumer can still be disabled.

Features

Plugins

• OpenID Connect
  • Added set_raw_id_token_header. When enabled, the raw ID token issued by the identity provider is forwarded to the upstream service in the X-Raw-ID-Token header, so the upstream can verify the token signature itself instead of trusting the gateway's decoded claims.
• Proxy Rewrite
  • headers.set and headers.add now accept an array of values for a single header name, which is sent upstream as separate header lines rather than one comma-joined line. This matters for upstream services that read only the first occurrence of a header name, or that parse repeated headers differently from a single comma-joined value.
• Kafka Logger
  • Added tls for connecting to Kafka brokers over TLS, with tls.verify controlling broker certificate verification. Previously the plugin could only connect in plaintext, so a broker listening on a TLS port received no logs at all.
• Rate-limiting and cache plugins
  • Added Redis connection keepalive settings (redis_keepalive_timeout and redis_keepalive_pool) to the Redis and Redis Cluster policies in Limit Conn, Limit Req, and AI Cache, so operators can tune idle timeout and connection pool size.
• Body-buffering plugins
  • Added max_req_body_size and max_resp_body_size to bound how much of a request or response body a plugin reads into memory, defaulting to 67108864 bytes (64 MiB). A request body larger than the limit is rejected, and a response body is truncated at the limit — except in Proxy Cache, where an oversized response is streamed through without being cached — so one large body cannot exhaust worker memory. Available in AI Proxy, AI Proxy Multi, AI Request Rewrite, the AI prompt plugins, Request Validation, OAS Validator, Body Transformer, Response Rewrite, Proxy Cache, gRPC Transcode, SOAP, and other plugins that buffer bodies.
• Logger plugins
  • Added max_req_body_bytes and max_resp_body_bytes to the remaining logger schemas — ClickHouse Logger, Elasticsearch Logger, File Logger, Loggly, Loki Logger, SkyWalking Logger, Alibaba Cloud Logging (SLS), and Syslog — so the body size limits are validated at configuration time and shown in the Dashboard (see Upgrade Notes).

Data Plane

• Added nginx_config.stream.real_ip_from, which lists the addresses trusted to send a PROXY protocol header on stream (TCP/UDP) ports. On a connection from a trusted address, the client address is taken from the PROXY protocol header instead of the directly connected peer, so stream logs and address-based plugins see the real client rather than the load balancer in front of the gateway. It is empty by default and only takes effect on ports that accept the PROXY protocol.
• Upgraded the health check engine. Check targets are now reconciled incrementally instead of being destroyed and rebuilt, so scaling an upstream up or down no longer leaves a window in which no node is being checked, and the accumulated health state and failure counters of unchanged nodes are preserved instead of being reset.
• The Apisix-Plugins debug response header now lists the plugins that actually ran, in execution order and annotated with the phase each ran in (for example limit-count#access, response-rewrite#header_filter), instead of an unordered list of configured plugins.

Control Plane

• The /api/fe-config endpoint is now served by the Control Plane binary and driven by console.* configuration keys, so the Dashboard's hybrid mode, browser error reporting (Sentry), and a custom sidebar group of external links can be configured through the Control Plane configuration or the Helm chart. Menu items that do not have a name and an absolute http/https URL are dropped instead of being served to the Dashboard.
• Service conflict checks now take route methods into account. Routes on the same host and path that serve disjoint method sets (for example GET /foo and POST /foo) are no longer reported as conflicting; an identical method scope is reported as duplicate, and a partially shared scope is reported as overlapping. A route without methods still matches all methods.
• Added an opt-in SSRF guard for outbound connections to user-configured endpoints. When security.ssrf_protection.enable is set, the Control Plane refuses to connect to loopback, private, link-local, and carrier-grade NAT addresses — including host names that resolve to them — which prevents features such as service registries and SMTP settings from being used to probe internal services or cloud metadata endpoints.

Console (Dashboard)

• The Control Plane version is now shown in the top bar next to the organization menu and can be copied with a single click, instead of only being available at the bottom of the organization dropdown.
• Resources synchronized by ADC (which carry the managed-by=adc label) are now marked with a Managed by ADC tag and a banner on their detail pages, and edit, delete, and create actions on them warn that the next ADC sync overwrites manual changes and removes manually added children. Resources under a managed service or consumer are covered even when the child itself carries no label. The warnings are advisory and do not block the operation.
• The conflict dialog for services and routes now shows a Methods column, so it is clear on which methods two routes collide. Routes without methods are shown as All.

Fixes

Plugins

• AI Proxy, AI Proxy Multi, and AI Request Rewrite
  • Fixed issue: The requests the gateway sent to the LLM provider carried the client's own headers, including Cookie, Authorization, and arbitrary custom headers, exposing end-user credentials to the upstream provider. The gateway now sends only the headers the plugin itself sets.
  • Fixed issue: On an error response from the LLM, $apisix_upstream_response_time and $llm_time_to_first_token were logged in seconds (for example 0.240) or as 0, while successful responses were logged in milliseconds. Error-path values are now reported in milliseconds, consistent with the success path.
• OpenID Connect
  • Fixed issue: Delivering an authorization callback whose state no longer matched the session — for example after starting a second login flow in the same browser — returned HTTP 500. The gateway now redirects to the originally requested page instead.
  • Fixed issue: An empty JSON array in the identity provider's user info (for example "roles": []) was re-encoded as an empty object ({}) in the X-Userinfo header on requests served from an existing session, so upstream services that parse the field as an array failed. Empty arrays now stay arrays.
• wolf-rbac
  • Fixed issue: When the authentication service returned success without userInfo, the client's own X-UserId, X-Username, and X-Nickname headers were forwarded to the upstream service, letting a caller present any identity it chose. These headers are now always cleared before the request is proxied.
• Limit Count
  • Fixed issue: With window_type: sliding and delayed synchronization, the remaining quota was reported without the sliding-window weighting, so the gateway admitted noticeably more requests than configured around window boundaries. The remaining count is now window-weighted.
• Limit Conn and Limit Req
  • Fixed issue: Redis connections were not returned to the keepalive pool, so every request opened a new Redis connection and the configured keepalive settings had no effect. Connections are now pooled and reused.
• Prometheus
  • Fixed issue: When the shared dictionary used for metrics filled up, the gateway could enter a loop that held a worker at 100% CPU and did not recover after traffic stopped. A full dictionary now degrades gracefully, logging that reported metric data may be incomplete.

Data Plane

• Fixed issue: With the least_conn load balancer, adding or removing an upstream node discarded the tracked connection counts, so the balancer degraded to round robin and sent new requests to nodes that were already holding long-lived connections. Load state is now preserved across upstream scaling.
• Fixed issue: When a plugin field referenced a secret that could not be resolved — an unset environment variable, or an error from the secret manager — the failure was silent and the unresolved reference was used as the literal value. The gateway now logs an error identifying the reference and the field it appears in.
• Fixed issue: The gateway read its host name by executing /bin/hostname, so on images that do not ship that binary it reported no host name and gateway instances appeared without a host name in the Dashboard. The host name is now read through a system call.
• Fixed issue: Entries in nginx_config.envs whose values contained spaces, quotes, or backslashes produced an invalid NGINX configuration and the gateway failed to start. These values are now quoted and escaped correctly.
• Fixed issue: Stopping and immediately restarting the gateway through the CLI could fail because the previous instance had not finished exiting. The CLI now waits for it to stop before starting the new one.
• Fixed issue: After a gateway container was killed rather than shut down cleanly, leftover worker event sockets could prevent the next start from binding. They are now removed during startup.
• Fixed issue: On arm64, a dependency pulled a second copy of the JSON library into the gateway's module path, shadowing the bundled one and encoding empty arrays as invalid JSON. The redundant dependency is removed, so the bundled library is always used.

Control Plane

• Fixed issue: Two concurrent PATCH requests against the same resource could each read the resource before the other wrote it, so only the last write survived even though both requests reported success. PATCH requests on the same resource are now serialized.
• Fixed issue: PATCH /apisix/admin/routes applied the patch without validating the result against the route schema, so a patch could persist a route that exceeded a schema limit — for example more than 64 paths — which later PUT requests and adc sync then rejected. The merged result is now validated before it is stored.
• Fixed issue: Pooled database connections were reused indefinitely, so after a database failover the Control Plane could keep using connections pinned to a demoted, now read-only primary. Connection lifetime is now bounded at one hour by default and can be tuned with database.max_lifetime.
• Fixed issue: Importing a license whose certificate chain had expired reported license certificate comes from an invalid issuer, pointing at the signing authority rather than at the expiry. An expired or not-yet-effective certificate chain now reports a dedicated message that includes the relevant timestamp. Certificates from a genuinely unknown authority still report an invalid issuer.
• Fixed issue: The current data plane core count included instances that had stopped sending heartbeats, which stay in LostConnection for up to two hours before being marked offline, so the Dashboard's core usage remained inflated long after a data plane was scaled down or crashed. Only connected instances in standard running mode are counted now. License accounting, which is computed from heartbeat usage, is unchanged.

Console (Dashboard)

• Fixed issue: The route paths and service hosts forms allowed adding entries beyond the schema limits of 64 paths and 32 hosts. Creating such a resource failed with a raw server error, and editing one could store a configuration that adc validate and adc sync later rejected. The Add control is now hidden once a list reaches its limit, while lists that are already over the limit still show every entry so the excess can be removed.

3.10.3

Release Date: 2026-07-14

Upgrade Notes

Upgrade note — higher default gateway memory usage

Several Data Plane shared memory (lua_shared_dict) defaults were raised, so a 3.10.3 gateway reserves about 365 MiB more shared memory at startup than 3.10.2 with the default configuration:

Shared dictionary	3.10.2 default	3.10.3 default
prometheus-metrics (advanced metrics)	15 MiB	128 MiB
kubernetes, nacos, nacos-stream, consul (service discovery)	20 MiB each	64 MiB each
tracing_buffer (SkyWalking)	10 MiB	32 MiB
api-calls-for-portal	10 MiB	64 MiB

These dictionaries are allocated when the gateway starts, whether or not the corresponding feature is in use, so the increase applies to every 3.10.3 gateway. Before upgrading, raise the gateway container's memory requests and limits (in Kubernetes, also review node memory-pressure and eviction thresholds) so the gateway is not OOM-killed. If you do not use a given feature — for example a service discovery type you have not configured — you can lower its dictionary back toward the previous value through the gateway configuration, or through the shared-dict values in the Helm chart.

Upgrade note — built-in user login policy is stricter

Built-in Dashboard users are now temporarily locked out after repeated failed password attempts. The default policy is enabled, bans the user and source IP after 5 consecutive failures, and lasts 15 minutes. Administrators can tune or disable it through the new login failure restriction system setting. New passwords and passwords changed after upgrade must also be at least 12 characters and still satisfy the existing complexity requirements. Existing passwords are not revalidated at sign-in.

If a built-in user enables two-factor authentication, HTTP Basic Auth for that user is rejected because Basic Auth cannot provide a second factor. Use access tokens for programmatic integrations instead; token authentication is sent with the X-API-KEY header and does not require a 2FA verification code.

Upgrade note — forwarded headers are trusted only from trusted addresses

The gateway now uses apisix.trusted_addresses to decide whether client-supplied X-Forwarded-* and RFC 7239 Forwarded headers are trusted. When trusted_addresses is not configured, or when the request comes from an untrusted address, the gateway overwrites X-Forwarded-Proto, X-Forwarded-Host, and X-Forwarded-Port with gateway-observed values and clears the Forwarded header before proxying upstream. If an upstream application depends on the original forwarded protocol, host, or port sent by a trusted load balancer or reverse proxy, configure that proxy's IP or CIDR in trusted_addresses.

Upgrade note — OpenID Connect silent re-authentication is no longer enabled by default

The openid-connect plugin no longer sets refresh_session_interval to 900 seconds by default. Periodic silent re-authentication now happens only when refresh_session_interval is explicitly configured. If your deployment relied on the previous 900-second refresh behavior, set refresh_session_interval: 900 before or during the upgrade.

Upgrade note — SQL Server deployments enable snapshot reads on first startup

For SQL Server-backed deployments, the Control Plane now creates and prepares the database before other components connect, and enables READ_COMMITTED_SNAPSHOT to prevent gateway configuration reads from blocking behind writes. On an existing SQL Server database where this setting is still disabled, the first startup applies the database-level change with ROLLBACK IMMEDIATE; in-flight database transactions and sessions can be disconnected once, after which connection pools reconnect and later starts are no-ops.

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.10.3 Control Plane encrypts these fields while an older 3.10.2 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• ai-cache: semantic.embedding.openai.api_key, semantic.embedding.azure_openai.api_key

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.10.3 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.10.3.

Features

Plugins

• AI Cache
  • Added a semantic (L2) cache layer that matches prompts by embedding similarity through RediSearch, in addition to exact-match caching. Streaming LLM responses can now be cached and replayed instead of being bypassed. New Prometheus metrics report cache hits, misses, bypasses, and embedding latency.
• AI Aliyun Content Moderation
  • Added request_check_roles to choose which request roles are moderated (user, tool, and/or system). user and tool content follow request_check_mode (last or all, default last), while system content is checked on every request when selected. Long content is now split into chunks in linear time and is multi-byte (UTF-8) safe.
• AI AWS Content Moderation
  • Request moderation now runs after AI protocol detection and checks the decoded prompt content that the upstream LLM sees, rather than the raw HTTP JSON envelope. Deny responses are returned in a provider-compatible format, with configurable check_request, deny_code, and deny_message.
• IP Restriction
  • Added a configurable response_code (either 403 or 404, default 403) returned when a request is blocked, so operators can respond with 404 to avoid revealing whether a resource exists.
• File Logger
  • The log file path can now be set once in the plugin metadata and shared across routes, instead of being required in every route's plugin configuration. A path set in the plugin configuration still takes precedence over the metadata value.
• Logger plugins
  • Added max_req_body_bytes and max_resp_body_bytes to the schemas of HTTP Logger, RocketMQ Logger, TCP Logger, Tencent Cloud CLS, and UDP Logger, so the request/response body size limits (default 524288 bytes) are validated at configuration time and shown in the Dashboard.
• Rate-limiting plugins
  • Added Redis connection keepalive settings (redis_keepalive_timeout and redis_keepalive_pool) for the Redis and Redis Cluster policies in Limit Count, Limit Count Advanced, GraphQL Limit Count, and AI Rate Limiting, so operators can tune idle timeout and connection pool size.

Data Plane

• Added apisix.trusted_addresses, which controls whether the gateway trusts client-supplied X-Forwarded-* and Forwarded headers based on the resolved client address.
• Added apisix.match_uri_encoded_slash. When enabled, an encoded slash (%2F) stays encoded during route matching so it can be treated as part of a path parameter instead of a path separator.
• In standalone YAML mode, environment-variable placeholders are now resolved before YAML parsing. Unquoted placeholders can become native booleans or numbers, while quoted placeholders stay strings, preserving large IDs and token values exactly.

Control Plane

• Added TOTP two-factor authentication for built-in Dashboard users. Users can enroll, enable, disable, and recover 2FA from their account settings, and administrators can reset a user's 2FA state.
• Added login failure restriction for built-in users. Repeated failed logins temporarily lock the user and source IP, emit an audit event, and return a clear lockout message.
• Added the Dashboard UI for two-factor authentication: account setup with QR code and recovery codes, an OTP step during login, and an administrator action to reset a user's 2FA state.
• Updated password forms and generated passwords to use the new 12-character minimum length.

Developer Portal

• Added an option to require two-factor authentication. When 2FA is enabled and twoFactor.required is set, developers must complete 2FA enrollment before they can access protected pages, and the requirement is enforced both at sign-in and at the proxy layer.

Fixes

Plugins

• AI Proxy and AI Proxy Multi
  • Fixed issue: Anthropic Messages requests that contained tool results mixed with other content could be converted into an invalid OpenAI Chat message order, causing OpenAI-compatible upstreams to reject every later request in the session. Tool messages are now emitted immediately after the assistant tool-call message, and adjacent text or media is preserved in a following user message. Several other Anthropic-to-OpenAI conversion details were aligned with LiteLLM-compatible behavior, including tool name sanitization, long tool-name collision handling, adaptive thinking effort, structured-output schema extraction, empty array encoding, and content block shaping.
  • Fixed issue: Structured chat content could reach downstream AI plugins as a table and cause request processing errors. Protocol adapters now flatten text content consistently before AI guard and cache plugins consume it.
• AI Lakera Guard
  • Fixed issue: In streaming responses with action: alert and fail_open: false, a Lakera API error or timeout could let the streamed response through instead of failing closed. Lakera errors are now handled according to fail_open, so a strict configuration blocks the response.
• AI AWS Content Moderation and AI Aliyun Content Moderation
  • Fixed issue: deny_code accepted arbitrary numbers. It is now validated as an integer HTTP status code in the 200–599 range (default 200), so an out-of-range value is rejected at configuration time.
• AI Aliyun Content Moderation
  • Fixed issue: Returning ngx.OK from the body filter could interrupt later body-filter processing. The plugin now returns normally so other filters can continue.
• AI Rate Limiting
  • Fixed issue: Some configured Redis fields were dropped and replaced with defaults — redis_username/redis_password for the redis-sentinel policy and redis_keepalive_timeout/redis_keepalive_pool for the redis and redis-cluster policies. All configured Redis fields are now forwarded.
• gRPC Transcode
  • Fixed issue: Empty protobuf repeated fields were encoded as {} instead of JSON arrays ([]). Empty repeated fields now appear as arrays, including nested and descriptor-set based messages.
• Key Auth and other consumer authentication plugins
  • Fixed issue: If a consumer credential referenced a secret that could not be resolved, the Data Plane could still index the unresolved literal value and authenticate requests with it. Consumer authentication now fails closed when a referenced secret cannot be resolved.
• Secret references
  • Fixed issue: Updates or deletions of /secrets configuration did not invalidate the secret LRU cache, so old secret values could continue to be used until cache expiry or indefinitely. Secret references are now re-resolved after secret configuration changes.
• Proxy Rewrite
  • Fixed issue: With use_real_request_uri_unsafe and uri configured together, the request query string was dropped during URI rewriting. The original query string is now preserved and correctly merged when the rewritten URI already contains a query.
• Loggly
  • Fixed issue: Batched Loggly entries from different routes could use the wrong token or tags because the async handler reused the latest route configuration. Each batch processor now keeps its own route configuration.
• Datadog
  • Fixed issue: Large coalesced DogStatsD datagrams could exceed the common 8192-byte agent buffer and be silently truncated. The plugin now coalesces only when the payload fits, otherwise it falls back to one datagram per metric.
• Zipkin
  • Fixed issue: Requests explicitly marked as unsampled still built full span tag tables and access-phase child spans. Unsampled requests now skip that extra tracing work while preserving trace propagation.
• OpenTelemetry
  • Fixed issue: Updating OpenTelemetry plugin metadata at runtime did not rebuild the tracer used for injected core spans, so those spans could keep using stale collector or resource settings until worker recycle. The tracer now refreshes when metadata changes.
  • Fixed issue: additional_attributes were evaluated before log-phase variables were populated, so attributes that depend on final request state could be missing or stale. They are now evaluated in the log phase.
  • Fixed issue: With trace_id_source set to x-request-id, an X-Request-Id value that is not valid hexadecimal (for example a UUID), or a duplicated header, could return HTTP 500. The value is now validated and the plugin falls back to a random valid trace ID when it cannot be used.
  • Fixed issue: The plugin metadata schema accepted non-scalar values for resource attributes and collector.request_headers, which were then silently dropped at runtime. Such values are now rejected at configuration time.
• OpenID Connect
  • Fixed issue: refresh_session_interval incorrectly defaulted to 900, enabling silent re-authentication even when users did not configure it. The default is removed (see Upgrade Notes).
• MQTT Proxy
  • Fixed issue: protocol_name was required even though the standard default is MQTT. It is now optional and defaults to MQTT.
• Forward Auth
  • Fixed issue: When request_method was POST, the authorization request could forward the client's Transfer-Encoding, Content-Length, and Expect headers after the body had already been buffered, producing inconsistent request framing. These client framing headers are no longer copied to the auth service.
• Authz CASBIN
  • Fixed issue: Routes using different Casbin model or policy shapes could trigger casbin enforce error / invalid request size after switching between them. The bundled lua-casbin dependency is updated to include the enforcement fixes.
• Request ID
  • Fixed issue: Configuring algorithm: range_id without the optional range object could return HTTP 500. The range object now has a default value.
• Workflow
  • Fixed issue: Workflow action plugins could run _meta.pre_function hooks before workflow skipped or executed the action, changing behavior even for actions that should not run. Workflow now decides whether to run the action before executing those meta hooks.
• Request Validation
  • Fixed issue: A form body whose Content-Type carried a charset parameter or different casing (for example application/x-www-form-urlencoded; charset=utf-8) was not recognized as form-urlencoded, so it was parsed as JSON and rejected with HTTP 400. Such content types are now recognized and validated as form bodies.

Data Plane

• Fixed issue: Log rotation could leave some log files open after only part of the file set was rotated. The gateway now reopens logs correctly after partial rotation.
• Fixed issue: When the configuration source reported a smaller revision than the gateway had already seen (for example after the Control Plane database was restored to an earlier state), the gateway could keep serving stale configuration until a worker restart. It now forces a full configuration resync when a smaller revision is observed.
• Fixed issue: A plugin attached through a global rule or a consumer (such as ai-proxy-multi) could fail with HTTP 5xx because the gateway could not fetch the plugin's parent configuration at request time. All plugin-bearing resource types are now resolved correctly.
• Fixed issue: With client-control configured with max_body_size: 0 (no limit), a chunked request body could still be rejected with HTTP 413. A max_body_size of 0 now correctly disables the size check for chunked requests.

Control Plane

• Fixed issue: Gateway instances could be marked OutOfSync for a short window immediately after a configuration revision changed, before the next heartbeat reported the new revision. A grace period now keeps recently heartbeating instances Healthy during that normal synchronization window.
• Fixed issue: Compatibility reports were capped at 200 unordered items, so large reports could hide errors and differ between gateway instances. The Control Plane now stores the full sorted report and computes compatibility from all items.
• Fixed issue: A secret provider request body could match a different provider type than the provider named in the URL path, causing the Data Plane to discard or misread the stored secret. The Control Plane now validates the body against the selected provider type.
• Fixed issue: The Control Plane accepted some core resource configurations that the Data Plane silently discarded, including invalid TLS, filter, and IP match configurations. These are now rejected by validation before publishing.
• Fixed issue: Plugin configurations on the runtime services endpoint were not validated, so a service with an invalid plugin configuration was accepted and then silently discarded by the Data Plane. Service plugin configurations are now validated and rejected with HTTP 400 when invalid.
• Fixed issue: IPv6 upstream node hosts were rejected by the OpenAPI schema. IPv6 hosts are now accepted.
• Fixed issue: Batch ssls validation used the SNI schema instead of the SSL schema, so entries without required certificate fields could pass validation. Batch SSL validation now uses the correct schema.
• Fixed issue: Audit log export returned only the first 256 rows. Exports now include all matching audit logs.
• Fixed issue: Credential lookup indexes could be dropped by components that do not run database migration, and some startup schema repairs rebuilt current indexes unnecessarily. Schema repair now keeps current indexes and repairs only stale shapes.
• Fixed issue: Heartbeat and instance status queries could become slow on large deployments. Additional indexes and Go-side status computation improve these lookups.

3.10.2

Release Date: 2026-06-29

Upgrade Notes

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.10.2 Control Plane encrypts these fields while an older 3.10.1 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• limit-count, limit-count-advanced, and graphql-limit-count: redis_password, sentinel_password
• limit-conn: redis_password
• limit-req: redis_password
• ai-rate-limiting: redis_password, sentinel_password
• elasticsearch-logger: headers (the custom authentication headers)
• openid-connect: session.redis.password
• ai-cache: redis_password
• ai-lakera-guard: api_key

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.10.2 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.10.2.

Upgrade note — hmac-auth default request body limit raised to 64 MiB

When hmac-auth has validate_request_body enabled, the default max_req_body_size is now 67108864 bytes (64 MiB), aligned with Apache APISIX. In 3.10.1 this default was 524288 bytes (512 KiB), which rejected request bodies between 512 KiB and 64 MiB with HTTP 413. After upgrading, such requests are accepted by default. If you relied on the lower limit, set max_req_body_size explicitly to restore it.

Upgrade note — Developer Portal signup consent configuration changed

The Developer Portal signup consent is now configured with a single signUpConsentLabel option (an HTML snippet rendered next to the consent checkbox), and the consent check is enforced only when a label is configured. The previous tosURL and beforeSignUpButtonHtml options have been removed. If your portal configuration sets either of those keys, move the content to signUpConsentLabel before upgrading; otherwise the signup consent text will no longer be shown.

Features

Plugins

• AI Cache (new plugin)
  • Caches LLM responses so that identical requests are served from a cache instead of calling the upstream model again. Exact-match caching is keyed on the normalized request body and stored in Redis; a cache hit returns the stored response with the headers X-AI-Cache-Status: HIT and X-AI-Cache-Age. Streaming requests are bypassed (X-AI-Cache-Status: BYPASS).
• AI Lakera Guard (new plugin)
  • Screens AI traffic through the Lakera Guard API to detect prompt injection and other unsafe content. The direction option (input, output, or both) selects whether the plugin scans the request prompt, the LLM response (including streaming responses), or both. Flagged traffic is blocked with a configurable deny_code, or only logged when action is set to alert.
• AI Aliyun Content Moderation
  • Added request_check_mode (last or all, default last) to control how much of a multi-turn conversation is moderated: last checks only the final user turn, while all checks every user turn. Only user-role content is moderated; system and assistant content is ignored. Long content is now split into chunks in linear time and is multi-byte (UTF-8) safe.
• AI Proxy
  • The structured llm_summary object emitted to logger plugins (when logging.summaries is enabled) now includes additional AI observability fields: stream, tool_count, has_tool_calls, end_user_id, cache_read_input_tokens, cache_creation_input_tokens, and reasoning_tokens.
• Elasticsearch Logger
  • Added support for authenticating to Elasticsearch with custom request headers via the headers option (for example, an Authorization: Bearer <token> or an API-key header), as an alternative to basic auth.
• OpenID Connect
  • Added Redis as a session storage backend. Set session.storage to redis and configure session.redis (host, port, and related options) to store sessions in Redis instead of in the session cookie; cookie remains the default.

Data Plane

• Added log_format_extra, an additive log format for logger plugins that adds fields to the default rich log format instead of replacing it (as log_format does). A new variable, $upstream_unresolved_host, records the configured upstream host before DNS resolution. log_format_extra can be set globally through plugin metadata or per route.
• Added per-port PROXY protocol control for the stream (L4) TCP proxy. Each stream_proxy.tcp entry can independently enable receiving the PROXY protocol (proxy_protocol) and sending it to the upstream (proxy_protocol_to_upstream), overriding the global defaults.
• Added the max_post_args_readable_size configuration option (default 64 MiB) that bounds how much of a request body is read when matching post_arg.* route predicates on JSON and multipart requests. Set it to 0 to disable the limit.
• Debug sessions now capture each request's logs as OpenTelemetry span events on the request's root span, so per-request logs are available in the trace without an external log collector.

Control Plane

• Added an RPM install method for the Data Plane, alongside the existing Docker and Helm options. The Dashboard's gateway-group deployment page has a new RPM tab; after the api7-gateway RPM is installed on an air-gapped host, the generated offline script provisions the gateway-group client certificate, writes the gateway configuration, and joins the instance to the Control Plane.

Developer Portal

• Disable the API Hub: operators can turn the API Hub off entirely with the apiHub.enabled configuration flag. When disabled, the API Hub link is hidden from the navigation, API Hub pages return not-found, and API Hub URLs are removed from the sitemap.
• Require email verification: signup and sign-in can be configured to require developers to verify their email address before authentication completes.
• Custom PostgreSQL schema: the portal can be deployed into a custom PostgreSQL schema instead of public, applying the schema's search_path per connection and running schema-scoped migrations.
• Organization management for platform admins: the admin Organizations page can now take over an organization (becoming its owner) or delete an organization, in addition to the existing user-management actions.
• Documentation Markdown and LLM endpoints: the in-portal documentation site now exposes Markdown and LLM-friendly text endpoints for use by AI tooling, and individual documentation pages can be excluded from those endpoints while remaining readable in the docs UI.

Fixes

Plugins

• AI Proxy
  • Fixed issue: When the upstream returned a tool call whose arguments were not valid JSON, the entire response conversion was aborted and the client received nothing. The malformed tool call now falls back to an empty argument object, and the rest of the response (including any text content) is preserved.
  • Fixed issue: A request that carried tool_choice but had no usable tools (for example, only a built-in tool that is dropped during conversion) was forwarded with the orphan tool_choice and rejected by the upstream. Such a tool_choice (and parallel_tool_calls) is now removed. Separately, a streaming Anthropic request whose upstream omitted the final completion chunk no longer hangs the client until timeout — the stream is now terminated correctly.
  • Fixed issue: When the upstream LLM returned an error status (such as HTTP 429 or 5xx), the error response body was discarded and the client received an empty body. The upstream error body and content type are now preserved, including across ai-proxy-multi fallback.
• AI Proxy Multi
  • Fixed issue: A failure while constructing the working instance pool could raise a Lua error and destructively clear pool state. The failure path is now nil-safe and non-destructive.
• Limit Count
  • Fixed issue: When count or time_window was resolved from a variable, an invalid value (non-integer, zero or negative, or beyond the safe integer range) was silently ignored, which could disable the rate limit entirely. Such values are now validated and rejected, closing a rate-limit bypass.
  • Fixed issue: With the Redis policy and sliding-window counting, the check-and-increment was not atomic, so concurrent requests could exceed the configured limit. Counting is now performed atomically with a Redis script.
• Limit Request
  • Fixed issue: The rate-limit counter was keyed so that a limit attached to a shared resource (such as a Consumer) counted each route separately instead of sharing one bucket. The counter is now keyed by the parent resource, so a Consumer-level limit is enforced across all of the Consumer's routes.
• HMAC Auth
  • Fixed issue: When validate_request_body was enabled and a request body exceeded max_req_body_size, the request was rejected with a misleading HTTP 401. It is now rejected with HTTP 413. The default max_req_body_size was also raised to 64 MiB (see Upgrade Notes).
• Attach Consumer Label
  • Fixed issue: A client could spoof a configured header when the matched Consumer had no labels, because the plugin overwrote the header only when a label value was present. Configured headers are now always stripped from the client request, even when the Consumer has no matching label.
• Redirect
  • Fixed issue: http_to_https only redirected requests whose scheme was exactly http, so a request arriving with a non-HTTP, non-HTTPS scheme (for example, via a spoofed X-Forwarded-Proto) was not redirected. It now redirects every non-HTTPS scheme.
• Response Rewrite
  • Fixed issue: When the upstream response was compressed (gzip or brotli), filters were applied to the compressed bytes and did not match, producing a corrupted body. The response is now decoded before filters run.
• Batch Requests
  • Fixed issue: When a pipelined sub-request timed out, the response array could contain more entries than there were sub-requests (an extra empty object). The number of sub-responses now always matches the number of sub-requests.
• Loki Logger
  • Fixed issue: Log labels resolved from variables were written back to the shared plugin configuration, so the first request's values were frozen and reused for all subsequent requests. Labels are now resolved per request.
• Tencent Cloud CLS
  • Fixed issue: With include_req_body enabled, the request body was not captured because it was not read in the access phase. The body is now read so that it is included in the uploaded logs.
• Authz Keycloak
  • Fixed issue: With lazy_load_paths enabled, the request query string was included when resolving the Keycloak resource by URI, so requests with query parameters failed to match a resource and were denied. The query string is now stripped before resolution.
• CAS Auth
  • Fixed issue: The CAS single-logout (SLO) callback POST was proxied to the upstream instead of being handled by the plugin. The callback is now terminated by the plugin and is no longer forwarded upstream.
• gRPC Web
  • Fixed issue: A debug log statement wrote the decoded request body to the error log. The statement has been removed so request payloads are no longer leaked into logs.

Data Plane

• Fixed issue: Resolving a dotted context variable in a log format (such as $consumer.username or $llm_summary.model) raised an error and dropped the log line when the parent object was absent (for example, an unauthenticated request that has no consumer). The missing value is now handled gracefully.
• Fixed issue: After a transient DNS or service-discovery failure, a domain-name upstream could remain stuck returning HTTP 503 even after the name resolved again. The upstream now recovers once resolution succeeds.
• Fixed issue: When a node's health changed, the consistent-hash (chash) ring was rebuilt against the healthy subset, remapping keys that belonged to healthy nodes. The ring is now kept stable so that only keys of the failed node are remapped.
• Fixed issue: Environment-variable substitution in configuration directives could match the wrong variable when one variable name was a prefix of another. Names are now resolved exactly.
• Fixed issue: Upgraded the Prometheus metrics library (nginx-lua-prometheus-api7 to 0.20260623) to remove duplicate metric series that could cause a scrape to be rejected.

Control Plane

• Fixed issue: A Data Plane running the latest gateway version was marked Incompatible when its configuration report contained errors. A latest-version Data Plane now stays Compatible, and the configuration errors are still surfaced in the compatibility report summary.

Developer Portal

• Fixed issue: Enabling or disabling two-factor authentication did not actually verify the account password, the backup-codes dialog could appear empty, and entering a wrong TOTP code at sign-in navigated to the home page instead of showing an error. Password verification, backup-code display, and TOTP error handling now work correctly.
• Fixed issue: An email-domain SSO policy was enforced only in the UI, so direct calls to the authentication endpoints could bypass it. The policy is now enforced on the server, so password sign-in, magic-link, and password-reset requests are rejected for domains that are required to use SSO.

3.10.1

Release Date: 2026-06-15

Breaking Changes

Plugins

• JWT Auth

  Upgrade note

  jwt-auth now verifies the token's exp (expiration) and nbf (not-before) claims by default. Previously, a consumer that did not set claims_to_verify (or set it to an empty list) accepted any correctly signed token, including expired ones. After the Data Plane is upgraded, such tokens are rejected with HTTP 401.

  If you relied on expired tokens being accepted, account for this behavior change before upgrading. To keep verifying only specific claims, set claims_to_verify explicitly in the consumer configuration.

• Batch Requests

  Upgrade note

  The batch-requests plugin now bounds the size of a batch. The number of pipelined sub-requests is limited by a new max_pipeline_items plugin-metadata option (default 1000); a batch that exceeds the limit is rejected with HTTP 400. Pipeline entries that contain fields other than the documented ones are now rejected, and the per-batch timeout must be at least 1 millisecond.

  If you send batches larger than 1000 sub-requests, raise max_pipeline_items in the plugin metadata. If your clients send entries with undocumented fields, remove them before upgrading.

Upgrade Notes

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.10.1 Control Plane encrypts these fields while an older 3.10.0 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• http-logger: auth_header
• kafka-logger: brokers.sasl_config.password
• splunk-hec-logging: endpoint.token
• loggly: customer_token
• openfunction: authorization.service_token
• azure-functions: authorization.apikey, and the plugin-metadata master_apikey
• ai-aws-content-moderation: comprehend.secret_access_key
• openid-connect: session.secret
• error-log-logger (plugin metadata): kafka.brokers.sasl_config.password

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.10.1 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.10.1.

Upgrade note — limit-count now includes the advanced rate-limiting features

All features that were previously exclusive to limit-count-advanced — the redis-sentinel policy, sliding-window counting, multiple independent limits in one configuration (rules), dynamic count and time_window from NGINX variables, and delayed Redis synchronization (sync_interval) — are now built into the limit-count plugin. Existing limit-count-advanced configurations continue to work unchanged (the plugin is retained as a thin wrapper), so no configuration migration is required.

One upgrade-time effect: for Redis-backed policies, the counter storage format changed and counter keys are now versioned. Existing counters are not migrated — they expire on their own TTL — so rate-limit counters reset once at the moment of upgrade. (The local policy already resets on restart.) Expect a brief counter-reset window; no action is required.

Upgrade note — request body size limits added to several plugins

To bound memory usage, several plugins now reject over-large request bodies before buffering them:

• hmac-auth: when validate_request_body is enabled, the body is limited by a new max_req_body_size option (default 524288 bytes, i.e. 512 KiB).
• forward-auth, ai-proxy, ai-proxy-multi: the body is limited by a new max_req_body_size option (default 67108864 bytes, i.e. 64 MiB); requests over the limit are rejected with HTTP 413.

These defaults are above the NGINX default client_max_body_size (1 MiB), so most deployments are unaffected. If you legitimately handle larger bodies on routes that use these plugins (and have raised client_max_body_size accordingly), raise max_req_body_size to match.

Upgrade note — Developer Portal credential secrets are shown only once

In the Developer Portal, the key-auth key and basic-auth password of a credential are now returned only once, when the credential is created or regenerated. They are no longer included in credential read or list responses, matching the existing behavior of the OAuth client_secret. Basic-auth usernames remain visible.

Copy and store the secret when it is first shown. If a secret is lost, regenerate the credential to obtain a new value. Any integration that read these secrets back from the credential read or list API must be updated to capture them at creation time.

Upgrade note — Prometheus TTFT metric replaced by a label

The standalone apisix_llm_ttft metric has been replaced by apisix_llm_latency{type="ttft"}, mirroring the structure of apisix_http_latency. If you have Prometheus queries or Grafana dashboards that reference apisix_llm_ttft, update them to select the ttft value of the type label on apisix_llm_latency.

Features

Plugins

• Limit Count
  • The advanced rate-limiting capabilities formerly provided only by limit-count-advanced are now available directly in limit-count: the redis-sentinel policy, sliding-window counting (window_type set to sliding), multiple independent limits in a single configuration (rules), count and time_window driven by NGINX variables (for example, per-consumer dynamic quotas), and delayed Redis synchronization (sync_interval).
• AI content security plugins (ai-aliyun-content-moderation, ai-aws-content-moderation, ai-prompt-guard)
  • Added a fail_mode option (skip, warn, or error; default skip) that controls how the plugin handles non-AI or non-JSON requests when it is bound at the Consumer level. With skip, such requests pass through unchecked; warn additionally logs a warning; error rejects them. This avoids errors when a Consumer-bound moderation plugin receives ordinary, non-AI traffic.
• AI Proxy
  • Added built-in NGINX variables that describe each LLM request, for use in access_log formats and logger plugins: $llm_total_tokens, $llm_stream, $llm_has_tool_calls, $llm_tool_count, $llm_end_user_id, $llm_cache_read_input_tokens, $llm_cache_creation_input_tokens, and $llm_reasoning_tokens. Values are mapped for OpenAI (Chat and Responses), Anthropic, and DeepSeek.
• Prometheus
  • Added LLM observability metrics: per-request prompt-token and completion-token distribution histograms (apisix_llm_prompt_tokens_dist, apisix_llm_completion_tokens_dist), a total-latency histogram, and time-to-first-token exposed as apisix_llm_latency{type="ttft"} for streaming requests. Histogram buckets are configurable via plugin_attr.prometheus.
  • Added mcp_request_type and mcp_tool_name labels to the http_status, http_latency, and bandwidth metrics, so MCP (Model Context Protocol) traffic can be broken down by request type (tools/list or tools/call) and by tool name. Both labels can be turned off via disabled_labels.
  • Reduced per-request overhead in the metrics logging phase by caching the disabled-labels map instead of rebuilding it on every request.
• AI Proxy Multi
  • Added max_retries and retry_on_failure_within_ms to the fallback mechanism. max_retries caps how many additional instances a request retries after a failure; retry_on_failure_within_ms only falls back when the upstream failed within the given time, so slow failures are returned to the client instead of being retried (avoiding doubled latency on long-running LLM requests).
• OpenID Connect
  • Exposed the lua-resty-session options under session (cookie name, path, domain, secure, http_only, same_site, and the idling, rolling, and absolute timeouts), so you can customize the session cookie name and set session lifetimes that take effect. The legacy session.cookie.lifetime is deprecated but still honored (mapped to absolute_timeout).
  • client_secret is now optional for flows that only verify tokens locally and never call the identity provider (bearer_only with public_key or use_jwks, private_key_jwt, and public-client PKCE). It remains required for session/callback and introspection flows.
• Kafka Logger
  • Added an api_version option (0, 1, or 2; default 1) for the Kafka produce protocol. Set api_version to 2 so that brokers record the real message timestamp (Kafka 0.10 and later); the default 1 preserves wire compatibility.

Developer Portal

• Two-factor authentication: developers can secure their account with a TOTP authenticator app. 2FA is enabled from the account security settings (confirm password, scan the QR code) and can be disabled there; sign-in then prompts for a six-digit code.
• Dark mode: the portal supports light, dark, and system themes with a toggle in the header, applied across the UI, the API-usage chart, and the docs site, and persisted across visits.
• Platform-admin console: an admin area (restricted to the configured admin users) adds a Users page to list, search, and paginate portal users, change a user's role, ban or unban, and delete users; the Organizations page can be filtered by user membership.
• Approvals in the Developer Portal: platform admins can review and act on developer-registration and API-product subscription requests from a new Approvals page in the portal. Approvals share a single source of truth with the Dashboard, and the acting admin's identity is recorded with each decision (the Dashboard's Approvals list now shows the real admin name for decisions made in the portal).
• Policy-based SSO sign-in: sign-in routes each user to the correct method (credentials, magic link, or SSO) based on the email entered. Administrators can map email domains to SSO providers, including anchored, case-insensitive regular-expression patterns, so one rule can cover many domains.
• In-portal documentation site: the portal now hosts a Markdown documentation site at /docs, themed to match the portal, with a collapsible sidebar, table of contents, code-copy buttons, a "Copy page" menu, and built-in full-text search with highlighted result snippets.
• Signup Terms of Service: new users must accept a Terms of Service agreement to complete signup; the ToS URL is configurable.
• Simplified organization creation: the "Create organization" dialog no longer asks for a slug — the identifier is assigned automatically from the name.

Fixes

Plugins

• JWT Auth
  • Fixed issue: A token whose signature was malformed (wrong length or not valid base64url) caused the verifier to raise an error and return HTTP 500 instead of rejecting the request. Malformed signatures are now rejected with HTTP 401.
• AI Proxy
  • Fixed issue: In passthrough mode, the upstream request was always sent as POST and the client's query string was dropped, breaking providers that require query parameters on other methods (for example, Azure OpenAI's ?api-version=). The client's method and query string are now forwarded.
  • Fixed issue: A timeout while reaching an upstream LLM (such as a DNS-resolution timeout) returned HTTP 500 instead of HTTP 504. Upstream LLM timeouts now correctly return HTTP 504.
• AI Proxy Multi
  • Fixed issue: After per-instance health checkers were created, the cached server picker was not rebuilt, so a worker could keep routing part of its traffic to instances already marked unhealthy; active health-check probes could also corrupt the probe path for instances configured with auth.query or auth.header. Both issues are fixed, so failover and health checking work as configured.
• Graphql Proxy Cache
  • Fixed issue: After Vary support was added to the in-memory cache, a PURGE request cleared only the legacy cache slot and left the per-Vary variants cached, so stale responses were still served until their TTL expired. PURGE now clears all variants.
• Body Transformer
  • Fixed issue: The XML-to-JSON transform intermittently dropped namespaced keys on some worker processes, causing SOAP transforms to fail with attempt to index field 'Body' (a nil value). Namespaced keys are now always preserved. Malformed multipart input now returns HTTP 400 instead of HTTP 500.
• Kafka Logger
  • Fixed issue: Messages were stored by brokers with no usable timestamp (rendered as 1970-01-01) because the Kafka produce API version could not be configured. Setting the new api_version to 2 makes brokers record the real timestamp.
• Elasticsearch Logger
  • Fixed issue: A dynamic index name using certain {time_format} placeholders could produce a corrupted index name. Invalid time formats now fall back to an empty value (with a log message) instead of corrupting the index name.
• AWS Lambda
  • Fixed issue: With IAM (SigV4) authentication, requests whose query string contained characters that need escaping, multiple values, or valueless keys produced a signature mismatch (InvalidSignatureException). The canonical query string is now built per the SigV4 specification.
• Proxy Mirror
  • Fixed issue: Mirroring a gRPC request sent the internal location name as the request path, so the mirror backend rejected every call with UNIMPLEMENTED. The original gRPC method path is now used for the mirrored request.
• Request ID
  • Fixed issue: With algorithm set to nanoid, the generator produced a high rate of duplicate and malformed IDs and leaked a file descriptor per ID. It is replaced with a CSPRNG-based generator; the ID format is unchanged and IDs are now unique and well-formed.
• OPA
  • Fixed issue: With send_headers_upstream configured, a header that the OPA server did not return was left with the client-supplied value on the upstream request instead of being cleared. Such headers are now cleared.
• SAML Auth
  • Fixed issue: Debug logging was unintentionally left enabled, and an authentication failure could pass the request through instead of returning an error. Debug mode is now off, and authentication failures return an explicit error.
• CORS
  • Fixed issue: A request with no Origin header returned HTTP 500 when allow_origins_by_regex was configured. Such requests are now handled without error.
• Multi Auth
  • Fixed issue: When an underlying auth plugin returned a status with no error message, the plugin returned HTTP 500 instead of HTTP 401. It now returns HTTP 401.
• DingTalk Auth
  • Fixed issue: A client could supply a forged X-Userinfo header that was forwarded upstream. The plugin now clears any client-supplied X-Userinfo header before authentication, so upstream services only receive plugin-verified identity information.
• Authz Casdoor
  • Fixed issue: The login session was not bound to the Casdoor token's lifetime and fell back to the session library default, so sessions could outlive their tokens. Sessions now expire when the Casdoor token expires.
• CAS Auth
  • Fixed issue: A single-logout POST with an empty body returned HTTP 500 instead of HTTP 400. Empty-body logout requests are now rejected with HTTP 400.
• Limit Conn
  • Fixed issue: A dynamic burst value (from an NGINX variable) that resolved to 0 was rejected with HTTP 500, even though a static burst of 0 is valid. A variable burst of 0 is now accepted.
• Limit Req
  • Fixed issue: Under concurrent load, the Redis-backed rate limit could be exceeded because the read and write were not atomic. Enforcement now uses a single atomic operation.

Data Plane

• Fixed issue: Redis connections were pooled by address only, so two plugin configurations pointing at the same Redis server with different databases, credentials, or TLS settings could reuse each other's connections — for example, limit-count, limit-req, or limit-conn counters could be written to the wrong Redis database. Connections are now isolated by address, database, credentials, and TLS settings, including the redis-sentinel policy.
• Fixed issue: After set_header was called with a different letter case than an existing header, the cached header table kept both entries, so plugins that iterate cached headers (such as ext-plugin-post-resp) could forward the stale value upstream. Cached header keys are now normalized.
• Fixed issue: When the workflow plugin ran in a global rule and a route plugin completed the request during the rewrite phase (for example, a CORS preflight), the log phase logged an error on every such request. The log phase now exits cleanly when its context is absent.
• Fixed issue: Enabling Nacos service discovery with the stream subsystem aborted the stream worker at startup because a required shared dictionary was not declared in the stream subsystem; it is now declared. A separate error-handling bug that turned a Nacos registry-creation failure into a worker crash is also fixed.
• Fixed issue: With Consul service discovery, a single malformed node entry caused the remaining nodes of the service to be discarded (and could drop the entire service, producing "no valid upstream node"). Only the invalid node is now skipped.
• Fixed issue: Resolving an AWS Secrets Manager reference failed when the secret name contained a slash, because the lookup split the path at the first slash. Secret names containing slashes now resolve correctly.
• Fixed issue: An Admin API PATCH re-encrypted already-encrypted plugin fields, so a PATCH on any field could corrupt stored secrets (such as key-auth keys). Encrypted fields are now decrypted before the merge and re-encrypted exactly once.

Developer Portal

• Fixed issue: Organization invitations did not honor the email-verification setting. Invitations now follow the configured email-verification behavior.
• Fixed issue: For a developer who belongs to multiple organizations, the portal could use the wrong organization context. The developer identity is now resolved from the active organization.
• Fixed issue: Several dialog widths were inconsistent across the portal; they are now unified.

3.10.0

Release Date: 2026-06-01

Breaking Changes

Plugins

• HMAC Auth

  Upgrade note

  The hmac-auth plugin now defaults signed_headers to ["date"]. After the Data Plane is upgraded, any hmac-auth configuration that does not explicitly set signed_headers requires the client signature to cover the Date header. Clients that were not signing Date will start receiving HTTP 401 with client request can't be validated.

  Before upgrading, ensure your clients sign the Date header, or set signed_headers explicitly in the plugin configuration to match what your clients sign.

Control Plane

• Service Templates and API Publishing removed

  Upgrade note

  The Service Template / Service Hub model has been removed. Services are now owned directly by gateway groups and managed through the APISIX Admin API — there is no longer a separate template, publish, version, rollback, or runtime-configuration layer. In the Console, the Service Hub section is replaced by a Services list under each gateway group.

  When the Control Plane is upgraded to 3.10.0, existing service templates and published services are automatically migrated to the new direct-service model. The original data is preserved (not dropped), so the upgrade can be rolled back. IAM permission policies that referenced service-template or published-service ARNs are backed up and rewritten automatically.

Developer Portal

• Developer authentication is enforced only for published API products

  Upgrade note

  Previously, API products in draft state also had their developer authentication rules synced to the gateway, so routes belonging to a draft product required developer authentication. Starting in 3.10.0, only published API products contribute developer-authentication rules to the data plane.

  After upgrading, routes that belong to a draft (unpublished) API product no longer require developer authentication until the product is published. If you relied on draft products being protected, publish them or restrict access another way.

Upgrade Notes

Upgrade note — Data Plane runtime upgraded to OpenResty 1.29

The Data Plane gateway runtime has been upgraded from OpenResty 1.21.4.4 to OpenResty 1.29.2.4, and now builds on the open-source apisix-runtime base. The primary motivation is to pick up the latest upstream security fixes in the NGINX core, OpenSSL, LuaJIT, and the bundled libraries by moving across several major versions.

Most deployments require no action. One visible consequence is that HTTP/2 is now enabled with the NGINX 1.25+ http2 on; directive instead of the per-listen http2 parameter; HTTP/2 over cleartext (h2c) and over TLS continues to work as before. If you maintain custom NGINX configuration snippets, verify they are compatible with the newer NGINX before upgrading.

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.10.0 Control Plane encrypts these fields while an older 3.9.13 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• feishu-auth: secret_fallbacks
• dingtalk-auth: secret_fallbacks

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.10.0 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.10.0.

Features

Plugins

• AI Proxy
  • The upstream LLM request body is now JSON-encoded with sorted keys. This produces a stable, byte-identical body for equivalent requests, which improves prompt-cache hit rates on LLM providers that cache by exact request payload.
• AI Proxy Multi
  • When an LLM endpoint domain resolves to multiple A records, the plugin now resolves all of them and builds a multi-node upstream, selecting a node per request for better load distribution and failover. The Host header and TLS SNI keep the original domain name rather than the resolved IP address.
• Proxy Cache
  • The in-memory cache strategy now honors the Vary response header. Responses are cached per variant computed from the headers listed in Vary, and responses with Vary: * are not cached.
• CAS Auth
  • cas_callback_uri now accepts an absolute URL, which is used as-is as the CAS service URL. This is useful when the gateway sits behind a proxy and the externally visible callback URL differs from the request path.

Console (Dashboard)

• Added a visual editor for permission policy statements. You can now build IAM policies by selecting resource types, actions (annotated with their access level), and conditions, without hand-writing the policy JSON.
• Configuration compatibility warnings now show each affected resource with its full business hierarchy path (for example, gateway group → service → route) instead of a bare resource ID, making it easier to locate the configuration that needs attention.

Fixes

Plugins

• Error Page
  • Fixed issue: The plugin decided whether to render a custom error page based on the upstream status variable, which could replace error responses that actually came from the upstream service. It now classifies the response source — custom error pages are rendered only for errors generated by the gateway or plugins (such as upstream connection failures or plugin-rejected requests), while genuine error responses returned by the upstream are passed through unchanged so their original body is preserved.
• Feishu Auth
  • Fixed issue: A client could supply a forged X-Userinfo header that was forwarded upstream. The plugin now clears any client-supplied X-Userinfo header before authentication, so upstream services only receive plugin-verified identity information.
• CAS Auth
  • Fixed issue: The login callback did not validate the signed initiation cookie, allowing a crafted callback request to drive the post-login redirect (CSRF / open-redirect). The callback now requires a valid signed initiation cookie and is rejected with HTTP 401 otherwise.
• DingTalk Auth
  • Fixed issue: Authentication failures and transient upstream failures were not distinguished. The plugin now returns HTTP 401 for authentication errors and HTTP 503 for transient DingTalk or upstream failures, with clearer error messages.
• Authz Casdoor
  • Fixed issue: The session cookie name was shared across Casdoor clients, so sessions for different clients could collide. The session cookie is now scoped per client (derived from client_id).
• Authz Keycloak
  • Fixed issue: When static permissions were combined with http_method_as_scope, the derived method scope was written back to the reused plugin configuration, causing scopes to accumulate across requests. The permission list is now cloned before the method scope is appended.
• GraphQL Limit Count
  • Fixed issue: The query nesting depth was miscalculated, making depth-based rate limiting inaccurate. Depth is now computed from the true maximum nesting depth with fragment expansion. Content-Type matching also tolerates a charset parameter (such as application/json; charset=utf-8), which was previously rejected.
• GraphQL Proxy Cache
  • Fixed issue: Requests whose Content-Type included a charset parameter were not recognized as GraphQL requests. Content-Type matching is now charset-tolerant, along with additional nil guards, clearer error messages, and corrected log levels.

Data Plane

• Fixed issue: When multiple logging plugins captured the response body on the same request (for example, http-logger and file-logger both with include_resp_body enabled), their response-body buffers could interfere with each other, producing truncated or mixed log output. Each logger now uses an isolated buffer.

3.9.17

Release Date: 2026-07-28

Upgrade Notes

Upgrade note — logger body size limits are validated more strictly

max_req_body_bytes and max_resp_body_bytes are now validated as integers of at least 1 in the ClickHouse Logger, Elasticsearch Logger, File Logger, Loggly, Loki Logger, SkyWalking Logger, Alibaba Cloud Logging (SLS), and Syslog plugins. Values that earlier versions accepted — 0, negative numbers, and quoted numbers such as "1024" — are now rejected with HTTP 400.

After the upgrade, existing routes that carry such a value are listed as errors in the gateway group's compatibility report and are not published to the Data Plane; other routes are unaffected. Before upgrading, review these plugins' configurations for max_req_body_bytes or max_resp_body_bytes set to 0, a negative number, or a quoted number, and replace them with a positive integer, or remove the field to fall back to the default of 524288.

Upgrade note — structural Prometheus metric labels can no longer be disabled

The Prometheus plugin metadata now rejects disabled_labels entries that would remove a label the metric is built around — for example type on latency, or code on status. Earlier versions accepted these and produced metric series in which distinct measurements collapsed into one.

If your Prometheus plugin metadata disables one of these labels, any update to it after the upgrade is rejected with HTTP 400. Remove the structural entries from disabled_labels before upgrading. Non-structural labels such as route, service, and consumer can still be disabled.

Upgrade note — OpenTelemetry metadata and content moderation deny_code are validated more strictly

Two more schemas now reject values that earlier versions accepted:

• OpenTelemetry plugin metadata accepts only scalar values — strings, numbers, and booleans — for resource attributes and for collector.request_headers. Arrays and objects, which earlier versions accepted and then silently dropped at runtime, are now rejected with HTTP 400.
• AI Aliyun Content Moderation requires deny_code to be an integer HTTP status code in the 200–599 range. AI AWS Content Moderation was already validated this way by the Control Plane; this release brings the Data Plane in line.

After the upgrade, an existing configuration that carries such a value is reported as an error in the gateway group's compatibility report, and any update to it is rejected with HTTP 400. Gateway instances stay Healthy and traffic is not affected. Before upgrading, review your OpenTelemetry plugin metadata and any AI Aliyun Content Moderation configuration, and replace or remove the offending values.

Features

Plugins

• OpenID Connect
  • Added set_raw_id_token_header. When enabled, the raw ID token issued by the identity provider is forwarded to the upstream service in the X-Raw-ID-Token header, so the upstream can verify the token signature itself instead of trusting the gateway's decoded claims.
• Proxy Rewrite
  • headers.set and headers.add now accept an array of values for a single header name, which is sent upstream as separate header lines rather than one comma-joined line. This matters for upstream services that read only the first occurrence of a header name, or that parse repeated headers differently from a single comma-joined value.
• Kafka Logger
  • Added tls for connecting to Kafka brokers over TLS, with tls.verify controlling broker certificate verification. Previously the plugin could only connect in plaintext, so a broker listening on a TLS port received no logs at all.
• Rate-limiting and cache plugins
  • Added Redis connection keepalive settings (redis_keepalive_timeout and redis_keepalive_pool) to the Redis and Redis Cluster policies in Limit Conn, Limit Req, and AI Cache, so operators can tune idle timeout and connection pool size.
• Body-buffering plugins
  • Added max_req_body_size and max_resp_body_size to bound how much of a request or response body a plugin reads into memory, defaulting to 67108864 bytes (64 MiB). A request body larger than the limit is rejected, and a response body is truncated at the limit — except in Proxy Cache, where an oversized response is streamed through without being cached — so one large body cannot exhaust worker memory. Available in AI Proxy, AI Proxy Multi, AI Request Rewrite, the AI prompt plugins, Request Validation, OAS Validator, Body Transformer, Response Rewrite, Proxy Cache, gRPC Transcode, SOAP, and other plugins that buffer bodies.
• Logger plugins
  • Added max_req_body_bytes and max_resp_body_bytes to the remaining logger schemas — ClickHouse Logger, Elasticsearch Logger, File Logger, Loggly, Loki Logger, SkyWalking Logger, Alibaba Cloud Logging (SLS), and Syslog — so the body size limits are validated at configuration time and shown in the Dashboard (see Upgrade Notes).

Data Plane

• Added nginx_config.stream.real_ip_from, which lists the addresses trusted to send a PROXY protocol header on stream (TCP/UDP) ports. On a connection from a trusted address, the client address is taken from the PROXY protocol header instead of the directly connected peer, so stream logs and address-based plugins see the real client rather than the load balancer in front of the gateway. It is empty by default and only takes effect on ports that accept the PROXY protocol.
• Upgraded the health check engine. Check targets are now reconciled incrementally instead of being destroyed and rebuilt, so scaling an upstream up or down no longer leaves a window in which no node is being checked, and the accumulated health state and failure counters of unchanged nodes are preserved instead of being reset.
• The Apisix-Plugins debug response header now lists the plugins that actually ran, in execution order and annotated with the phase each ran in (for example limit-count#access, response-rewrite#header_filter), instead of an unordered list of configured plugins.

Control Plane

• The /api/fe-config endpoint is now served by the Control Plane binary and driven by console.* configuration keys, so the Dashboard's hybrid mode, browser error reporting (Sentry), and a custom sidebar group of external links can be configured through the Control Plane configuration or the Helm chart. Menu items that do not have a name and an absolute http/https URL are dropped instead of being served to the Dashboard.
• Service conflict checks now take route methods into account. Routes on the same host and path that serve disjoint method sets (for example GET /foo and POST /foo) are no longer reported as conflicting; an identical method scope is reported as duplicate, and a partially shared scope is reported as overlapping. A route without methods still matches all methods.
• Added an opt-in SSRF guard for outbound connections to user-configured endpoints. When security.ssrf_protection.enable is set, the Control Plane refuses to connect to loopback, private, link-local, and carrier-grade NAT addresses — including host names that resolve to them — which prevents features such as service registries and SMTP settings from being used to probe internal services or cloud metadata endpoints.

Console (Dashboard)

• The conflict dialog for services and routes now shows a Methods column, so it is clear on which methods two routes collide. Routes without methods are shown as All.

Fixes

Plugins

• AI Proxy, AI Proxy Multi, and AI Request Rewrite
  • Fixed issue: The requests the gateway sent to the LLM provider carried the client's own headers, including Cookie, Authorization, and arbitrary custom headers, exposing end-user credentials to the upstream provider. The gateway now sends only the headers the plugin itself sets.
  • Fixed issue: On an error response from the LLM, $apisix_upstream_response_time and $llm_time_to_first_token were logged in seconds (for example 0.240) or as 0, while successful responses were logged in milliseconds. Error-path values are now reported in milliseconds, consistent with the success path.
• AI AWS Content Moderation and AI Aliyun Content Moderation
  • Fixed issue: deny_code accepted arbitrary numbers. It is now validated as an integer HTTP status code in the 200–599 range (default 200), so an out-of-range value is rejected at configuration time. For ai-aws-content-moderation the Control Plane already applied this validation, so this release brings the Data Plane in line; for ai-aliyun-content-moderation it now applies on both sides.
• OpenID Connect
  • Fixed issue: Delivering an authorization callback whose state no longer matched the session — for example after starting a second login flow in the same browser — returned HTTP 500. The gateway now redirects to the originally requested page instead.
  • Fixed issue: An empty JSON array in the identity provider's user info (for example "roles": []) was re-encoded as an empty object ({}) in the X-Userinfo header on requests served from an existing session, so upstream services that parse the field as an array failed. Empty arrays now stay arrays.
• wolf-rbac
  • Fixed issue: When the authentication service returned success without userInfo, the client's own X-UserId, X-Username, and X-Nickname headers were forwarded to the upstream service, letting a caller present any identity it chose. These headers are now always cleared before the request is proxied.
• Limit Count
  • Fixed issue: With window_type: sliding and delayed synchronization, the remaining quota was reported without the sliding-window weighting, so the gateway admitted noticeably more requests than configured around window boundaries. The remaining count is now window-weighted.
• Limit Conn and Limit Req
  • Fixed issue: Redis connections were not returned to the keepalive pool, so every request opened a new Redis connection and the configured keepalive settings had no effect. Connections are now pooled and reused.
• Prometheus
  • Fixed issue: When the shared dictionary used for metrics filled up, the gateway could enter a loop that held a worker at 100% CPU and did not recover after traffic stopped. A full dictionary now degrades gracefully, logging that reported metric data may be incomplete.
• OpenTelemetry
  • Fixed issue: The plugin metadata schema accepted non-scalar values for resource attributes and collector.request_headers, which were then silently dropped at runtime. Such values are now rejected at configuration time.

Data Plane

• Fixed issue: With the least_conn load balancer, adding or removing an upstream node discarded the tracked connection counts, so the balancer degraded to round robin and sent new requests to nodes that were already holding long-lived connections. Load state is now preserved across upstream scaling.
• Fixed issue: When a plugin field referenced a secret that could not be resolved — an unset environment variable, or an error from the secret manager — the failure was silent and the unresolved reference was used as the literal value. The gateway now logs an error identifying the reference and the field it appears in.
• Fixed issue: The gateway read its host name by executing /bin/hostname, so on images that do not ship that binary it reported no host name and gateway instances appeared without a host name in the Dashboard. The host name is now read through a system call.
• Fixed issue: Entries in nginx_config.envs whose values contained spaces, quotes, or backslashes produced an invalid NGINX configuration and the gateway failed to start. These values are now quoted and escaped correctly.
• Fixed issue: Stopping and immediately restarting the gateway through the CLI could fail because the previous instance had not finished exiting. The CLI now waits for it to stop before starting the new one.
• Fixed issue: After a gateway container was killed rather than shut down cleanly, leftover worker event sockets could prevent the next start from binding. They are now removed during startup.
• Fixed issue: On arm64, a dependency pulled a second copy of the JSON library into the gateway's module path, shadowing the bundled one and encoding empty arrays as invalid JSON. The redundant dependency is removed, so the bundled library is always used.

Control Plane

• Fixed issue: Two concurrent PATCH requests against the same resource could each read the resource before the other wrote it, so only the last write survived even though both requests reported success. PATCH requests on the same resource are now serialized.
• Fixed issue: Pooled database connections were reused indefinitely, so after a database failover the Control Plane could keep using connections pinned to a demoted, now read-only primary. Connection lifetime is now bounded at one hour by default and can be tuned with database.max_lifetime.
• Fixed issue: Importing a license whose certificate chain had expired reported license certificate comes from an invalid issuer, pointing at the signing authority rather than at the expiry. An expired or not-yet-effective certificate chain now reports a dedicated message that includes the relevant timestamp. Certificates from a genuinely unknown authority still report an invalid issuer.
• Fixed issue: The current data plane core count included instances that had stopped sending heartbeats, which stay in LostConnection for up to two hours before being marked offline, so the Dashboard's core usage remained inflated long after a data plane was scaled down or crashed. Only connected instances in standard running mode are counted now. License accounting, which is computed from heartbeat usage, is unchanged.

Console (Dashboard)

• Fixed issue: The route paths and service hosts forms allowed adding entries beyond the schema limits of 64 paths and 32 hosts. Creating such a resource failed with a raw server error, and editing one could store a configuration that adc validate and adc sync later rejected. The Add control is now hidden once a list reaches its limit, while lists that are already over the limit still show every entry so the excess can be removed.

3.9.16

Release Date: 2026-07-10

Upgrade Notes

Upgrade note — higher default gateway memory usage (Helm)

The 3.9.16 Helm chart raises several Data Plane shared memory (lua_shared_dict) defaults, so a Helm-deployed gateway reserves about 365 MiB more shared memory at startup than the previous chart:

Shared dictionary	Previous	3.9.16 chart
prometheus-metrics (advanced metrics)	15 MiB	128 MiB
kubernetes, nacos, nacos-stream, consul (service discovery)	20 MiB each	64 MiB each
tracing_buffer (SkyWalking)	10 MiB	32 MiB
api-calls-for-portal	10 MiB	64 MiB

This change is in the Helm chart's shared-dict values (the gateway image defaults are unchanged), so it applies to Helm-based deployments. Before upgrading the chart, raise the gateway container's memory requests and limits so the gateway is not OOM-killed. You can lower any dictionary you do not need through the chart's shared-dict values.

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.9.16 Control Plane encrypts these fields while an older 3.9.15 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• limit-count, limit-count-advanced, and graphql-limit-count: redis_password, sentinel_password
• limit-conn: redis_password
• limit-req: redis_password
• ai-rate-limiting: redis_password, sentinel_password
• elasticsearch-logger: headers (the custom authentication headers)
• ai-cache: redis_password, semantic.embedding.openai.api_key, semantic.embedding.azure_openai.api_key
• ai-lakera-guard: api_key

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.9.16 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.9.16.

Upgrade note — forwarded headers are trusted only from trusted addresses

The gateway now uses apisix.trusted_addresses to decide whether client-supplied X-Forwarded-* and RFC 7239 Forwarded headers are trusted. When trusted_addresses is not configured, or when the request comes from an untrusted address, the gateway overwrites X-Forwarded-Proto, X-Forwarded-Host, and X-Forwarded-Port with gateway-observed values and clears the Forwarded header before proxying upstream. If an upstream application depends on the original forwarded protocol, host, or port sent by a trusted load balancer or reverse proxy, configure that proxy's IP or CIDR in trusted_addresses.

Upgrade note — OpenID Connect silent re-authentication is no longer enabled by default

The openid-connect plugin no longer sets refresh_session_interval to 900 seconds by default. Periodic silent re-authentication now happens only when refresh_session_interval is explicitly configured. If your deployment relied on the previous 900-second refresh behavior, set refresh_session_interval: 900 before or during the upgrade.

Upgrade note — built-in user login policy is stricter

Built-in Dashboard users are now temporarily locked out after repeated failed password attempts. The default policy is enabled, bans the user and source IP after 5 consecutive failures, and lasts 15 minutes. Administrators can tune or disable it through the new login failure restriction system setting. New passwords and passwords changed after upgrade must also be at least 12 characters and still satisfy the existing complexity requirements. Existing passwords are not revalidated at sign-in.

If a built-in user enables two-factor authentication, HTTP Basic Auth for that user is rejected because Basic Auth cannot provide a second factor. Use access tokens for programmatic integrations instead; token authentication is sent with the X-API-KEY header and does not require a 2FA verification code.

Upgrade note — SQL Server deployments enable snapshot reads on first startup

For SQL Server-backed deployments, the Control Plane now creates and prepares the database before other components connect, and enables READ_COMMITTED_SNAPSHOT to prevent gateway configuration reads from blocking behind writes. On an existing SQL Server database where this setting is still disabled, the first startup applies the database-level change with ROLLBACK IMMEDIATE; in-flight database transactions and sessions can be disconnected once, after which connection pools reconnect and later starts are no-ops.

Features

Plugins

• AI Cache (new plugin)
  • Caches LLM responses in Redis so repeated prompts can be served without calling the upstream model again. It supports exact-match caching, optional semantic (L2) matching through embeddings and RediSearch, streaming response caching and replay, configurable bypass rules, and Prometheus metrics for cache hits, misses, bypasses, and embedding latency.
• AI Lakera Guard (new plugin)
  • Screens AI traffic through the Lakera Guard API to detect prompt injection and other unsafe content. The direction option (input, output, or both) selects whether the plugin scans request prompts, LLM responses (including streaming responses), or both. Flagged traffic is blocked with a configurable deny_code, or only logged when action is set to alert.
• AI Aliyun Content Moderation
  • Added request_check_roles to choose which request roles are moderated (user, tool, and/or system). user and tool content follow request_check_mode (last or all, default last), while system content is checked on every request when selected. Long content is now split into chunks in linear time and is multi-byte (UTF-8) safe.
• AI AWS Content Moderation
  • Request moderation now runs after AI protocol detection and checks the decoded prompt content that the upstream LLM sees, rather than the raw HTTP JSON envelope. Deny responses are returned in a provider-compatible format, with configurable check_request, deny_code, and deny_message.
• Elasticsearch Logger
  • Added support for authenticating to Elasticsearch with custom request headers via the headers option, for example an Authorization: Bearer <token> or API-key header, as an alternative or complement to basic auth.
• Rate-limiting plugins
  • Added Redis connection keepalive settings (redis_keepalive_timeout and redis_keepalive_pool) for the Redis and Redis Cluster policies in Limit Count, Limit Count Advanced, GraphQL Limit Count, and AI Rate Limiting, so operators can tune idle timeout and connection pool size.

Data Plane

• Added apisix.trusted_addresses, which controls whether the gateway trusts client-supplied X-Forwarded-* and Forwarded headers based on the resolved client address.
• Added apisix.match_uri_encoded_slash. When enabled, an encoded slash (%2F) stays encoded during route matching so it can be treated as part of a path parameter instead of a path separator.
• Added apisix.max_post_args_readable_size (default 64 MiB), which bounds how much JSON or multipart request body data is read when matching post_arg.* route predicates. Set it to 0 to disable the limit.
• In standalone YAML mode, environment-variable placeholders are now resolved before YAML parsing. Unquoted placeholders can become native booleans or numbers, while quoted placeholders stay strings, preserving large IDs and token values exactly.

Control Plane

• Added TOTP two-factor authentication for built-in Dashboard users. Users can enroll, enable, disable, and recover 2FA from their account settings, and administrators can reset a user's 2FA state.
• Added login failure restriction for built-in users. Repeated failed logins temporarily lock the user and source IP, emit an audit event, and return a clear lockout message.
• Added the Dashboard UI for two-factor authentication: account setup with QR code and recovery codes, an OTP step during login, and an administrator action to reset a user's 2FA state.
• Updated password forms and generated passwords to use the new 12-character minimum length.

Fixes

Plugins

• AI Proxy and AI Proxy Multi
  • Fixed issue: Anthropic Messages requests that contained tool results mixed with other content could be converted into an invalid OpenAI Chat message order, causing OpenAI-compatible upstreams to reject every later request in the session. Tool messages are now emitted immediately after the assistant tool-call message, and adjacent text or media is preserved in a following user message.
  • Fixed issue: Several Anthropic-to-OpenAI conversion details diverged from LiteLLM-compatible behavior, including tool name sanitization, long tool-name collision handling, adaptive thinking effort, structured-output schema extraction, empty array encoding, and content block shaping.
  • Fixed issue: Structured chat content could reach downstream AI plugins as a table and cause request processing errors. Protocol adapters now flatten text content consistently before AI guard and cache plugins consume it.
  • Fixed issue: A failure while constructing the ai-proxy-multi working instance pool could raise a Lua error and destructively clear pool state. The failure path is now nil-safe and non-destructive.
• gRPC Transcode
  • Fixed issue: Empty protobuf repeated fields were encoded as {} instead of JSON arrays ([]). Empty repeated fields now appear as arrays, including nested and descriptor-set based messages.
• Key Auth and other consumer authentication plugins
  • Fixed issue: If a consumer credential referenced a secret that could not be resolved, the Data Plane could still index the unresolved literal value and authenticate requests with it. Consumer authentication now fails closed when a referenced secret cannot be resolved.
• Secret references
  • Fixed issue: Updates or deletions of /secrets configuration did not invalidate the secret LRU cache, so old secret values could continue to be used until cache expiry or indefinitely. Secret references are now re-resolved after secret configuration changes.
• Proxy Rewrite
  • Fixed issue: With use_real_request_uri_unsafe and uri configured together, the request query string was dropped during URI rewriting. The original query string is now preserved and correctly merged when the rewritten URI already contains a query.
• Loggly
  • Fixed issue: Batched Loggly entries from different routes could use the wrong token or tags because the async handler reused the latest route configuration. Each batch processor now keeps its own route configuration.
• Datadog
  • Fixed issue: Large coalesced DogStatsD datagrams could exceed the common 8192-byte agent buffer and be silently truncated. The plugin now coalesces only when the payload fits, otherwise it falls back to one datagram per metric.
• Zipkin
  • Fixed issue: Requests explicitly marked as unsampled still built full span tag tables and access-phase child spans. Unsampled requests now skip that extra tracing work while preserving trace propagation.
• OpenTelemetry
  • Fixed issue: Updating OpenTelemetry plugin metadata at runtime did not rebuild the tracer used for injected core spans, so those spans could keep using stale collector or resource settings until worker recycle. The tracer now refreshes when metadata changes.
  • Fixed issue: additional_attributes were evaluated before log-phase variables were populated, so attributes that depend on final request state could be missing or stale. They are now evaluated in the log phase.
• OpenID Connect
  • Fixed issue: refresh_session_interval incorrectly defaulted to 900, enabling silent re-authentication even when users did not configure it. The default is removed (see Upgrade Notes).
• MQTT Proxy
  • Fixed issue: protocol_name was required even though the standard default is MQTT. It is now optional and defaults to MQTT.
• Forward Auth
  • Fixed issue: When request_method was POST, the authorization request could forward the client's Transfer-Encoding, Content-Length, and Expect headers after the body had already been buffered, producing inconsistent request framing. These client framing headers are no longer copied to the auth service.
• Authz CASBIN
  • Fixed issue: Routes using different Casbin model or policy shapes could trigger casbin enforce error / invalid request size after switching between them. The bundled lua-casbin dependency is updated to include the enforcement fixes.
• AI Aliyun Content Moderation
  • Fixed issue: Returning ngx.OK from the body filter could interrupt later body-filter processing. The plugin now returns normally so other filters can continue.
• Request ID
  • Fixed issue: Configuring algorithm: range_id without the optional range object could return HTTP 500. The range object now has a default value.
• Workflow
  • Fixed issue: Workflow action plugins could run _meta.pre_function hooks before workflow skipped or executed the action, changing behavior even for actions that should not run. Workflow now decides whether to run the action before executing those meta hooks.
• Redirect
  • Fixed issue: http_to_https only redirected requests whose scheme was exactly http, so a request arriving with a non-HTTP, non-HTTPS scheme, for example through a forged X-Forwarded-Proto, was not redirected. It now redirects every non-HTTPS scheme.
• Response Rewrite
  • Fixed issue: When the upstream response was compressed (gzip or brotli), filters were applied to the compressed bytes and did not match, producing a corrupted body. The response is now decoded before filters run.
• Batch Requests
  • Fixed issue: When a pipelined sub-request timed out, the response array could contain more entries than there were sub-requests. The number of sub-responses now always matches the number of sub-requests.
• Tencent Cloud CLS
  • Fixed issue: With include_req_body enabled, the request body was not captured because it was not read in the access phase. The body is now read so that it is included in uploaded logs when sampling allows it.
• Attach Consumer Label
  • Fixed issue: A client could spoof a configured header when the matched Consumer had no labels, because the plugin overwrote the header only when a label value was present. Configured headers are now always stripped from the client request, even when the Consumer has no matching label.
• Authz Keycloak
  • Fixed issue: With lazy_load_paths enabled, the request query string was included when resolving the Keycloak resource by URI, so requests with query parameters could fail to match the intended resource. The query string is now stripped before resolution.
• CAS Auth
  • Fixed issue: The CAS single-logout (SLO) callback POST was proxied to the upstream instead of being handled by the plugin. The callback is now terminated by the plugin and is no longer forwarded upstream.
• gRPC Web
  • Fixed issue: A debug log statement wrote the decoded request body to the error log. The statement has been removed so request payloads are no longer leaked into logs.

Data Plane

• Fixed issue: Log rotation could leave some log files open after only part of the file set was rotated. The gateway now reopens logs correctly after partial rotation.
• Fixed issue: Environment-variable substitution in configuration directives could match the wrong variable when one variable name was a prefix of another. Names are now resolved exactly.
• Fixed issue: After a transient DNS or service-discovery failure, a domain-name upstream could remain stuck returning HTTP 503 even after the name resolved again. The upstream now recovers once resolution succeeds.
• Fixed issue: Upgraded the Prometheus metrics library (nginx-lua-prometheus-api7 to 0.20260623) to remove duplicate metric series that could cause a scrape to be rejected.

Control Plane

• Fixed issue: Gateway instances could be marked OutOfSync for a short window immediately after a configuration revision changed, before the next heartbeat reported the new revision. A grace period now keeps recently heartbeating instances Healthy during that normal synchronization window.
• Fixed issue: Compatibility reports were capped at 200 unordered items, so large reports could hide errors and differ between gateway instances. The Control Plane now stores the full sorted report and computes compatibility from all items.
• Fixed issue: A secret provider request body could match a different provider type than the provider named in the URL path, causing the Data Plane to discard or misread the stored secret. The Control Plane now validates the body against the selected provider type.
• Fixed issue: The Control Plane accepted some core resource configurations that the Data Plane silently discarded, including invalid TLS, filter, and IP match configurations. These are now rejected by validation before publishing.
• Fixed issue: IPv6 upstream node hosts were rejected by the OpenAPI schema. IPv6 hosts are now accepted.
• Fixed issue: Batch ssls validation used the SNI schema instead of the SSL schema, so entries without required certificate fields could pass validation. Batch SSL validation now uses the correct schema.
• Fixed issue: Audit log export returned only the first 256 rows. Exports now include all matching audit logs.
• Fixed issue: Credential lookup indexes could be dropped by components that do not run database migration, and some startup schema repairs rebuilt current indexes unnecessarily. Schema repair now keeps current indexes and repairs only stale shapes.
• Fixed issue: Heartbeat and instance status queries could become slow on large deployments. Additional indexes and Go-side status computation improve these lookups.

3.9.15

Release Date: 2026-06-22

Upgrade Notes

Upgrade note — new plugin fields require both Control Plane and Data Plane on 3.9.15

This release adds new plugin configuration fields: log_format_extra on the logger plugins and Redis session storage (session.storage and session.redis) for openid-connect. Because API7 EE upgrades the Control Plane before the Data Plane, a 3.9.15 Control Plane accepts these fields while an older Data Plane does not yet implement them. Configure these new options only after both the Control Plane and the Data Plane are upgraded to 3.9.15.

Upgrade note — SSO-only domains can no longer use local sign-in

In the Developer Portal, the SSO-only domain policy is now enforced on the server, not only in the browser. Local sign-in and sign-up methods — email and password sign-in and sign-up, magic link, and password reset — are now rejected for email addresses whose domain is mapped to an SSO-only provider. Previously these endpoints could be called directly, bypassing the SSO requirement. If users on SSO-managed domains relied on local sign-in, ensure they sign in through SSO after upgrading.

Upgrade note — Developer Portal API proxy is now default-deny

The Developer Portal's API proxy no longer forwards arbitrary backend endpoints. Only an explicit allowlist of organization-scoped resources (API products, applications, credentials, subscriptions, and DCR providers) is proxied; any other path now returns HTTP 404. Read-only resources reject write methods with HTTP 405, writes to applications, credentials, and subscriptions require an owner or admin role (HTTP 403 otherwise), and organization-scoped requests require an authenticated session (HTTP 401 otherwise). If you have integrations that reached other endpoints through the portal proxy, update them to use a supported API path or call the Control Plane directly.

Upgrade note — Developer Portal sign-up consent configuration changed

The Developer Portal sign-up consent options tosURL and beforeSignUpButtonHtml have been replaced by a single signUpConsentLabel, which holds the custom HTML shown next to the consent checkbox. Terms-of-Service acceptance is now enforced only when signUpConsentLabel is configured. If your deployment set tosURL or beforeSignUpButtonHtml, migrate the value to signUpConsentLabel before upgrading.

Features

Plugins

• OpenID Connect
  • Added Redis as a session storage backend. Set session.storage to redis (the default remains cookie) and configure the connection under session.redis (host, port, authentication, database, key prefix, TLS, and timeouts). Storing sessions in Redis lets multiple gateway nodes and routes share a session and refresh tokens centrally. The Redis password is encrypted at rest, and existing cookie-based configurations are unaffected.

Data Plane

• The logger plugins now accept a log_format_extra option that adds fields on top of the default log entry instead of replacing it. Previously, setting log_format replaced the entire default entry and dropped fields that have no scalar variable (such as header maps, the parsed query string, the composed URL, and computed latencies); log_format_extra keeps the full default entry and overlays your additional fields. When log_format is set, it still takes precedence and log_format_extra is ignored. A new $upstream_unresolved_host variable is also available, recording the configured upstream host or domain before DNS resolution.
• The PROXY protocol for stream (TCP) proxying can now be enabled per listening port. Each stream_proxy.tcp entry accepts two optional fields — proxy_protocol (accept the PROXY protocol on that port) and proxy_protocol_to_upstream (send it to the upstream) — which override the global proxy_protocol.enable_tcp_pp and enable_tcp_pp_to_upstream defaults. Ports without these fields keep the global behavior, so existing configurations are unchanged.
• Debug sessions now capture each sampled request's log lines (all levels) and attach them to that request's trace as span events. The per-request logs appear alongside the trace in the debug session view, making it easier to correlate log output with a specific traced request.

Developer Portal

• The Developer Portal can now run inside a custom PostgreSQL schema instead of only the default public schema. The schema is set in the portal configuration (kept out of the connection URL); the portal applies it per connection and runs its migrations within that schema.

Fixes

Plugins

• JWT Auth
  • Fixed issue: A token whose signature was malformed (wrong length or not valid base64url) caused the verifier to raise an error and return HTTP 500 instead of rejecting the request. Malformed signatures are now rejected with HTTP 401.
• AI Proxy and AI Proxy Multi
  • Fixed issue: When an upstream LLM provider returned an HTTP 429 or 5xx response, the gateway returned only the status code with an empty body, discarding the provider's error details (such as rate-limit information). The upstream error response body and its Content-Type are now forwarded to the client when the request is not retried.
• Loki Logger
  • Fixed issue: When label values referenced per-request variables (for example $service_name or $host), the value resolved for one request was reused for the other requests in the same batch and could remain frozen across requests, so logs were sent under the wrong labels. Labels are now resolved per request, and each request's logs are grouped into their own Loki stream under its own label set.
• HMAC Auth
  • Fixed issue: With validate_request_body enabled, the request body the plugin buffers to verify the signature was limited to 512 KiB by default, rejecting larger bodies that the upstream would accept, and an over-limit body was reported as a misleading HTTP 401. The default max_req_body_size is now 64 MiB (aligned with APISIX), and a body that exceeds the limit is rejected with HTTP 413.

Data Plane

• Fixed issue: With consistent-hashing (chash) load balancing, the hash ring was rebuilt from only the currently healthy nodes whenever a node's health changed, which — especially with uneven node weights — reshuffled the ring and moved keys that were already mapped to healthy nodes. The ring is now rebuilt only on configuration or weight changes, and node health is evaluated at selection time, so transient health changes no longer disrupt the sticky routing of unaffected keys. This applies to both upstream chash and ai-proxy-multi chash balancing.

Control Plane

• Fixed issue: A Data Plane already running the exact version the Control Plane expects could still be shown as Upgrade Required in the Dashboard when it reported invalid plugin or configuration fields, even though no newer version was available to upgrade to. A Data Plane on the expected version is now kept compatible; the reported configuration problems are still surfaced separately as configuration error and warning indicators.

Developer Portal

• Fixed issue: Several two-factor authentication errors were not surfaced — enabling or disabling 2FA with an incorrect password appeared to succeed, the backup-codes dialog could appear empty, and entering a wrong TOTP code at sign-in silently proceeded into the portal. Incorrect passwords and TOTP codes are now correctly rejected with a clear error.

3.9.14

Release Date: 2026-06-15

Breaking Changes

Plugins

• JWT Auth

  Upgrade note

  jwt-auth now verifies the token's exp (expiration) and nbf (not-before) claims by default. Previously, a consumer that did not set claims_to_verify (or set it to an empty list) accepted any correctly signed token, including expired ones. After the Data Plane is upgraded, such tokens are rejected with HTTP 401.

  If you relied on expired tokens being accepted, account for this behavior change before upgrading. To keep verifying only specific claims, set claims_to_verify explicitly in the consumer configuration.

• HMAC Auth

  Upgrade note

  The hmac-auth plugin now defaults signed_headers to ["date"]. After the Data Plane is upgraded, any hmac-auth configuration that does not explicitly set signed_headers requires the client signature to cover the Date header. Clients that were not signing Date will start receiving HTTP 401 with client request can't be validated.

  Before upgrading, ensure your clients sign the Date header, or set signed_headers explicitly in the plugin configuration to match what your clients sign.

• Batch Requests

  Upgrade note

  The batch-requests plugin now bounds the size of a batch. The number of pipelined sub-requests is limited by a new max_pipeline_items plugin-metadata option (default 1000); a batch that exceeds the limit is rejected with HTTP 400. Pipeline entries that contain fields other than the documented ones are now rejected, and the per-batch timeout must be at least 1 millisecond.

  If you send batches larger than 1000 sub-requests, raise max_pipeline_items in the plugin metadata. If your clients send entries with undocumented fields, remove them before upgrading.

Developer Portal

• Developer authentication is enforced only for published API products

  Upgrade note

  Previously, API products in draft state also had their developer authentication rules synced to the gateway, so routes belonging to a draft product required developer authentication. Starting in 3.9.14, only published API products contribute developer-authentication rules to the data plane.

  After upgrading, routes that belong to a draft (unpublished) API product no longer require developer authentication until the product is published. If you relied on draft products being protected, publish them or restrict access another way.

Upgrade Notes

Upgrade note — default request body size limits

The forward-auth, ai-proxy, and ai-proxy-multi plugins now enforce a max_req_body_size limit when they read the request body (default 64 MB). A request whose body exceeds the limit is rejected with HTTP 413 Request Entity Too Large.

If you proxy large request bodies through these plugins, set max_req_body_size explicitly to a value that fits your workload before upgrading.

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.9.14 Control Plane encrypts these fields while an older 3.9.13 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• AI AWS Content Moderation: comprehend.secret_access_key
• Azure Functions: master_apikey, authorization.apikey
• DingTalk Auth: secret_fallbacks
• Error Log Logger: kafka.brokers.sasl_config.password
• Feishu Auth: secret_fallbacks
• HTTP Logger: auth_header
• Kafka Logger: brokers.sasl_config.password
• Loggly: customer_token
• OpenFunction: authorization.service_token
• OpenID Connect: session.secret
• Splunk HEC Logging: endpoint.token

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.9.14 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.9.14.

Features

Plugins

• Limit Count
  • The advanced rate-limiting capabilities previously provided by limit-count-advanced are now built into limit-count. You can configure a sliding window (window_type set to sliding), the redis-sentinel policy, multiple rate-limiting rules (rules), a count derived from a request variable, and shared counters via group and sync_interval. The separate limit-count-advanced plugin remains available for backward compatibility.
• AI Proxy
  • The upstream LLM request body is now JSON-encoded with sorted keys. This produces a stable, byte-identical body for equivalent requests, which improves prompt-cache hit rates on LLM providers that cache by exact request payload.
• AI Proxy Multi
  • Added max_retries to bound how many fallback retries are attempted, and retry_on_failure_within_ms so that only a failure occurring within the configured window triggers a fallback. A slow failure is returned to the client directly instead of multiplying the total wait time across fallback instances.
• AI Prompt Guard and the AI content-moderation plugins
  • Added fail_mode (skip, warn, or error, default skip) to control how a consumer-bound plugin handles a request whose format it does not recognize: skip passes the request through, warn passes it through and logs, and error rejects it with HTTP 400.
• OpenID Connect
  • Added support for the lua-resty-session session options (such as cookie_name and cookie_path), so the session cookie can be customized.
  • client_secret is now optional for local JWT verification modes (for example bearer_only with public_key, use_jwks, or private_key_jwt), where a client secret is not required.
• CAS Auth
  • cas_callback_uri now accepts an absolute URL, which is used as-is as the CAS service URL. This is useful when the gateway sits behind a proxy and the externally visible callback URL differs from the request path.
• Proxy Cache
  • The in-memory cache strategy now honors the Vary response header. Responses are cached per variant computed from the headers listed in Vary, and responses with Vary: * are not cached.
• Kafka Logger
  • Added the api_version option (Produce API version 0, 1, or 2). Set it to 2 so that the message timestamp is carried to and stored by the broker; otherwise messages can be recorded without a timestamp.

Data Plane

• Added built-in NGINX variables for AI requests ($llm_model, $request_llm_model, $llm_prompt_tokens, $llm_completion_tokens, $llm_total_tokens, $llm_time_to_first_token, $llm_stream) that can be referenced in the NGINX access log format to record the per-request LLM model and token usage.
• The Prometheus plugin now exports LLM token-distribution histograms (apisix_llm_prompt_tokens_dist and apisix_llm_completion_tokens_dist) and an apisix_llm_latency histogram that includes time-to-first-token (type="ttft").
• The Prometheus plugin now adds MCP tool dimensions (mcp_tool_name and mcp_request_type) to HTTP metrics, so MCP tools/call traffic can be broken down by tool and request type.

Developer Portal

• Added an Approvals workflow for the Developer Portal. Platform admins can review and accept or reject API-product subscription and developer-registration requests from the portal, with the applicant's organization name resolved for display. The acting administrator is recorded as the operator for auditing, and the Dashboard shows the resolved operator.
• Credential secrets (such as key-auth and basic-auth keys) are now returned only once, at creation time. Subsequent reads of the credential omit the secret value.
• Added an admin Users page to manage portal users — list, search, change role, ban or unban, and delete.
• Added two-factor authentication for portal sign-in.
• Added policy-based SSO sign-in: developers can be routed to a configured SSO provider based on their email domain, including anchored, case-insensitive regular-expression matching.
• Added a configurable Terms of Service acceptance step during sign-up.
• Added dark mode.

Fixes

Plugins

• Error Page
  • Fixed issue: The plugin decided whether to render a custom error page based on the upstream status variable, which could replace error responses that actually came from the upstream service. It now classifies the response source — custom error pages are rendered only for errors generated by the gateway or plugins, while genuine error responses returned by the upstream are passed through unchanged.
• Feishu Auth and DingTalk Auth
  • Fixed issue: A client could supply a forged X-Userinfo header that was forwarded upstream. Both plugins now clear any client-supplied X-Userinfo header before authentication, so upstream services only receive plugin-verified identity information.
• DingTalk Auth
  • Fixed issue: Authentication failures and transient upstream failures were not distinguished. The plugin now returns HTTP 401 for authentication errors and HTTP 503 for transient DingTalk or upstream failures, with clearer error messages.
• CAS Auth
  • Fixed issue: The login callback did not validate the signed initiation cookie, allowing a crafted callback request to drive the post-login redirect. The callback now requires a valid signed initiation cookie and is rejected with HTTP 401 otherwise.
  • Fixed issue: A single logout (SLO) POST request with an empty body returned HTTP 500 instead of HTTP 400.
• Authz Casdoor
  • Fixed issue: The session cookie name was shared across Casdoor clients, so sessions for different clients could collide. The session cookie is now scoped per client.
  • Fixed issue: The gateway session was not tied to the Casdoor token lifetime, so it could continue to be reused after the token expired. The session now expires when the Casdoor token expires, forcing re-authentication.
• Authz Keycloak
  • Fixed issue: When static permissions were combined with http_method_as_scope, the derived method scope was written back to the reused plugin configuration, causing scopes to accumulate across requests. The permission list is now cloned before the method scope is appended.
• OPA
  • Fixed issue: For a header listed in send_headers_upstream but absent from the OPA response, a client-supplied value could be forwarded upstream. Such headers are now cleared so only OPA-provided values reach the upstream.
• SAML Auth
  • Fixed issue: Reworked plugin loading and error handling — removed the load_resty_saml wrapper, disabled debug output by default, and returns a clean HTTP 500 on authentication errors.
• AI Proxy
  • Fixed issue: An upstream LLM timeout was mapped to HTTP 500. It is now mapped to HTTP 504 Gateway Time-out.
  • Fixed issue: In passthrough mode, the client's HTTP method and query string were not forwarded to the upstream. They are now preserved.
• AI Proxy Multi
  • Fixed issue: Health checks for domain-based upstreams could be unstable — a cached node picker could go stale after health checkers were created, and the health-check configuration could be mutated in place across requests.
• GraphQL Limit Count
  • Fixed issue: The query nesting depth was miscalculated, making depth-based rate limiting inaccurate. Depth is now computed from the true maximum nesting depth with fragment expansion, and Content-Type matching tolerates a charset parameter.
• GraphQL Proxy Cache
  • Fixed issue: A request whose Content-Type included a charset parameter was not recognized as a GraphQL request. Content-Type matching is now charset-tolerant.
  • Fixed issue: A PURGE request did not clear all Vary variants of a cached entry. All variants are now purged.
• AWS Lambda
  • Fixed issue: IAM (SigV4) authentication failed for a request with URL-encoded or multi-value query parameters because the canonical query string was computed incorrectly.
• AWS Secret Manager
  • Fixed issue: Resolving a secret whose name contains a slash failed. Such names are now parsed correctly.
• Request ID
  • Fixed issue: The nanoid algorithm could produce duplicate or malformed IDs. IDs are now generated with a cryptographically secure random source and always use the valid nanoid alphabet.
• Proxy Mirror
  • Fixed issue: When mirroring a gRPC request, the original method path was not preserved on the mirrored request. It is now kept intact.
• Body Transformer
  • Fixed issue: XML-to-JSON transformation intermittently lost keys that used an XML namespace prefix. Namespaced keys are now preserved and accessible in the template.
• Elasticsearch Logger
  • Fixed issue: A dynamic index template using date placeholders could raise an error for an invalid template. The date formatting is now guarded.
• Rate limiting (Limit Count, Limit Req, Limit Conn)
  • Fixed issue: Redis connections that differed only by database number or credentials could share the same keepalive connection pool, so a connection could be reused against the wrong database or identity. Connections are now isolated by database, credentials, and TLS settings; this also covers the redis-sentinel policy.
• Limit Conn
  • Fixed issue: A dynamic burst value that resolved to 0 was incorrectly rejected as invalid. It is now allowed.

Data Plane

• Fixed issue: When multiple logging plugins captured the response body on the same request, their response-body buffers could interfere with each other, producing truncated or mixed log output. Each logger now uses an isolated buffer.
• Fixed issue: Some logger plugins wrote debug logs that could expose credentials. These logs have been removed.
• Fixed issue: A logging plugin in the log phase could fail when the access phase had been short-circuited, for example by an authentication rejection.
• Fixed issue: A cached request header could keep a stale value when a plugin set the same header using a different letter case. Header cache keys are now normalized.
• Fixed issue: consul service discovery discarded all remaining nodes of a service when a single node entry was invalid. Invalid node entries are now skipped individually so the remaining healthy nodes are still used.
• Fixed issue: nacos service discovery failed in the stream subsystem because the required shared dictionary was not declared there.

Control Plane

• Fixed issue: The openid-connect exemption that allows omitting client_secret was applied too broadly. It is now scoped to the OIDC flows that genuinely do not require a client secret.
• Fixed issue: Listing labels scoped to a gateway group returned the global labels for the resource type instead of the gateway-group-scoped labels.
• Fixed issue: Developer Portal organization invitations did not honor the configured email-verification requirement.

3.9.13

Release Date: 2026-05-22

Breaking Changes

Plugins

• CAS Auth

  Upgrade note

  The cas-auth plugin now requires a cookie.secret value of at least 32 characters. The plugin uses this secret to sign and verify the CAS_REQUEST_URI cookie, preventing a client-controlled cookie from changing the post-login redirect target.

  Before upgrading, update every existing cas-auth configuration with a shared cookie.secret across all gateway nodes.

Upgrade Notes

Upgrade note — proxy cache behavior

The proxy-cache and graphql-proxy-cache plugins now use safer cache behavior by default.

For proxy-cache, responses are isolated by consumer when the request has an authenticated consumer or remote user, unless the configured cache_key already contains an identity-bearing variable. The in-memory strategy also no longer caches responses whose upstream Cache-Control contains private, no-store, or no-cache, and both in-memory and on-disk strategies skip responses with Set-Cookie unless cache_set_cookie is set to true.

For graphql-proxy-cache, cache keys now include host, route, service, and consumer identity by default, and responses with Set-Cookie are skipped unless cache_set_cookie is set to true.

If you intentionally share cached responses across consumers, set consumer_isolation: false. If you intentionally cache responses with Set-Cookie, set cache_set_cookie: true.

Features

Plugins

• AI Proxy
  • Improved OpenAI-compatible streaming response throughput by reducing per-token flush and SSE parsing overhead. In internal single-worker benchmarks with a mock OpenAI upstream, peak streaming throughput increased from 44,102.6 tokens/s to 138,158.7 tokens/s, about 3.13x higher.
  • Improved large JSON request body handling for AI requests that use post_arg.* route variables. In internal benchmarks with 1 MB, 5 MB, and 10 MB OpenAI Chat Completions-compatible request bodies, throughput improved by 5.15x-5.35x when the gateway forwarded the original body, and by 2.47x-2.67x when the gateway rewrote the body before forwarding.
  • Added streaming_flush_interval_ms to control periodic flushing for streaming responses. The default is 10 ms, which reduces per-chunk flush overhead while keeping streaming latency bounded.
• OpenAPI to MCP
  • Added allowed_hosts to restrict which hosts a dynamically resolved base_url may target. When allowed_hosts is not configured, existing behavior is unchanged. The plugin also rejects malformed resolved URLs and non-HTTP(S) schemes with HTTP 400.
• Proxy Cache and GraphQL Proxy Cache
  • Added consumer_isolation and cache_set_cookie options to control the new safer cache behavior described in the upgrade note.

Control Plane

• Alert policies can now automatically create Debug Sessions when alert conditions are triggered. Alert history records whether debug session creation succeeded and includes the created session IDs or error details.
• Fallback Control Plane storage now supports S3-compatible path-style endpoints, which enables integrations with providers such as MinIO that require bucket names in the URL path.

Console (Dashboard)

• Added Debug Sessions UI under Gateway Groups, including session list, create, stop, delete, trace list, trace waterfall detail, search and filtering, minimap, URL state sync, field formatting, and keyboard navigation.
• Added a copy button to delete/disable confirmation dialogs so users can copy the resource identifier before confirming destructive operations.
• Added search support to the service and route selector on the monitoring page.

Developer Portal

• Added a Helm chart for deploying the Developer Portal on Kubernetes.

Fixes

Plugins

• OpenID Connect
  • Fixed issue: Client-supplied identity headers (X-Access-Token, X-Userinfo, X-ID-Token, X-Refresh-Token) could be forwarded upstream instead of values validated by the plugin. These headers are now cleared or overwritten so upstream services only receive plugin-controlled identity values.
• Data Mask
  • Fixed issue: The plugin could crash or produce incorrect masked output for multi-value query parameters, valueless query parameters, non-string JSON values, regex failures, and form parsing errors. It also no longer logs original sensitive values when regex substitution fails.
• ACL
  • Fixed issue: external_user_label_field_parser and external_user_label_field_separator could be applied to consumer labels, causing incorrect allow or deny decisions. They now apply only to external-user label extraction.
• Chaitin WAF and Wolf RBAC
  • Fixed issue: The plugins used raw client-supplied IP headers when sending client IP information to their backend services. They now use the trusted real client IP resolved by the gateway.
• Client Control
  • Fixed issue: When a Global Rule plugin read the request body in the access phase, client-control on a route or service could not apply its body size override first, causing large requests to be rejected unexpectedly.

Control Plane

• Fixed issue: Deleting a Secret that was still referenced by other resources could leave dangling references and cause gateway runtime errors. Secret deletion is now rejected while references exist.
• Fixed issue: Data Plane Manager certificates could fail hostname verification for older Data Planes when dp_manager_address contained both domain names and IP addresses.
• Fixed issue: Malformed gateway version strings in heartbeat payloads could crash compatibility validation. They are now handled as incompatible versions instead of causing a panic.
• Fixed issue: Invalid stream route CIDR/IP values and invalid post_arg.* JSON path expressions could be accepted by the Control Plane and later rejected or dropped by the Data Plane. These configurations are now rejected at the API level.
• Fixed issue: Sensitive encrypted field values could appear in logs when decrypting AesEncrypt fields failed. Logs now include only the value length.

Data Plane

• Fixed issue: Stream routes that referenced a service could keep using stale service-level plugin configuration until the route changed or the worker restarted.
• Fixed issue: Gateway workers could crash during startup when the etcd or DP Manager response was missing expected revision headers. The gateway now logs the problem and retries.
• Fixed issue: Stream workers could crash during config sync when status reporting was enabled.
• Fixed issue: The standard gateway runtime image did not honor the TZ environment variable for IANA timezone names because timezone data was missing.
• Fixed issue: The tracer could crash on HTTPS or HTTP/2 keepalive connections when tracing was enabled.
• Fixed issue: The gateway CLI wrote Control Plane mTLS client certificate files to the system temporary directory with overly broad permissions. These files are now written under the gateway config certificate directory with restricted permissions.

Console (Dashboard)

• Fixed issue: The OpenID Connect plugin code editor could collapse or become unreachable on small or highly zoomed viewports.
• Fixed issue: Deleting a published service from the service list could show a misleading "service not found" error toast after deletion succeeded.
• Fixed issue: List table defaults could be mutated by one page and leak invalid sorting parameters into the Gateway Instances page.
• Fixed issue: The plugin view drawer could show stale or incorrect JSON when switching between local, global, and metadata tabs.
• Fixed issue: Cached gateway group or portal IDs that no longer existed could lead to blank pages or 404 error toasts instead of redirecting to a valid fallback.

3.9.12

Release Date: 2026-05-08

Features

Plugins

• AI Proxy
  • Added support for the AWS Bedrock provider using the Converse API. Configure with "provider": "bedrock", AWS IAM credentials in auth.aws, and an AWS region in provider_conf.region. Both non-streaming and streaming (ConverseStream) modes are supported — set "stream": true in the request body for streaming responses.
• OAS Validator
  • Added spec_url field that loads the OpenAPI specification from a remote HTTP(S) URL instead of embedding the full JSON inline in the plugin configuration. This is useful when the spec exceeds the 2 MB inline size limit of the spec field. The fetched spec is cached with a configurable TTL (default 1 hour, set via plugin metadata spec_url_ttl), and stale entries continue serving requests while the spec refreshes in the background. Additional fields spec_url_request_headers (custom HTTP headers, e.g. for authentication) and timeout (request timeout in milliseconds, default 10000) are available. spec and spec_url are mutually exclusive.

Fixes

Plugins

• File Logger
  • Fixed issue: When both the gzip plugin and file-logger (with include_resp_body enabled) were configured on a route, file-logger incorrectly attempted to decompress the response body. Because APISIX itself performed the gzip encoding, the body available to the logger was still plaintext, causing spurious inflate gzip err: INFLATE: data error log entries and the response body being lost from the log output.
• Elasticsearch Logger
  • Fixed issue: Dynamic index patterns using date-time placeholders (such as gateway-{%Y.%m.%d}) stopped rotating after the first request. The resolved date string was written back to the shared configuration object, permanently overwriting the template until the worker process restarted.
• OAS Validator
  • Fixed issue: Header parameter validation was case-sensitive, causing requests to be rejected when the header name casing did not exactly match the OpenAPI specification (for example, sending X-Request-Id when the spec defined x-request-id). Header matching is now case-insensitive per RFC 7230 §3.2.

3.9.11

Release Date: 2026-04-30

Upgrade Notes

Upgrade note — Secret references CP→DP compatibility

This version extends secret references ($secret://, $env://) to work with all plugins centrally. After upgrading the Control Plane to 3.9.11, if you configure secret references in plugin fields that previously did not support them, a Data Plane still running 3.9.10 or earlier will not resolve those references — it will pass the literal $secret://... string to the plugin.

Recommended upgrade path: Upgrade all Data Planes to 3.9.11 before configuring secret references in newly-supported plugin fields. Plugins that already supported secrets in previous versions (jwt-auth, openid-connect, limit-count, authz-keycloak, csrf, limit-req, limit-conn) are not affected.

Features

Plugins

• AI Proxy
  • Added a passthrough protocol adapter that proxies unrecognized API formats (such as /v1/images/generations) through to the upstream without transformation. Previously, requests that did not match a known protocol (OpenAI Chat, Completions, Embeddings, etc.) were rejected.
  • Rewrote the Anthropic-to-OpenAI protocol converter using a whitelist body construction approach. This prevents Anthropic-specific fields (such as metadata, top_k, thinking, and output_config) from leaking through to OpenAI-compatible upstream providers, and improves conversion accuracy for tool use, system prompts, and multimodal content.
  • Upstream nginx variables ($upstream_status, $upstream_addr, $upstream_response_time, $upstream_header_time, $upstream_connect_time, $upstream_response_length) are now populated in access logs when ai-proxy uses cosocket transport to call LLM backends. Previously, these variables were empty because nginx's upstream module was bypassed.
• OAS Validator
  • Replaced the Go FFI-based OpenAPI validator with a pure-Lua implementation (lua-resty-openapi-validator). Internal benchmarks on a real-world large-scale OpenAPI specification (Stripe, ~414 endpoints) show the new validator is 2–7x faster per-request and compiles the spec 20x faster, while also reducing gateway image size by eliminating the Go shared library. The new validator additionally fixes correctness issues with path parameter routing, nullable schemas, allOf/anyOf merging, and adds support for validating form-encoded request bodies that the previous implementation could not handle.
• All plugins now support $secret:// and $env:// references in any configuration field automatically. Previously, only a handful of plugins (jwt-auth, openid-connect, limit-count, authz-keycloak, csrf, limit-req, limit-conn) had explicit secret reference support. This removes the need for each plugin to implement secret resolution individually.

Data Plane

• A new distroless gateway image variant (api7-ee-3-gateway-distroless) is now available. Built from scratch with only the shared libraries, CA certificates, and timezone data needed to run the gateway, it eliminates OS packages that carry CVEs but are unused at runtime.

Console (Dashboard)

• Configuration compatibility warnings and errors are now displayed in a separate clickable badge on Data Plane instance cards. Clicking the badge opens a modal with a detailed table of all configuration issues (resource type, ID, severity level, and message), making it easier to identify and resolve config schema problems without confusing them with version compatibility status.

Fixes

Plugins

• AI Proxy Multi
  • Fixed issue: After the Control Plane pushed a config update, health check validation logged noisy warnings (unable to construct upstream for plugin: ai-proxy-multi) because DNS resolution state was lost during the config table replacement.
• AI Rate Limiting
  • Fixed issue: AI instance names containing dots (such as Qwen3.5-397B-10.249.238.157) caused HTTP 500 errors because the name was incorrectly interpreted as a ctx.var path expression instead of a constant key.
• AI Request Rewrite
  • Fixed issue: Requests with no body produced a vague upstream error instead of returning a clear HTTP 400 Bad Request.
• AI Prompt Template
  • Fixed issue: JSON parse error messages were garbled Lua table references (such as table: 0x...) instead of readable error strings.
• OpenTelemetry
  • Fixed issue: Non-string values in additional_attributes (such as numbers or booleans from nginx variables) were silently dropped by the OpenTelemetry SDK. They are now coerced to strings before being added to spans.
• Limit Count
  • Fixed issue: Redis credentials (redis_password, redis_username, sentinel_password) were embedded in rate-limiting group keys, exposing sensitive information in Redis keyspace and APISIX logs.
• Traffic Split (Stream)
  • Fixed issue: ctx.var.route_id always returned nil in stream (L4) context, causing match conditions based on route_id in traffic-split rules to never match.
  • Fixed issue: When traffic-split selected an upstream via upstream_id in stream context, the selection was ignored and the route's original upstream was always used.

Control Plane

• Fixed issue: Warning-level entries in the configuration compatibility report incorrectly caused Data Plane instances to display "Upgrade Recommended" even when the Control Plane and Data Plane versions matched.

Data Plane

• Fixed issue: The batch processor entered an infinite timer loop during nginx worker shutdown, preventing graceful shutdown and flooding logs with [alert] messages.
• Fixed issue: The batch processor's processed_entries counter was reset when stale buffers were cleaned up, breaking delivery metrics for batch-processing plugins (such as http-logger, kafka-logger).
• Fixed issue: Active health check request_body configuration was silently ignored because the underlying healthcheck library expects the field to be named http_req_body. The schema field has been renamed to match.
• Fixed issue: Sensitive field values were exposed in error logs when encrypt/decrypt operations failed. Error messages no longer include the raw value.
• Fixed issue: During upgrades with newly added encrypt_fields, expected decrypt failures of pre-existing plaintext data generated noisy warn-level log entries. These are now logged at info level with an explanatory message.

3.9.10

Release Date: 2026-04-22

Breaking Changes

Plugins

• OpenAPI to MCP

  Upgrade note

  The OpenAPI2MCP service is no longer bundled inside the gateway image. It now runs as a separate sidecar container (api7/openapi-to-mcp), reducing the gateway image size by approximately 150 MB. If you use the openapi-to-mcp or mcp-tools-acl plugins, you must deploy the OpenAPI2MCP sidecar alongside the gateway. In Kubernetes, enable openapiToMcp.enabled=true in the gateway Helm chart. In Docker Compose, run the api7/openapi-to-mcp container in the same network namespace as the gateway.

Upgrade Notes

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.9.10 Control Plane encrypts these fields while an older 3.9.9 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• AI Proxy: auth.header, auth.query, auth.gcp.service_account_json
• AI Proxy Multi: the same fields under instances.*
• AI RAG: embeddings_provider.azure_openai.api_key, vector_search_provider.azure_ai_search.api_key
• AWS Lambda: authorization.apikey, authorization.iam.accesskey, authorization.iam.secretkey
• OpenID Connect: client_rsa_private_key
• SAML Auth: secret_fallbacks

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.9.10 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.9.10.

Features

Plugins

• AI Proxy, AI Proxy Multi
  • Added override.request_body for per-protocol deep-merge request body overrides and override.llm_options for provider-aware max_tokens mapping. Operators can set protocol-specific parameters (such as max_tokens, stop_sequences) as defaults or enforced settings using the request_body_force_override flag. Precedence order: model options → LLM options (always force) → request body (per-protocol deep merge). All three new fields (request_body, llm_options, request_body_force_override) are also available per instance under AI Proxy Multi's instances[].override.
  • Added max_stream_duration_ms and max_response_bytes safeguards to prevent unbounded LLM streaming responses from pinning a worker process at high CPU. When either limit is exceeded, the stream is terminated gracefully with appropriate error signaling.
  • The gateway now detects client disconnection during streaming and immediately stops reading from the LLM upstream, freeing worker resources and avoiding unnecessary API quota consumption.
• AI RAG
  • Added a top-level ssl_verify field (default true) that controls TLS certificate verification when the plugin calls the embeddings and vector search endpoints.
• Prometheus, OpenTelemetry, Zipkin
  • Added a new response_source label (Prometheus) and apisix.response_source span attribute (OpenTelemetry, Zipkin) that classifies each response as "apisix" (generated by APISIX, such as plugin rejections or route-not-found), "nginx" (NGINX proxy errors such as connection refused or upstream timeout), or "upstream" (real response from the upstream service). This enables more precise error attribution in dashboards and alerts.

Control Plane

• Added Consul as a service discovery source. Gateways can now discover upstream services registered in Consul, with support for metadata-based filtering and health-check-aware node selection.
• The Control Plane can now dynamically push telemetry configuration (such as trace sampling ratio and export endpoints) to Data Planes via heartbeat, without requiring a gateway restart.
• Added skip_mtls_uri_regex to SSL/SNI configuration, allowing specific URI patterns to bypass mTLS client certificate verification while keeping mTLS enforced for all other URIs.
• Added POST /apisix/admin/configs/validate endpoint for batch configuration validation. Operators can validate route, service, upstream, and plugin configurations before applying them, catching schema errors without affecting live traffic.
• DP Manager now supports native gRPC etcd protocol on port 7943 via cmux, providing Data Planes with an additional connectivity option alongside the existing HTTP-based etcd protocol.
• The encrypt_fields mechanism now supports nested and complex field structures, including arbitrary-depth dotted paths, arrays, and maps. Plugin configurations with deeply nested sensitive fields (such as auth.gcp.service_account_json) are now encrypted at rest correctly.

Console (Dashboard)

• Added form-based configuration modes for the Key Auth and Basic Auth plugins, enabling visual credential setup without manual JSON editing.
• Added OpenID Connect quick start presets with pre-filled configuration templates for common identity providers, simplifying initial OIDC plugin setup.
• Added Consul as a selectable service discovery type in the upstream configuration UI.
• Supported specifying the SNI when configuring skip_mtls_uri_regex.

Fixes

Plugins

• AI Proxy
  • Fixed issue: When an LLM provider emitted many small SSE chunks per second (such as single-character reasoning tokens), a single streaming request could monopolize a worker process at 100% CPU, degrading availability for all other traffic on that worker.
  • Fixed issue: When a protocol converter was active (for example, Anthropic-to-OpenAI) and the upstream returned SSE events in an unexpected format, the gateway returned a 500 error instead of 502. The gateway now correctly returns 502 Bad Gateway when the upstream response format is incompatible with the configured protocol conversion.
  • Fixed issue: When LLM providers returned JSON null for nullable response fields (such as prompt_tokens_details or usage), the gateway crashed because the JSON null sentinel value passed Lua truthiness checks but could not be indexed as a table.
• AI Rate Limiting
  • Fixed issue: Upstream-provided usage keys (from LLM response usage data) that collided with reserved expression environment names (such as math or abs) could shadow built-in functions, potentially breaking rate limiting expression evaluation or bypassing limits.

Control Plane

• Fixed issue: Creating OAuth credentials via Developer Portal with an OIDC-type DCR Provider failed on identity providers (such as Keycloak) that require the client_name field. The client_name is now included in both DCR register and update requests, using the Application name as the value.

Ingress Controller

• Fixed issue: The Ingress Controller set hosts on both Route and Service when translating ApisixRoute resources. For backends that do not support route-level hosts, this caused a false diff every sync cycle, triggering unnecessary PUT requests and generating massive audit log growth. In one production environment, this resulted in 8 GB / 4.2 million redundant UpdateService audit log entries.

Console (Dashboard)

• Fixed issue: The service discovery loading indicator remained visible indefinitely when the discovery request failed.
• Fixed issue: Nacos service metadata was not refreshed when switching between services in the upstream configuration.
• Fixed issue: Switching login option provider types did not clean up configuration fields from the previous provider, leaving stale values in the form.
• Fixed issue: The IAM policy statements editor crashed with a null reference error when policies data was not yet loaded.
• Fixed issue: The InviteUser and ResetPassword actions did not display error messages when the API call failed, making it unclear why the operation did not succeed.
• Fixed issue: The login option name uniqueness check loaded the full list of login options unnecessarily. It now uses a lightweight API call.
• Fixed issue: The IAM delete role operation used the wrong permission action (iam:UpdateRole instead of iam:DeleteRole).

3.9.9

Release Date: 2026-04-10

Features

Control Plane

• Upstream labels are now persisted and returned correctly via the API. Previously, labels set on upstreams (e.g., by ADC or Ingress Controller) were silently dropped during persistence, causing false diffs on every sync cycle and unnecessary audit log growth.
• The file server address can now be dynamically configured through the System Settings page in the Dashboard, following the same dual-source pattern as the DP Manager address and Admin API address.

Fixes

Plugins

• AI Proxy
  • Fixed issue: When using AI Proxy with protocol conversion (e.g., Anthropic client to OpenAI provider), stream_options.include_usage=true was injected into the pre-conversion request body instead of the post-conversion OpenAI body, so usage statistics were missing from streaming responses for converted protocols.
• Forward Auth
  • Fixed issue: When the auth service responded with HTTP 200 but omitted a header listed in upstream_headers, the original client-supplied value was forwarded to the upstream instead of being cleared. This could allow clients to spoof upstream headers by including them in the original request.
• JWT Auth
  • Fixed issue: The JWT Auth plugin did not verify that the JWT token's alg header matched the consumer's configured algorithm before signature verification, which could allow algorithm confusion attacks.

Data Plane

• Fixed issue: The Data Plane compatibility report showed spurious warnings for valid plugin configurations. Plugins using patternProperties, conditional schemas (if/then/else), allOf, dependencies, or additionalProperties=true incorrectly reported "unrecognized fields" warnings. Affected plugins included ai-proxy, ai-proxy-multi, openapi-to-mcp, acl, http-logger, limit-count-advanced, portal-auth, jwt-auth, proxy-rewrite, and grpc-transcode.

3.9.8

Release Date: 2026-04-07

Breaking Changes

Plugins

• Limit Count

  Upgrade note

  The sync_interval (Redis delayed sync) feature has been removed from the limit-count plugin and is now available exclusively in the Limit Count Advanced plugin. If you are using limit-count with sync_interval configured, migrate your configuration to the limit-count-advanced plugin before upgrading.

• OpenID Connect

  Upgrade note

  The default value of ssl_verify has been changed from false to true. If you have OpenID Connect plugin configurations that do not explicitly set ssl_verify and your identity provider uses a self-signed certificate or a certificate issued by an internal CA, TLS verification will now fail after upgrading. Explicitly set ssl_verify to false in affected configurations before upgrading, or ensure the IdP certificate is trusted by the gateway's CA store.

Features

Plugins

• MCP Tools ACL (New Plugin)
  • Added a new plugin for per-tool access control on MCP services exposed via the OpenAPI-to-MCP plugin. Supports allowlist (allow_tools) and denylist (deny_tools) modes with expression-based matching conditions for route-level or service-level tool access policies. Consumers and consumer groups are supported with priority-based rule evaluation. SSE responses are automatically filtered to remove denied tools from tools/list results.
• AI Proxy, AI Proxy Multi
  • Added native Anthropic Messages API support. Requests to /v1/messages using the Anthropic SDK format are now passed through directly to Anthropic-compatible backends without protocol conversion, preserving Anthropic-specific fields such as cache token usage.
  • Added full support for the OpenAI Responses API (POST /v1/responses). Both streaming and non-streaming responses are handled, and all downstream plugins (RAG, content moderation, prompt decorator, prompt guard, logging) work correctly with the Responses API format. Both plugins share the same AI protocol handling, so this also applies to ai-proxy-multi routes.
• AI Rate Limiting
  • Added a new expression limit strategy with the cost_expr field, allowing dynamic token cost calculation using custom Lua arithmetic expressions. For example, input_tokens + cache_creation_input_tokens enables cache-aware input token per minute (ITPM) rate limiting for Anthropic Claude.
• OAS Validator
  • Added support for OpenAPI 3.1 specification validation, including features such as exclusiveMinimum/exclusiveMaximum as numbers, if/then/else conditional schemas, nullable types via ["string", "null"], const, patternProperties, prefixItems, and JSON Schema $dynamicRef/$dynamicAnchor.
  • Added a configurable rejection_status_code option (400–599, default 400). This allows distinguishing semantic validation errors (e.g., 422 Unprocessable Entity) from malformed request syntax (400 Bad Request).
• Request ID
  • Added uuidv7 as a new algorithm option. UUID v7 generates time-ordered, lexicographically sortable unique identifiers, making them more suitable for distributed tracing and log correlation than random UUID v4.
• OpenAPI to MCP
  • Added support for OpenAPI in: header parameters. Header parameters defined in OpenAPI specs are now correctly included in MCP tool schemas and forwarded as HTTP headers when invoking the upstream API.

Control Plane

• Added support for Vault dynamic roles for database credential rotation. Dynamic roles create temporary database users with a configurable lease TTL, improving security compared to static roles. Dynamic role is now the default mode, with automatic startup retry using exponential backoff.
• Added a standalone file-server component for hosting files accessible by MCP servers. Files can be uploaded via the Dashboard API and served through a dedicated port. The file server is disabled by default and can be enabled in the system settings.
• Added HTTP Bridge as a new Dynamic Client Registration (DCR) provider type. HTTP Bridge proxies DCR operations (register, update, delete, rotate secret) to an external identity provider via configurable HTTP endpoints.
• Added Data Plane compatibility reporting. When Control Plane and Data Plane versions differ, the Data Plane now reports incompatible resource details (schema validation failures, unknown plugin fields, missing plugins) via heartbeat. Compatibility status is viewable through the runtime instance API.
• Services can now be published without upstream configuration, enabling AI Proxy and other plugin-only scenarios where no backend upstream is needed.
• Optimized custom plugin synchronization with incremental cache refresh. The periodic sync job now queries only for changes instead of performing a full table scan, significantly reducing database load.

Data Plane

• Improved Redis Sentinel connection performance. Master node addresses are now cached with a configurable TTL, reducing Sentinel round-trip queries on each new connection. Additionally, pooled connections skip redundant AUTH and SELECT DB commands, lowering latency for high-throughput Redis operations.

Developer Portal

• Added admin impersonation. Portal administrators can impersonate organization owners to troubleshoot issues, with a 1-hour time-to-live and a persistent warning banner during impersonation.
• Added OAuth client secret regeneration for HTTP Bridge credentials. Organization owners can regenerate secrets through a confirmation modal in the credential management UI.
• Added configurable TOTP-based two-factor authentication (2FA) for Developer Portal login.
• Added role-based access control (RBAC) with three roles: Owner (full control, including organization deletion), Admin (all permissions except organization deletion), and Member (view-only access).
• Organization settings now use slug-prefixed URLs. Page URLs update automatically when switching organizations or renaming the organization slug.
• Application detail pages now display configuration based on portal settings.
• Added an optional signup notice HTML slot for displaying trusted custom content before the sign-up button on the authentication page.

Fixes

Plugins

• AI Aliyun Content Moderation
  • Fixed issue: Empty or whitespace-only content caused a 400 error from the Alibaba Cloud moderation API. Additionally, LLM error responses (status ≥ 400) triggered a 500 error during response moderation, and multimodal content arrays crashed text extraction.
• AI Proxy
  • Fixed issue: The apisix_llm_active_connections Prometheus gauge was never decremented when a plugin exited early via ngx.exit(), causing the metric to grow indefinitely and report incorrect active connection counts.
• AI Rate Limiting, Limit Conn, Limit Req
  • Fixed issue: $env:// and $secret:// references in Redis host configuration were passed as literal strings instead of being resolved to their actual values, causing Redis connection failures.
• Fixed issue: API keys, authentication tokens, OAuth credentials, and full plugin configuration payloads were logged in plaintext across multiple plugin and agent log outputs. Sensitive data is now redacted.

Control Plane

• Fixed issue: Updating service runtime configuration (e.g., toggling service status) via PATCH failed with a schema validation error when the service had no upstream configured.
• Fixed issue: HTTP and stream subsystem plugins sharing the same name used a single cache entry, causing the wrong plugin schema to be used for validation when both subsystems were active.
• Fixed issue: Subscriptions could be deleted across API products without validating that the subscription belonged to the target product.
• Fixed issue: Services without upstream configuration showed phantom empty upstream records in the upstream list API.
• Fixed issue: Control Plane crashed with a nil pointer dereference during upgrade migration when processing services with no upstream configured.
• Fixed issue: Multiple API Products within the same Developer Portal could link to the same gateway service (same service ID and gateway group), causing configuration conflicts.
• Fixed issue: Updating an SSL certificate allowed SNI collisions when adding new domains that conflicted with existing certificates.
• Fixed issue: Deleting an API Product that shared a gateway service with another product incorrectly removed all system plugins from the shared service, breaking the other product's authentication configuration.
• Fixed issue: DCR provider authentication headers (such as Bearer tokens) were stored in the database without encryption.
• Fixed issue: Consumer credential secrets were not masked in audit logs due to a value/pointer receiver mismatch.
• Fixed issue: Approval handlers (accept/reject subscription) continued execution after returning a 403 status, bypassing the permission check and processing the request.
• Fixed issue: Read-only Developer Portal users could cancel API Product subscriptions because the endpoint used a read permission check instead of write.
• Fixed issue: PATCH operations on route and stream route runtime configurations used read-only or view-only permission checks, allowing users without write access to modify configurations.
• Fixed issue: Upstream resources were not validated against the requested service, allowing access to upstreams belonging to other services.
• Fixed issue: The CAS SSLVerify configuration flag was inverted, causing TLS certificate verification to be disabled when it was configured as enabled. This could expose CAS authentication connections to man-in-the-middle attacks.
• Fixed issue: Concurrent requests from ADC caused a fatal crash (concurrent map writes) in the route validator due to unsynchronized access to lazy-initialized schema cache maps.
• Fixed issue: API call statistics flush held a database lock during IO operations, causing performance degradation under high traffic. The flush mechanism now uses swap-and-release with batch writes.

Console (Dashboard)

• Fixed issue: The Service Hub page and related modals crashed when a service had an empty or missing name.
• Fixed issue: Adding the same service published to different gateway groups as linked services, was incorrectly blocked by frontend validation.

Data Plane

• Fixed issue: DNS resolution intermittently returned incorrect IP addresses. When the gateway operated in cache-only mode, DNS Additional section records (nameserver glue records) were incorrectly included in resolution results and their domain names overwritten with the queried domain. This caused random upstream connection failures, as the gateway occasionally selected a nameserver IP instead of the actual service IP.
• Fixed issue: Stream routes with service_id silently failed if the referenced service arrived after the route via etcd sync. Service status changes (enable/disable) and deletions also did not trigger stream router rebuild.

Developer Portal

• Fixed issue: Every unauthenticated request to the Developer Portal generated a "No developer ID in session" log entry, flooding production logs and obscuring real errors.
• Fixed issue: The "Regenerate Secret" option was shown (as disabled) for OIDC provider credentials, instead of being hidden. It is now only visible for HTTP Bridge credentials.
• Fixed issue: After re-signing in without logging out, the owner role was not properly restored, causing role-gated UI buttons to appear disabled until a manual page refresh.

3.9.7

Release Date: 2026-03-25

Upgrade Notes

Upgrade note — additional plugin secret fields are encrypted at rest

The Control Plane now encrypts additional credential-bearing plugin fields at rest. Because API7 EE upgrades the Control Plane before the Data Plane, during the upgrade window a 3.9.7 Control Plane encrypts these fields while an older 3.9.6 Data Plane cannot decrypt them, which can cause the affected plugins to fail until the Data Plane is also upgraded.

The newly encrypted fields, by plugin, are:

• CSRF: key
• Kafka Proxy: sasl.password

If you use any of these plugins with the listed fields, upgrade the Data Plane to 3.9.7 promptly after the Control Plane, and avoid editing those plugins until both sides are on 3.9.7.

Features

Plugins

• AI Proxy
  • Added bidirectional protocol conversion between Anthropic and OpenAI formats. Users can send requests in Anthropic SDK format to OpenAI-compatible backends (such as DeepSeek or OpenRouter), with the gateway automatically converting request and response formats, including SSE streaming.
• OpenAPI to MCP
  • Added MCP Tool Annotations support. Tools generated from OpenAPI specs can now carry behavioral metadata (read-only, destructive, idempotent) via the x-mcp-annotations vendor extension, enabling AI agents to better understand and invoke APIs.

Control Plane

• Added a form-based UI for the Limit Count plugin in Dashboard, supporting visual configuration of Local, Redis, and Redis Cluster policies without manually editing JSON/YAML.
• Added custom menu groups in the Dashboard sidebar. External links such as internal documentation or wiki pages can be configured via a YAML config file.
• Improved performance under high API traffic by reducing database write frequency for hot-path operations (such as token last-used timestamps and gateway heartbeat timestamps) through write debouncing and in-memory caching. Also optimized distributed lock acquisition latency.

Data Plane

• Added port range support for stream_proxy TCP and UDP listeners (e.g., 2000-2100), eliminating the need to list each port individually when configuring a large number of proxy ports.
• Added encrypt_fields to the CSRF plugin (key) and the Kafka Proxy plugin (sasl.password).

Fixes

Plugins

• AI Proxy
  • Fixed issue: AI request token usage statistics (prompt_tokens, completion_tokens) were inaccurate when HTTP chunk boundaries did not align with SSE event boundaries in upstream responses.
• Prometheus
  • Fixed issue: apisix_llm_* metrics were exported for all API routes, even those without AI plugins enabled, causing unnecessary metric cardinality and storage overhead. Also added disabled_labels support for LLM metrics, allowing operators to selectively disable high-cardinality labels.

Control Plane

• Fixed issue: When multiple concurrent API requests modified Global Rules simultaneously, only the last write took effect in the gateway, even though Dashboard showed all modifications as successful.
• Fixed issue: Syncing service configurations with non-HTTPS active health checks via ADC failed with the error Unrecognized key: "https_verify_certificate".
• Updated the default worker count to 1 when adding Kubernetes gateway instances in Dashboard.

Data Plane

• Fixed issue: API call count statistics became inaccurate after a gateway worker process restart (e.g., an unexpected crash).

3.9.6

Release Date: 2026-03-09

Features

Plugins

• Error Log Collect
  • Added a new plugin to support centralized error log collection.
• Oas Validator
  • Added a new parameter reject_if_not_match. When set to false, it allows requests to pass to upstream services even if they fail OAS validation.
• Limit Count Advanced
  • Added more log information for easier debugging.

Control Plane

• Supported published Services and Routes in Resource name APIs.
• Added support for Services and Routes as alert conditions in alert policies.
• Supports dynamic rotation of Postgres credentials via Vault.

Data Plane

• Added the rate-limiting-info variable to retrieve detailed status information of rate-limiting plugins.
• Enhanced Docker images: switched to distroless base images and upgraded busybox to fix security vulnerabilities.

Fixes

Plugins

• Limit Count Advanced
  • Fixed issue: A panic in the synchronization function could cause the shared dictionary lock to not be released, leading to synchronization interruptions.

3.9.5

Release Date: 2026-02-14

Features

Plugins

• Feishu Auth
  • Added a new Feishu authentication plugin based on the OAuth 2.0 Authorization Code flow, supporting integration with internal business services in the workbench.
• Dingtalk Auth
  • Added a new Dingtalk authentication plugin that logs key information during the authentication process for easier tracking.

Control Plane

• Daily License Information Logging: The control plane now records daily license information, including CPU limits, expiration time, and current core usage. It starts logging reminders 3 months before the license expires. Users can directly view CPU usage through the logs.

• OpenTelemetry Data Collection and Visualization: The control plane can now dispatch debug and sampling tasks to data planes, receive reported data, and support data export via API along with frontend visualization.

  Note

  This feature introduces Jaeger as an additional component. If deploying with Helm, note that the control plane's values file enables Jaeger by default. The official Helm chart is available at https://charts.api7.ai.

Fixes

Data Plane

• Fixed issue: When plugins with encrypt_fields had schema fields with maxLength constraints (e.g., hmac-auth secret_key max 32 chars), the encrypted ciphertext exceeded the length limit because schema validation ran before decryption.

3.9.4

Release Date: 2026-02-03

Features

Control Plane

• After disabling SCIM, users can delete historical SCIM accounts synchronized from the IdP in API7.
• Supports uploading OpenAPI 3.1.0 and 3.1.1 files.

Fixes

Plugins

• Limit Count
  • Fixed issue: The counter data could be inaccurate if the Gateway crashed unexpectedly.

Data Plane

• Fixed issue: The heartbeat and metrics reporting would only use the first control plane address when multiple addresses were configured.

Control Plane

• Fixed issue: A route URL not starting with / would cause the conflict detection API to return a 500 error.
• Fixed issue: The code hints in the plugin configuration editor would sometimes stop working.

3.9.3

Release Date: 2026-01-26

Features

Plugins

• AI Request Rewrite
  • Supported two new providers: Gemini, Vertex AI.
• SAML Auth
  • Added auth_protocol_binding_method parameter to support configuring SAML protocol binding methods, including HTTP-POST and HTTP-Redirect. The default value is HTTP-Redirect (backward compatible with previous versions). HTTP-POST must be used when Azure AD is the identity provider.

Fixes

Plugins

• SAML Auth

  • Fixed issue: SAML sessions could not be shared across multiple gateway instances. Added the mandatory secret field for configuring the key to encrypt session data.

    Upgrade note

    The saml-auth plugin upgraded from older versions can work normally but cannot share sessions across multiple gateway instances. This issue can be resolved by configuring the secret field.

  • Fixed issue: Missing NameID field in the SAML request when processing logout requests. The absence of the NameID field will cause logout failure when Azure AD is the identity provider.

3.9.2

Release Date: 2026-01-19

Breaking Changes

Plugins

• OpenID Connect

  • The session.secret field is now required when bearer_only is false (the default). Previously, if not configured, a random secret was automatically generated on each data plane instance, which prevented sessions from being shared across multiple gateway instances.

    Upgrade note

    After upgrading, existing openid-connect plugin configurations without session.secret (with bearer_only set to false or unset) will fail schema validation on the data plane, and the routes they are attached to will stop being served. Configure the session.secret field (at least 16 characters, using the same value across all gateway instances) before upgrading the data plane.

Features

Plugins

• AI Proxy/AI Proxy Multi
  • Supported four new providers: Gemini, Vertex AI, OpenRouter, and Anthropic.
• Basic Auth/JWT Auth/Key Auth/HMAC Auth/LDAP Auth
  • Added a realm configuration option to set the Realm value in the WWW-Authenticate response header for 401 authentication failures.
• OpenID Connect
  • Supported validating claims by configuring claim_schema.

Control Plane

• Rejected gateway nodes with a version higher than the Control Plane.
• Supported querying node health status in multi-upstream scenarios.

Fixes

Plugins

• Limit Count
  • Fixed issue: The rate limiting counter was shared when the same rate-limiting configuration was applied across multiple consumers (introduced in 3.8.5).
• Limit Count Advanced
  • Fixed issue: Incorrect data appeared when resetting request headers (introduced in 3.8.19).
  • Fixed issue: Rate limiting data was not correctly submitted after enabling Redis delayed synchronization (introduced in 3.8.19).
  • Fixed issue: Redis password could not be specified in Redis Sentinel mode.
  • Fixed issue: Keepalive was not enabled for Redis connections in Redis Sentinel mode.
• Syslog
  • Fixed issue: After sending an excessively long log in UDP mode, subsequent logs could not be sent.
• Request ID
  • Fixed issue: The system failed to generate a new request ID when the request-id provided by the client was empty.

Data Plane

• Fixed issue: A deepcopy table overflow error could occur during the startup process.
• Fixed issue: The server header still returned "APISIX" when enable_server_tokens was disabled.
• Fixed issue: The health checker caused the gateway to continuously output error logs after an update to the ai-proxy-multi plugin.

Control Plane

• Fixed issue: The default client.depth for SSL resources was too small, causing mTLS migration failure for Cloud v2 users.
• Fixed issue: Data duplication could occur during concurrent calls to the SSL API.
• Fixed issue: The health status of frontend components on the Console (Dashboard) was not reflected in the /healthz API response.

3.9.1

Release Date: 2026-01-08

Fixes

Developer Portal

• Fixed issue: "Developers" created in older versions of the Developer Portal could not be deleted.

3.9.0

Release Date: 2026-01-06

Breaking Changes

Developer Portal

• Newly Redesigned Developer Portal

  Upgrade note

  The Developer Portal has been completely redesigned. This release introduces breaking changes that require action before upgrading:

  • The built-in Portal SSO feature has been removed. Configure authentication through the new Portal-level authentication mechanism instead.
  • The Portal frontend is now open-source. Existing Portal customizations must be migrated to the new SDK-based architecture.

Features

• All API7 Enterprise Docker images are now signed using Cosign, enhancing image security.

Developer Portal

• Provides open-source SDKs and a frontend scaffolding project to facilitate user customization and development.
• Introduces a new Portal-level authentication mechanism for API integration.

Plugins

• Limit Conn/Limit Req

  • Supported using Redis and Redis Cluster as the rate limiting data storage backend.

    Upgrade note

    Added a new required field policy. Existing configurations do not require modification and will continue to function in the data plane. However, when updating a configuration, this field must be supplied (e.g., policy=local), otherwise the update will be rejected.

• Request ID

  • Added a new algorithm ksuid for ID generation.

• Loki Logger

  • Supported customizing HTTP headers sent to the Loki server.

• File Logger

  • Supported conditional request logging using the match field.

• Workflow

  • The rules field is now required.

Control Plane

• Allowed to completely disable built-in username/password login after enabling SSO login.
• Supported configuring the maximum execution time for database statements.
• Observability Enhancements
  • Enabled the pprof performance profiling by default.
  • Added database connection pool metrics to the metrics endpoint.
  • Supported separate logging for access and error logs.
  • Added the request_id field to access and error logs.

Fixes

Plugins

• OpenAPI to MCP
  • Fixed issue: Passing authentication credentials via query parameters could lead to sensitive information leakage.

Data Plane

• Optimized caching behavior for resolution chains that involve CNAME and A records.

Control Plane

• Removed the display of IP and Port from the gateway instance list to avoid misleading users.
• Fixed issue: Database deadlocks could occur during concurrent batch inserts into the API call statistics table.
• Fixed issue: Dashboard failed to start when using a non-public schema in PostgreSQL.

3.8.23

Release Date: 2026-02-03

Features

Control Plane

• Supports uploading OpenAPI 3.1.0 and 3.1.1 files.

Fixes

Data Plane

• Fixed issue: Heartbeat and metrics would only be reported to the first control plane address when multiple addresses were configured.

Control Plane

• Fixed issue: A route URL not starting with / would cause the conflict detection API to return a 500 error.

3.8.22

Release Date: 2026-01-19

Fixes

Plugins

• Limit Count
  • Fixed issue: The rate limiting counter was shared when the same rate-limiting configuration was applied across multiple consumers (introduced in 3.8.5).
• Limit Count Advanced
  • Fixed issue: Incorrect data appeared when resetting request headers (introduced in 3.8.19).
  • Fixed issue: Rate limiting data was not correctly submitted after enabling Redis delayed synchronization (introduced in 3.8.19).
  • Fixed issue: Redis password could not be specified in Redis Sentinel mode.
  • Fixed issue: Keepalive was not enabled for Redis connections in Redis Sentinel mode.
• Syslog
  • Fixed issue: After sending an excessively long log in UDP mode, subsequent logs could not be sent.
• Request ID
  • Fixed issue: The system failed to generate a new request ID when the request-id provided by the client was empty.

Data Plane

• Fixed issue: A deepcopy table overflow error could occur during the startup process.

Control Plane

• Fixed issue: The default client.depth for SSL resources was too small, causing mTLS migration failure for Cloud v2 users.
• Fixed issue: Data duplication could occur during concurrent calls to the SSL API.
• Fixed issue: The health status of frontend components on the Console (Dashboard) was not reflected in the /healthz API response.

3.8.21

Release Date: 2025-12-23

Features

Plugins

• gRPC Web
  • Supported enabling the plugin on routes that use non-wildcard paths.
• OpenAPI to MCP
  • Provided the flatten_parameters parameter to control whether path and query parameters from the OpenAPI specification are placed at the top level of the tools input schema.

Data Plane

• Fallback CP
  • Supported using the gateway as a backup node to sync data to AWS S3 and Azure Blob. Note that backup nodes do not provide HTTP/HTTPS services and are not counted towards the license quota.
  • Supported authentication using AWS IAM Role and Azure Managed Identity.

Control Plane

• Supported using MSSQL Server 2022 as the database for the control plane.
• Provided script generation for deploying gateway instances using Docker Compose.
• Improved the text prompts for each parameter when deploying gateway instances in Kubernetes.

Fixes

Plugins

• AI Proxy/AI Proxy Multi
  • Fixed issue: Headers configured in the plugin could not override downstream headers with the same name due to case-insensitivity.
• Limit Conn/Limit Count Advanced/AI Rate Limiting
  • Fixed issue: The rules.key field did not support the variable default value syntax.
• OpenAPI to MCP
  • Fixed issue: Errors or perpetual loading occurred when configuring the MCP Server in AI clients such as Cursor and Cline.

Data Plane

• Fixed issue: The gateway continued its startup process even after failing to connect to the control plane during initialization.
• Fixed issue: Heartbeat failed when the gateway listened on the same port using different IP addresses.
• Fixed issue: The Fallback CP feature failed to load credential data correctly.
• Fixed issue: Optimized the performance after enabling the Prometheus plugin.

Control Plane

• Fixed issue: For services created via the Admin API, their routes could not be selected on the console's monitoring page to view monitoring data.
• Fixed issue: Incorrect "Unhealthy Ratio" data displayed on the console's upstream page after configuring active health checks for an upstream.

3.8.20

Release Date: 2025-12-11

Fixes

Plugins

• OpenAPI to MCP
  • Fixed issue: Variables in base_url were not resolved correctly.

3.8.19

Release Date: 2025-12-09

Features

Plugins

• OpenAPI to MCP
  • Supported using variable syntax in base_url.
• AI Rate Limiting
  • Supported using Redis, Redis Cluster, and Redis Sentinel as storage backends.

Upgrade note

The ai-rate-limiting plugin now requires a new policy field. Existing configurations continue to function on the data plane, but any updates must include policy: local; otherwise, the update will be rejected.

Data Plane

• Added support for the ${external_user.*} built-in variable to retrieve values from external user information. The variable is injected by the openid-connect plugin and developer portal OAuth authentication.

Fixes

Plugins

• AI Proxy/AI Proxy Multi
  • Fixed issue: Request headers generated by the client or other plugins were not forwarded to the upstream.
• AI Rate Limiting/Limit Count Advanced
  • Fixed issue: When multiple rules were matched simultaneously, the rate-limiting headers could not be distinguished. By default, they are now distinguished by the index of the matched rule. The header_prefix configuration is also supported for custom prefixes.
  • Fixed issue: When variables were used in the limit field, the rate-limiting status was not updated in real-time after the variable's value changed.

Control Plane

• Fixed issue: Users' access tokens could still be used to access APIs after expiration.
• Fixed issue: The "Labels" section in the Dashboard displayed a large number of duplicate input fields when creating a route.
• Fixed issue: Disabled plugins on a route could not override enabled plugins of the same name on the associated service.
• Fixed issue: Dropdown option values in the Portal Dashboard changed frequently.
• Fixed issue: Plugin configurations in the Dashboard did not automatically populate default values.

3.8.18

Release Date: 2025-11-25

important

To support creating multiple Portal instances, the portal-auth plugin of the data plane has been upgraded. After upgrading the control plane, users should upgrade the data plane as soon as possible. During the period between the control plane upgrade and the data plane upgrade completion, please do not update existing API products, as such changes will not take effect.

Features

Data Plane

• Supported specifying the backlog configuration for listening ports.
• Supported Azure Blob storage type in fallback_cp.

Control Plane

• Supported Dynamic Client Registration (DCR) provider management.
• Supported DCR authentication type in API products.
• Supported OAuth authentication type (obtaining client ID and client secret based on DCR) in Developer credentials.
• Supported creating multiple Portal instances. Existing Portal usage data will be assigned to the automatically created default Portal instance.
• API7 Dashboard supported specifying the license storage path in the configuration file.

Fixes

Plugins

• All Logger Plugins
  • Fixed issue: Logger plugins failed to obtain request bodies when client request bodies were too large to generate temporary files.
• AI Proxy Multi
  • Fixed issue: Health checkers were rebuilt when requests hit different consumers.

Control Plane

• Fixed issue: The Helm Chart version was not locked in the Ingress Controller installation script.
• Fixed issue: Offline gateway instances were still displaying compatibility tags.
• Fixed issue: When creating/updating upstreams, the system did not check if upstream_host was empty when pass_host was set to rewrite.
• Fixed issue: In the Developer Portal, when OpenAPI documents contained multiple server_urls, developers could not select a server_url when initiating test requests.
• Fixed issue: Developers with subscriptions under the "pending approval" state can still make requests to the gateway.

3.8.17

Release Date: 2025-11-10

Features

Plugins

• Limit Conn
  • Supported variable syntax in the conn and burst fields.
  • Added a rules field for configuring multiple rate-limiting rules simultaneously.
• Limit Count Advanced
  • Supported variable syntax in the count and time_window fields.
  • Added a rules field for configuring multiple rate-limiting rules simultaneously.
• AI Rate Limiting
  • Supported variable syntax in the limit and time_window fields.
  • Added a rules field for configuring multiple rate-limiting rules simultaneously.
• AI Proxy/AI Proxy Multi/AI Request Rewrite
  • Supported the aimlapi provider.
• OpenAPI to MCP
  • Considered the default values of query parameters defined in OpenAPI when sending requests to the upstream service.
• All Access Log Logging Plugins
  • Supported configuring each plugin's batch processor max_pending_entries in the plugin metadata, for the the maximum number of pending entries in the batch processor.
  • Flushed the pending logs to the logging service before the worker process exited.

Control Plane

• Supported configuring IP whitelist and blacklist for accessing the dashboard.

Fixes

Plugins

• AI Proxy Multi
  • Fixed issue: Multiple worker processes cannot share the health checker of an AI instance.

Control Plane

• Fixed issue: Cannot upload license when the browser lacks permissions.
• Fixed issue: Bad performance of the gateway when the number of upstream.nodes is very large.
• Fixed issue: The policy field of plugins, such as limit-count and limit-count-advanced, is optional (should be required).
• Fixed issue: When creating a new SSO page and clicking "Back", the page redirected to the SMTP Server page.

3.8.16

Release Date: 2025-10-28

Features

Plugins

• Kafka Logger
  • Supported SCRAM-SHA-512 in SASL mechanism.

Data Plane

• Supported wildcard SNI matching for SSL certificates, allowing a single certificate to cover multiple subdomains.

Control Plane

• Added support for specifying host when publishing Gateway service in API Portal.
• Added cache configuration support for query failure scenarios in the Gateway secret module.
• Updated Ingress Controller installation form to support configuring namespace and name.
• Specified supported versions when importing OpenAPI in the Dashboard UI.
• Removed the bare metal tab from the Gateway deployment page.

Fixes

Plugins

• OpenAPI to MCP
  • Fixed issue: SSE mode does not work when path_prefix and strip_path_prefix were both configured in the service.
  • Fixed issue: MCP tool names were generated from the OpenAPI paths, which could exceed the length limit for tool names. Now MCP tool names are generated from OpenAPI operation IDs.
  • Fixed issue: A 500 status code was thrown when the headers field was not configured.

Control Plane

• Fixed issue: ADC Sync could synchronize to the wrong gateway group when group names were similar.
• Fixed issue: Login option role mapping retained previous roles even when no rules were matched.
• Fixed issue: The Request Scope field of the OIDC Login Option included an unnecessary “Add” button.
• Fixed issue: Old configurations were sometimes not displayed in the Edit Login Option form.
• Fixed issue: Unnecessary changes occurred during ADC diff due to overly complex core resource schema.
• Fixed issue: User’s updated_at timestamp was not refreshed when updating user roles.

3.8.15

Release Date: 2025-10-13

Features

Plugins

• Lago
  • Introduced new plugin.
• Traffic Split
  • Now available for Stream service.
• OpenAPI to MCP
  • Supported streamable HTTP as a transport method for MCP.

Data Plane

• Supported GCP Secret Manager as a secret management backend.

Control Plane

• Supported configuring the Prometheus query path prefix in Dashboard.

Fixes

Data Plane

• Fixed issue: Creating multiple GatewayProxy/IngressClass for the same gateway group will cause resource conflicts and route overwrites.
• Fixed issue: Error logs contain sensitive information.
• Fixed issue: grpc-web responses lost trailers when the response body was empty.

3.8.14

Release Date: 2025-09-25

Fixes

Data Plane

• Fixed issue: Upstream reference error when configuring multiple services with duplicate backends in Ingress Controller v2.0.6.
• Fixed issue: Gateway instance status calculation error when using PostgreSQL databases with non-UTC timezones.

3.8.13

Release Date: 2025-09-23

Features

Plugins

• OpenAPI to MCP
  • Introduced new plugin.

Console (Dashboard)

• Supported Admin API and DPM Address in API7 Helm Chart.

Data Plane

• Supported configuring the Prometheus remote write endpoint URLs in DP Manager.
• Aligned the certificate usage API response fields with the OpenAPI specification.

Fixes

Console (Dashboard)

• Fixed issue: Prompt message handling for internal login email integration on the API7 Dashboard.
• Fixed issue: Error messages for invalid custom plugin schemas, previously only visible in the browser console, are now displayed on the API7 Dashboard.
• Fixed issue: Configuration interference between include_resp_body settings across logging plugins.
• Fixed issue: Warnings appeared during the frontend console build process.

Data Plane

• Fixed issue: Secrets could not be dynamically updated.

Developer Portal

• Fixed issue: OAS could not be queried when creating products in Provider Portal for services created using ADC.
• Fixed issue: Hierarchy issues when downloading OpenAPI documentation in Provider Portal.

3.8.12

Release Date: 2025-09-17

Fixes

Console (Dashboard)

• Fixed issue: Users with policies scoped by service_label could not edit the corresponding services or service templates.
• Fixed issue: Authorization by label on service templates incorrectly reused the label of a published service with the same ID during list API authorization.

3.8.11

Release Date: 2025-08-25

Features

Plugins

• AI Request Rewrite
  • Introduced new plugin.
• AI RAG
  • Introduced new plugin.
• AI AWS Content Moderation
  • Introduced new plugin.

Console (Dashboard)

• Improved guidance when the root user generates a token. The UI now clearly instructs users to create a new user and generate tokens under that account.
• Supported enabling pprof in the Enterprise control plane with a configuration switch. It listens on 127.0.0.1 and is disabled by default.

Dependencies

• Included the latest version of ADC in the Enterprise offline release package.

Fixes

Plugins

• Custom Plugins
  • Fixed issue: Uploading a custom plugin without a schema returned 500.
• Basic Auth
  • Fixed issue: Made the scheme part ("Basic") case-insensitive.
• AI Proxy Multi
  • Fixed issue: Abnormal traffic distribution.
• AI Prompt Decorator
  • Fixed issue: User historical messages were incorrectly appended to messages in logs/configurations. The plugin now only inserts system prompts as expected.

Data Plane

• Fixed issue: With the EWMA load balancing algorithm, historical statistics were not cleaned up, which could exhaust the allocated shared memory and cause errors.

Console (Dashboard)

• Fixed issue: Users logging in on multiple devices could get stuck on the license activation page.
• Fixed issue: The /plugins key was only written during custom plugin operations or at dashboard startup. As a result, creating a new gateway under a newly created gateway group could not synchronize the list of enabled plugins from the control plane. The key is now created correctly.
• Fixed issue: When creating Services via ADC, duplicate Routes across different Services were not detected by the route conflict checker.
• Fixed issue: Long labels were not fully displayed in the UI.
• Fixed issue: Concurrently creating a Service with the same ID could result in duplicate creation.
• Fixed issue: Creating two Routes simultaneously could report that the Routes' Service already exists.
• Fixed issue: On the login page, when there were too many login options, the header overlapped and the page could not scroll.

3.8.10

Release Date: 2025-08-25

Features

Plugins

• SOAP
  • Introduced new plugin.

Data Plane

• Supported configuring the addresses for DP Manager and the Admin API via an API7 Dashboard configuration file.

Console (Dashboard)

• Supported specifying the Admin API address in the gateway deployment configuration, which will be used to populate the GatewayProxy Endpoint address in the API7 Ingress Controller deployment script.
• Consolidated allow_access API calls in the API7 Dashboard frontend to reduce redundant requests.
• Added hash_on configuration item to upstream connection configuration.

Fixes

Plugins

• AI Proxy Multi
  • Fixed issue: A panic was triggered by connection timeouts to the upstream service.
• Removed the ext-plugin-pre-req, ext-plugin-post-req, and ext-plugin-post-resp plugins from the Enterprise Edition.

Data Plane

• Fixed issue: A deadlock could occur when the Control Plane updates the service API due to insufficient database connections.
• Fixed issue: Upon restarting, worker processes could load stale data from the master process. This could cause temporary request failures (e.g., 404 errors) for recently created or modified routes before the worker process synchronized the latest data from etcd.
• Fixed issue: Etcd history compaction could trigger a full data load in APISIX, causing a significant performance impact on the etcd service, especially in environments with a large number of gateway nodes.

Console (Dashboard)

• Fixed issue: A consumer could not be created when its permission policy was configured to grant all permissions based on labels.
• Fixed issue: In the consumer list page, pagination would occasionally fail. Attempting to navigate to another page would result in a brief loading state, but the view would remain on the current page.

3.8.9

Release Date: 2025-08-11

Features

Plugins

• JWT Auth
  • Added store_in_ctx parameter to store validated JWT object in request context. When set to true (default is false), the plugin stores the validated JWT object in the request context, useful for custom plugins that need to parse JWT to extract permissions.
• Workflow
  • Added support for limit-conn plugin integration, allowing dynamic connection limit strategies based on user requests and current APISIX load pressure.

Data Plane

• Supported Kubernetes 1.18 in API7 Enterprise Ingress Controller.
• Backported Chaitin WAF plugin from APISIX to API7 Enterprise.

Console (Dashboard)

• Added audit log record TTL configuration option, allowing users to set automatic deletion time for audit log table data. Default value is 60 days.
• Optimized Dataplane manager SQL statements when updating cached Consumer data.

Developer Portal

• Added support for CAS login.

Fixes

Plugins

• OAS Validator
  • Fixed issue: Adjusted error level for detailed response errors from error to warn when verbose_errors is enabled.
• JWT Auth
  • Fixed issue: Plugin failed to validate exp claim when claims_to_verify: ["exp"] is set.
• Consumer Restriction
  • Fixed issue: Improved error messages when using consumer-restriction with basic-auth plugin. When type is set to consumer_group_id with blacklist configuration, non-blacklisted consumers now receive appropriate error messages.
• Kafka Logger
  • Fixed issue: Performance degradation when max_pending_entries is enabled in service configuration with many routes. The issue was caused by each route creating separate batch processor buffers due to plugin conf deepcopy during service and route merging.
• Limit Count Advanced
  • Fixed issue: Plugin panic triggering shared memory deadlock.

Data Plane

• Fixed issue: Error information could not be properly recorded when reading request body in ctx variables.

Console (Dashboard)

• Fixed issue: Chinese labels imported from OpenAPI files were displayed as Chinese pinyin instead of original Chinese characters.
• Fixed issue: Route information occasionally stuck in loading state after frequent route switching.
• Fixed issue: PUT API could create credentials for non-existent consumers.
• Fixed issue: Language switching inconsistency where switching to English on login page would revert to Chinese after login.

Developer Portal

• Fixed issue: SAML/OIDC logout did not properly sign out from IDP login state. After SSO logout, only Control Plane login state was cleared while IDP login state remained, causing automatic login success when clicking SSO login button again.

3.8.8

Release Date: 2025-07-28

Features

Data Plane

• Supported Consul service discovery deduplication and node sorting.
• Supported accessing uri_param_* variables when using radixtree_uri_with_parameter router.
• Upgraded the base image for the API7-EE-3-Gateway to Ubuntu 24.04.

Developer Portal

• Supported viewing current API usage statistics for developers in applications.
• Upgraded Scalar to version 0.7.25.

Dependencies

• Upgraded Casbin to version 1.41.9.

Console (Dashboard)

• Optimized Ingress gateway group deployment scripts by adding config.controllerName.

Fixes

Data Plane

• Fixed issue: Corrupt data in routes() response due to health checker data.
• Fixed issue: grpc-web responses could contain duplicate trailer chunks.
• Fixed issue: Inconsistent response headers for different strategies in the proxy-cache plugin.

Plugins

• API Breaker
  • Fixed issue: The api-breaker plugin failed to trigger correctly due to an inaccurate time point (breaker_time) in the implementation.
• AI Proxy
  • Fixed issue: Fix upstream_response_time being empty by adding apisix_upstream_response_time variable to measure the time APISIX takes to communicate with the upstream and receive the response.

Console (Dashboard)

• Fixed issue: Concurrent requests to generate deployment scripts for a new gateway group could result in duplicate keys.
• Fixed issue: Repeatedly clicking "View ID" across different routes would accumulate route IDs.
• Fixed issue: Creation and update timestamps were incorrectly positioned in the resource details.
• Fixed issue: Audit logs were not recorded for plugin operations (create/delete/edit) in published services.
• Fixed issue: Infinite redirect during CAS login caused by an abnormal server timestamp.
• Fixed issue: Resource selector on the monitoring page was too narrow, causing text truncation.

3.8.7

Release Date: 2025-07-17

Features

Plugins

• Limit Count Advanced
  • Added support for Redis Sentinel mode.

Data Plane

• Supported component upgrade sequence control to ensure dp-manager waits for database migration before startup.

Console (Dashboard)

• Supported OpenAPI editor pre-fills previous data for service OpenAPI specifications, avoiding full re-entry for simple modifications.
• Supported configuring and enabling Content Security Policy (CSP) by default.
• Supported displaying both Gateway API and Ingress deployment scripts for Ingress Controller gateway groups.

Developer Portal

• Supported deleting developers in the Provider Portal.
• Introduced an "Application" resource to manage API product subscriptions and credentials at the application level.

Fixes

Plugins

• Zipkin
  • Fixed issue: zipkin_trace_id appeared garbled in access.log.
• Forward Auth
  • Fixed issue: Forwarding POST requests with forward-auth plugin may result in 504 errors caused by the request body being lost. Resolved by introducing extra_headers.

Data Plane

• Fixed issue: Some Control Plane APIs (/api/license, /api/system_infos, /api/developer-portal-url) could be accessed without authorization.
• Fixed issue: delay_encode could only be used once per log line.
• Fixed issue: Metrics failed to report after startup due to certificate issues.

Console (Dashboard)

• Fixed issue: Deleting source code while editing a custom plugin cleared the entire form.

Developer Portal

• Fixed issue: Unauthenticated users could see non-subscribable products after filtering for subscribed API products.
• Fixed issue: The "Clear All" button has been removed for API products with a single filter, as its function overlaps with selecting "All" conditions.

3.8.6

Release Date: 2025-06-27

Features

Plugins

• Elasticsearch Logger
  • Added support for Elasticsearch 9.0.2.

Fixes

Plugins

• OpenID Connect
  • Fixed issue: Sessions not properly closed on errors, leading to resource leaks.

Data Plane

• Fixed issue: Worker process not exiting when executing quit or reload command.
• Fixed issue: Port values greater than 65535 were incorrectly accepted.
• Fixed issue: etcd data sync failure when keys contain special characters.
• Fixed issue: Kubernetes service discovery performance degradation due to watch progress re-listing all data.
• Fixed issue: Memory leak in Kafka Logger causing nginx worker crashes.

Console (Dashboard)

• Fixed issue: Clicking "Delete" on plugins only disabled them instead of removing them.
• Fixed issue: Incorrect or missing namespace/service data in upstream when using Kubernetes service discovery.

Security

• Fixed issue: TLSv1.3 cross-SNI session resumption vulnerability (backported HTTP fixes from nginx 1.21.4).

3.8.5

Release Date: 2025-06-16

Features

Console (Dashboard)

• Added route URI information to alert messages for status code-related alert events.

Fixes

Dependencies

• Upgraded OpenSSL from version 3.2.3 to 3.2.4.
• Upgraded Debian base image to Bookworm.

Data Plane

• Fixed issue: Severe performance impact occurred when OAS plugin spec files are too large.
• Fixed issue: post_arg matching fails when content-type contains charset.
• Fixed issue: Consumers did not share the same counter in the limit-count plugin.
• Fixed issue: Missing etcd init_dir prevents listing resources.
• Fixed issue: real_payload can be overridden by malicious payload in the jwt-auth plugin.
• Fixed issue: Incorrect variables and redundant TLS configs in upstream_schema.

Console (Dashboard)

• Fixed issue: Route plugin updates in services mistakenly override existing plugins.

3.8.4

Release Date: 2025-06-11

Fixes

Data Plane

• Optimized the performance of large table data migration during control plane upgrades.
• Added caching logic to post_arg to optimize performance and prevent repeated inefficient parsing.
• Fixed issue: The cache for ctx variables prefixed with http_ and graph_ is not effective.
• Fixed issue: Prometheus metrics are not properly retained after degradation and recovery.

Console (Dashboard)

• Fixed issue: The plugin's editing method (form or code) is not displayed correctly.
• Fixed issue: Error in the code suggestions in the Response Rewrite plugin editor.

3.8.3

Release Date: 2025-06-04

Features

Plugins

• Automatically inserted _meta into the schemas of custom plugins.

Data Plane

• Supported the configuration of apisix.disable_upstream_healthcheck in conf/config.yaml to disable all health checks with a single switch.
• Optimized Prometheus performance by mitigating high memory consumption.
• Released API7 Ingress Controller 2.0.

Console (Dashboard)

• Optimized the deployment process for ingress controller type of gateway groups.
• Added alert policy event trigger "license will expire".

Fixes

Data Plane

• Fixed issue: Occasional route matching error when reading body for GraphQL requests with post_arg.

Console (Dashboard)

• Fixed issue: Upgrade dependencies ramda to 0.30.1 and cross-spawn to 7.0.5 to avoid high-risk vulnerabilities.
• Fixed issue: The max-age field is displayed incorrectly when configuring the cors plugin details using the dashboard form.
• Fixed issue: After upgrading ADC from version 17.x to 19.x, the Dashboard continues displaying outdated configurations when multiple routes under the same service are updated simultaneously.
• Fixed issue: Unable to view plugin configurations within a service with the gateway:GetPublishedService or gateway:GetServiceTemplate permissions in the dashboard.
• Fixed issue: API7 Enterprise built-in plugins do not work properly when two custom plugins contain faulty code.
• Fixed issue: Kubernetes service discovery experiences performance issues with a high number of upstream nodes.
• Fixed issue: Headers have inconsistent casing. They are standardized to title case.

3.8.2

Release Date: 2025-05-19

Features

Plugins

• AI Proxy Multi
  • Added retry logic for 429/5xx response codes to improve request success rate.

Data Plane

• Added support for reverse proxying AzureAI services.

Console (Dashboard)

• Supported CAS as an SSO login option for API7 Enterprise.

Fixes

Console (Dashboard)

• Fixed issue: Failed to update basic information of published services.
• Fixed issue: retry_timeout and retries cannot be edited in the stream service upstream.
• Fixed issue: Page crash when gateway instance is missing compatibility field.

Data Plane

• Fixed issue: Long startup time for standalone mode with large configuration files.
• Fixed issue: OAS Validator plugin incorrectly rejecting numbers between 1.11-1.19 with multipleOf: 0.01 rule.
• Fixed issue: AI Proxy plugin would accept invalid endpoint URLs (e.g. missing colon in "http//localhost").

3.8.1

Release Date: 2025-05-07

Features

Plugins

• Limit Count Advanced
  • Added automatic fallback to local shared dict when Redis is unavailable, preventing request failures during Redis outages.

Data Plane

• Supported active and passive health checks for Stream (Layer 4) routes.

Console (Dashboard)

• Specified the validity period of the gateway instance certificate when adding a gateway instance.
• Added a warning in the gateway instance list when the certificate is about to expire.
• Supported viewing the certificate renew method for gateway instances in the dashboard and generating new gateway instance certificates.

Fixes

Data Plane

• Fixed issue: Health checks do not work as expected when using TCP services, and requests are still forwarded to unhealthy upstream nodes.
• Fixed issue: High latency in gateway requests due to Redis service failures.
• Fixed issue: Error in determining the default value of llm_time_to_first_token in AI Gateway.

Plugins

• Removed the snowflake algorithm from the request-id plugin due to potential risks.

Console (Dashboard)

• Fixed issue: The total bandwidth chart data on the monitoring page was inconsistent with Prometheus.
• Fixed issue: When forced publishing is enabled, modifications to the Route’s timeout and plugin configurations are not allowed in the published service.

3.8.0

Release Date: 2025-04-22

Features

Plugins

• AI Proxy
  • Implemented new identifier fields logging and summaries for collecting LLM request and response content.
• AI Proxy Multi
  • Supported HTTP POST method for health checks.
  • Displayed a record at the warning log level if the fallback was triggered.
  • Implemented a new identifier field for collecting LLM request and response content.
• AI Aliyun Content Moderation
  • Added support for streaming (HTTP SSE) scenarios.
• AI Prompt Guard
  • Introduced new plugin.
• Kafka Logger
  • Supported reading the user request and response body content cached in ctx and pushing it to the specified Kafka service.

Data Plane

• Supported using values from an array object within the user request body in routing conditions. While post_arg was already permitted in routing conditions, this update introduces support for array scenarios for the type field's location.
• Supported the recording of additional AI request context information within access logs.
• Supported adding a request type identifier to Prometheus metrics to collect more granular data on AI requests.

Console (Dashboard)

• Added detailed statistics for service name and route name in status code alert messages.
• Optimized plugin configuration: When configuring Traffic Split plugin on a service or route, verify that the upstream_id configured indeed belongs to the current service's upstreams.
• Aligned the upstream connection configuration field names with the API in published services.
• Introduced a form-based UI for CORS plugin configuration.

Fixes

Data Plane

• Fixed issue: When the upstream type was Kubernetes service discovery, nodes in health checks were not updated after node changes, resulting in many health check failure logs.
• Fixed issue: An error occurred when the shared_size parameter for Kubernetes service discovery was adjusted to 100m.#11857
• Fixed issue: APISIX/API7 Enterprise with Kubernetes discovery will fail after token file expires. #11779
• Fixed issue: After updating the prefix of Vault secret provider, the data plane continued to use the old configuration.

Console (Dashboard)

• Fixed issue: The retries field in the upstream was incorrectly set as required.
• Fixed issue: An error occurred on the published service page due to lack of service template permissions.
• Fixed issue: Updating the service discovery service name in published services did not take effect.
• Fixed issue: Creating multiple records with rapid clicks.
• Fixed issue: High database CPU utilization when using large scale of consumers.
• Optimized the wildcard configuration method for Permission Policy:
  • Wildcard configuration using * is now supported in authorization statements, with the same meaning as the current <.*>；
  • The asterisk * is restricted and not allowed in any resource ID fields to prevent authorization failures.

3.7.8

Release Date: 2025-06-16

Fixes

Console (Dashboard)

• Fixed issue: Route plugin updates in services mistakenly override existing plugins.

3.7.7

Release Date: 2025-06-11

Fixes

Console (Dashboard)

• Optimized the performance of large table data migration during control plane upgrades.

3.7.6

Release Date: 2025-06-02

Fixes

Data Plane

• Fixed issue: Kubernetes service discovery experiences performance issues with a high number of upstream nodes.

Console (Dashboard)

• Fixed issue: API7 Enterprise built-in plugins do not work properly when two custom plugins contain faulty code.
• Fixed issue: After upgrading ADC from version 17.x to 19.x, the Dashboard continues displaying outdated configurations when multiple routes under the same service are updated simultaneously.

3.7.5

Release Date: 2025-05-19

Fixes

Console (Dashboard)

• Fixed issue: Failed to update basic information of published services.

Data Plane

• Fixed issue: Long startup time for standalone mode with large configuration files.
• Fixed issue: OAS Validator plugin incorrectly rejecting numbers between 1.11-1.19 with multipleOf: 0.01 rule.

3.7.4

Release Date: 2025-04-30

Features

Console (Dashboard)

• Specified the validity period of the gateway instance certificate when adding a gateway instance.
• Added a warning in the gateway instance list when the certificate is about to expire.
• Supported viewing the certificate renew method for gateway instances in the dashboard and generating new gateway instance certificates.

Fixes

Data Plane

• Fixed issue: Health checks do not work as expected when using TCP services, and requests are still forwarded to unhealthy upstream nodes.
• Fixed issue: High latency in gateway requests due to Redis service failures.
• Fixed issue: Error in determining the default value of llm_time_to_first_token in AI Gateway.

Plugins

• Removed the snowflake algorithm from the request-id plugin due to potential risks.

Console (Dashboard)

• Fixed issue: The total bandwidth chart data on the monitoring page was inconsistent with Prometheus.
• Fixed issue: When forced publishing is enabled, modifications to the Route’s timeout and plugin configurations are not allowed in the published service.

3.7.3

Release Date: 2025-04-22

Fixes

Console (Dashboard)

• Fixed issue: High database CPU utilization when using large scale of consumers.
• Optimized the wildcard configuration method for Permission Policy:
  • Wildcard configuration using * is now supported in authorization statements, with the same meaning as the current <.*>；
  • The asterisk * is restricted and not allowed in any resource ID fields to prevent authorization failures.

3.7.2

Release Date: 2025-03-24

Fixes

Plugins

• OpenTelemetry
  • Fixed issue: A 404 response on the dynamic route /v2/:customerNumber results in an empty reported path.

Admin APIs

• Fixed issue: Resources lack consistent name and desc length enforcement up to 65535 characters, causing errors when users input valid long strings.

Console (Dashboard)

• Fixed issue: Users observe encrypted ciphertext, not their original plaintext input, for sensitive service and route fields after database storage.
• Fixed issue: Upon dashboard restart, the previously deleted default gateway group is erroneously regenerated.
• Fixed issue: Token name updates are not reflected in the notification area.

Dependencies

• Upgraded to Go 1.23.
• Upgraded to Next.js 14.2.25 to resolve CVE-2025-29927.

3.7.1

Release Date: 2025-03-14

Fixes

Plugins

• OpenID Connect
  • Fixed issue: Cannot configuring verify issuer.
  • Fixed issue: Unable to validate audience claim. #11018.

3.7.0

Release Date: 2025-03-10

Features

Data Plane

• Reference Secrets in Kubernetes Secret: The secret provider now supports Kubernetes secrets. This allows you to reference sensitive values from Kubernetes secrets for use in SSL certificates, SSL private keys, consumer credentials, and various plugin configurations.

Plugins

• AI Rate Limiting
  • Introduced new AI plugin which enforces token-based rate limiting for requests sent to LLM services. It helps manage API usage by controlling the number of tokens consumed within a specified time frame, ensuring fair resource allocation and preventing excessive load on the service. It is often used with AI Proxy Multi plugin.
• AI Proxy
  • Supported openai-compatible provider.
  • Supported proxying embedding model APIs.
• AI Proxy Multi
  • Supported openai-compatible provider.
  • Supported bypassing upstream configuration when using the plugin.
  • Supported active health check.
  • Supported proxying embedding model APIs.

Console (Dashboard)

• Supported *referencing a specific secret from Kubernetes Secrets: See Reference a secret in Kubernetes Secrets for details.
• Added page size selector for all tables.
• Displayed the service ID and service template ID on the service page header, and the route ID and route template ID on the route page header.

Admin APIs

• Added Reference Secrets in Kubernetes Secret related APIs:
  • Get a Kubernetes secret provider on a gateway group.
  • Update a Kubernetes secret provider on a gateway group.
  • Delete a Kubernetes secret provider on a gateway group.

Fixes

Data Plane

• Fixed issue: Duplicated gateway instance IDs result in inaccurate CPU counts.

Console (Dashboard)

• Fixed issue: Alert email delivery failed due to an invalid From Name format in the SMTP server configuration.
• Fixed issue: Plugin metadata is not deleted when deleting the custom plugin.
• Fixed issue: The Skip Path Prefix field is not removed when manually adding a stream service.
• Fixed issue: The priority of route cannot be set to negative numbers.

3.6.1

Release Date: 2025-03-14

Fixes

Plugins

• Limit Count Advanced
  • Fixed issue: Intermittently experiences 500 errors during load testing.
• OpenID Connect
  • Fixed issue: The plugin does not support configuring verify issuer.

3.6.0

Release Date: 2025-02-26

Breaking Changes

• Removed service runtime configurations in service templates, for better template reuse across gateway groups. Existing service runtime configurations within service templates will be removed, but your published service configurations will remain unchanged. Furthermore, the publishing process is simplified and streamlined, with no service runtime configurations allowed during the process. See the renewed guide to publish service.

Features

Data Plane

• Supported the configuration of upstream mTLS: see Configure mTLS between API7 Enterprise and Upstream for more details.

Console (Dashboard)

• Supported Logged in with Email: API7 Enterprise dashboard now supports login using either username or email address with password. To use email for login or to receive notifications, please bind an email address to your user profile.
• Supported configuring mTLS for upstreams.
• Supported referencing environment variables for SSO connection information.
• Introduced a form-based UI for plugin configuration.
• Added Basic Authentication as an authentication option for Developer Portal credentials. If the API product allows multiple authentication types, any valid credential can be used.

Fixes

Data Plane

• Fixed issue: Race condition problem while update upstream.nodes.#11916.
• Fixed service discovery issue: Upstream original_nodes is not updated when fill_node_info structure after cloning the nodes table.#10722.

3.5.5

Release Date: 2025-03-14

Fixes

Plugins

• Limit Count Advanced
  • Fixed issue: Intermittently experiences 500 errors during load testing.
• OpenID Connect
  • Fixed issue: The plugin does not support configuring verify issuer.
  • Fixed issue: Unable to validate audience claim.#11018

3.5.4

Release Date: 2025-03-07

Fixes

Plugins

• Elasticsearch Logger
  • Fixed issue: The plugin cannot configuring the index to dynamically send data based on the current date in the plugin.

Console (Dashboard)

• Fixed issue: Re-publishing with a template can lead to the loss of upstream configurations.
• Fixed issue: The OpenAPI cache on the page failed to invalidate after a service was rebuilt with ADC.
• Optimized slow queries.

3.5.3

Release Date: 2025-02-18

Fixes

• Fixed issue: Alert email subject cannot contain variables.

3.5.2

Release Date: 2025-02-18

Fixes

Data Plane

• Fixed issue: Failed to enable the Log Rotate plugin.
• Fixed issue: Duplicate data may occasionally occur in gateway instances during the upgrade process, specifically when using MySQL databases.
• Fixed issue: Deletion of custom plugins may occasionally fail.
• Fixed issue: When the data plane reports metrics, it may occasional encounter 500 errors.

Plugins

• Proxy Rewrite
  • Fixed issue: Version compatibility issue with the plugin.

Admin API

• List all stream routes in a published service on a gateway group
  • Fixed issue: Response error.

Console (Dashboard)

• Fixed issue: Upgrading the dashboard before the DP Manager during a version upgrade can cause the DP Manager to restart continuously.

3.5.1

Release Date: 2025-02-06

Fixes

Plugins

• OpenTelemetry
  • Fixed issue: Cannot reporting request.url as route.url when the plugin reports dynamic routes /v2/:customerNumber.

Console (Dashboard)

• Fixed issue: Failed to configure the Azure SMTP server to send alert emails.

3.5.0

Release Date: 2025-01-27

Features

Data Plane

• Multiple Upstreams in a Service: For advanced scenarios such as canary deployments, blue-green deployments, or managing multiple clusters, a service can now utilize multiple upstreams. In such cases, a default upstream serves as the primary target for most requests, while other upstreams can be used for specific purposes, such as routing traffic to a canary deployment or a secondary cluster. See the renewed Configure Canary Traffic Shifting for details.

info

The old Canary Rule function is no longer available.

• Supported custom configuration of DP metrics label through Prometheus plugin metadata.
• Optimized performance of data plane Prometheus metrics reporting.
• [Beta] Configured mTLS for upstream. API support is currently available. Full support is coming soon.

Plugins

• OpenID Connect
  • Added redirect_after_logout_uri for plugin that do not have an end_session_endpoint.#10653
• Zipkin
  • Added Zipkin variable.#10361
• Proxy Rewrite
  • Supported miltiple regex pattern matching.#9194
  • Supported variable when rewrite header.#9112
• GRPC web
  • Supported configuring allow-headers.#10904
• Mocking
  • Supported adding headers.#9720
• OPA
  • Supported sending headers upstream returned by OPA.#9710
• HTTP Logger
  • Supported compressed responses in loggers.#10884
• Kafka Logger
  • Supported compressed responses in loggers.#10884
• RocketMQ Logger
  • Supported compressed responses in loggers.#10884
• Traffic Split
  • Supported HTTPs.#9115

Admin APIs

• Added Multiple Upstreams related APIs:
  • Create a upstream in a published service on a gateway group.
  • Update a upstream in a published service on a gateway group.
  • Patch a upstream in a published service on a gateway group.
  • List all upstreams in a published service on a gateway group.
  • Get a upstream in a published service on a gateway group.
  • Delete a upstream in a published service on a gateway group.
• Updated Published Service APIs due to the new feature:Configured mTLS for upstreams:
  • Create a published service on a gateway group
    • Added properties: client_certificate, ca_certificate, tls_verify.
  • Create a upstream in a published service on a gateway group
    • Added properties: client_certificate, ca_certificate, tls_verify.
  • Update published service(without publishing)
    • Added properties: client_certificate, ca_certificate, tls_verify.
  • Update a upstream in a published service on a gateway group
    • Added properties: client_certificate, ca_certificate, tls_verify.

Console (Dashboard)

• Multiple Upstreams in a Service: For advanced scenarios such as canary deployments, blue-green deployments, or managing multiple clusters, a service can now utilize multiple upstreams. In such cases, a default upstream serves as the primary target for most requests, while other upstreams can be used for specific purposes, such as routing traffic to a canary deployment or a secondary cluster. See the renewed Configure Canary Traffic Shifting for details.
• Prohibited new resource creation due to exceeding the License CPU limit.
• Added page size selection for API7 Portal dashboard pages.
• Supported both YAML/JSON format for plugin configurations.
• Improved UI for upstream health check configuration.
• Renamed Enable/Disable Plugin to Add/Delete Plugin for improved accuracy.

Fixes

Plugins

• Traffic Split
  • Fixed issue: LRU Cache object creation function causes client request exceptions.
• Limit Conn
  • Fixed issue: Report error attribute does not exist because using HTTP variable in stream mode.#9816
• Prometheus
  • Fixed issue: Even after the Prometheus plugin is disabled, all features related to Prometheus are not entirely shut down..#11117
• OpenID Connect
  • Fixed issue: The redirect_uri was set to ngx.var.request_uri if not configured and caused the underlying lua-resty-openidc module to raise error.#7690
• Zipkin
  • Fixed issue: Getting a nil value in log phase.#10666
• Proxy Rewrite
  • Fixed issue: Incompatibility problems arise from not setting ngx.var.uri.#9309
• Log Rotate
  • Fixed issue: The use of string.byte is less efficient than string.sub.#9984

3.4.2

Release Date: 2025-02-18

Fixes

Admin APIs

• List all stream routes in a published service on a gateway group
  • Fixed issue: Response error.

Console (Dashboard)

• Fixed issue: Upgrading the dashboard before the DP Manager during a version upgrade can cause the DP Manager to restart continuously.

3.4.1

Release Date: 2025-01-14

Fixes

Data Plane

• Fixed issue: Configuring access_log_format in DP and setting access_log_format_escape to json, the result will append an extra request_id.

Console (Dashboard)

• Fixed issue: Pasting the password failed when using BasicAuth authentication for online debugging in API7 Portal.

3.4.0

Release Date: 2025-01-07

Features

Data Plane

• SNI Management: Introduced SNI as a new mechanism for managing TLS and mTLS authentication and certificate matching. See Configure mTLS between Client and API7 Gateway for details.

Plugins

• OpenID Connect
  • Added authorization parameters.#10058
  • Added more attributes.#10591
  • Added required scopes configuration property.#10493
  • Added session.cookie configuration.#10919
  • Supported setting headers in introspection request.#11090
• Fault Injection
  • Supported header injection.#9039.
• Skywalking Logger
  • Supported $hostname in skywalking service_instance_name.#9401
  • Add option to include request body and response body in logger plugins.#10888
• Forward Auth
  • Added exception configuration status_on_error.#10898
  • Supported degradation.#9435.
• Elastic Search Logger
  • Added compatibility headers.#10828
  • Added option to include request body and response body in logger plugins.#10888
• Prometheus
  • Supported custom configuration of DEFAULT_BUCKETS.#9673
• CORS
  • Supported for the Timing-Allow-Origin header.#9365
• File Logger:
  • Added schema attribute definition for logger plugins.#10738
• HTTP Logger:
  • Added schema attribute definition for logger plugins.#10738
• Syslog
  • Added option to include request body and response body in logger plugins.#10888
• SLS Logger
  • Added option to include request body and response body in logger plugins.#10888
• TCP Logger
  • Added option to include request body and response body in logger plugins.#10888
• UDP Logger
  • Added option to include request body and response body in logger plugins.#10888
• Tencent Cloud CLS
  • Added schema attribute definition for logger plugins.#10738
  • Added option to include request body and response body in logger plugins.#10888

Admin APIs

• Added SNI related APIs:
  • Create a SNI.
  • Update a SNI on a gateway group.
  • List all SNIs on a gateway group.
  • Get a SNI on a gateway group.
  • Delete a SNI on a gateway group.

Console (Dashboard)

• API7 Portal Monitoring: Provided monitoring data and visualizations to track API Product metrics.
• Applied custom plugin configuration at the gateway group level. See Add Custom Plugin for details.

Fixes

Data Plane

• Fixed issue: Shared memory leak used by Redis delayed synchronization function.
• Fixed issue: Warn log when sending requests to external services insecurely.#11403

Plugins

• AI Proxy
  • Fixed issue: Query parameters from override.endpoint are not sent to LLM.
• OpenID Connect
  • Fixed issue: Not closing session and blocking until TTL expired when using lockable session storage backend.#10788
• Forward Auth
  • Fixed issue: Request body is too large.#10589
  • Fixed issue: Plugin does not work if the request is POST and authentication service API is GET.#11021
• GRPC Web:
  • Fixed issue: Receiving an error missing trailers.#10851
• GRPC Transcode
  • Fixed issue: The position of enumerations in pb_option_def is wrong.#11448

Console (Dashboard)

• Fixed issue: Audit log failed to record when publishing multiple services.

Dependencies

• Data plane upgraded to LuaJit 2.1-20240815.
• Removed grpc-client-nginx-module.

3.3.4

Release Date: 2025-02-18

Fixes

Admin APIs

• List all stream routes in a published service on a gateway group
  • Fixed issue: Response error.

Console (Dashboard)

• Fixed issue: Upgrading the dashboard before the DP Manager during a version upgrade can cause the DP Manager to restart continuously.

3.3.3

Release Date: 2025-01-14

Fixes

Data Plane

• Fixed issue: Configuring access_log_format in DP and setting access_log_format_escape to json, the result will append an extra request_id.

Console (Dashboard)

• Fixed issue: Pasting the password failed when using BasicAuth authentication for online debugging in API7 Portal.

3.3.2

Release Date: 2024-12-24

Fixes

Console (Dashboard)

• Fixed issue: Dashboard failed to start when upgrading from 3.2.16.2 or older version to 3.3.1 and higher version.

3.3.1

Release Date: 2024-12-19

Fixes

Data Plane

• Fixed issue: Plugins running in the rewrite phase will be executed repeatedly after hitting a consumer.

3.3.0

Release Date: 2024-12-17

Features

Data Plane

• Refactored an expiration and elimination mechanism in the data plane.

Plugins

• OpenID Connect
  • Synchronized the latest APISIX code.
• Datadog
  • Reported consumer username tag.#11354
• Body Transformer
  • Supported content-type using x-www-form-urlencoded format and parsing uri parameters of get requests#10496
• OpenTelemetry
  • Added variables.#8871
• OpenID Connect
  • Added proxy_opts attribute.#9948

Console (Dashboard)

• Announced the General Availability (GA) of the API7 Portal, a comprehensive solution for API exposure and consumption. Explore the key concepts of the API Portal and Developers, and begin your journey towards productize services.
• Recorded request IDs in access logs and error logs.
• Added prompt in the alert history when an alert policy had not been configured with a notification channel.
• Supported integration with external Prometheus metrics.

Security

• Fixed the vulnerabilities from the CVE report.

Fixes

Data Plane

• Fixed issue: Data plane queries to the DPM for consumer errors, other than 404 errors, should not have been cached.

Plugins

• CORS
  • Fixed issue: The Access-Control-Expose-Headers response header will be overwritten.#11136.
• Body Transformer
  • Fixed issue: The input_format enumeration lacks a means to prevent body parsing and validation, leading to unnecessary warnings.#10862

Console (Dashboard)

• Fixed issue: After disabling the API7 integrated authentication, password login on the login page had been unavailable.
• Fixed issue: The plugin global rules search result is not accurate.

3.2.16.7

Release Date: 2024-12-13

Fixes

• Fixed issue: The DP Manager had entered an infinite loop when it received truncated Prometheus metrics.
• Fixed issue: Data plane synchronization with the control plane may have been disrupted due to an interrupted watch.
• Fixed issue: The Redis delayed synchronization function of the rate limiting plugin had not worked as expected for low-frequency requests.
• Fixed issue: The shared memory used by Limit Count Advanced plugin had been faulty.
• Fixed issue: radixtree_uri_with_parameter had been unable to match requests containing path parameters with special characters.
• Fixed issue: The remain value in Limit Count Advanced plugin sliding window should have been rounded down, and the reset value should have had two decimal places.

3.2.16.6

Release Date: 2024-11-25

Improvements

• The JWT Auth plugin supported key_claim_name.
• Added gateway group filtering to monitoring.

Fixes

• Fixed UI issues in alert pages.
• Fixed issue: Multiple data plane containers had been identified as a single instance in the control plane, which had impaired license control capabilities and some metric reporting display functions.
• Fixed issue: Audit logs failed to record when multiple services were published.
• Revised SSL certificate expiration alert condition text.
• Fixed issue: The health check had failed because the node IP address had not been updated.
• Added validation of the legitimacy of Lua code in plugins to the control plane codes.
• Added a record of error messages for sub-plugins to the Multi Auth plugin.
• Removed extra warning log in the Basic Auth plugin.
• Fixed the permission verification error of the secret providers when new credentials were added.
• Fixed issue: Added published service on gateway group had lacked the skip path prefix configuration item.

3.2.16.5

Release Date: 2024-11-21

Improvements

• Added multipart content type to body transformer.
• Adjusted resource ID length limit from 64 to 256.
• The workflow plugin has supported limit-count-advanced as an action.
• Refactored core.response.exit to clarify parameter definitions.
• Recorded the executed plugins in the request context to ensure that the same plugin had only been executed once when using the workflow plugin.

Fixes

• Fixed issue: Enabling the prefer_name option in the Prometheus plugin will cause the filters on the monitor page to malfunction.
• Fixed issue: When an anonymous consumer is matched, the x-consumer-custom-id header is not added to the request.
• Fixed issue: When configured together, the body transformer plugin and CORS plugin had caused errors with OPTIONS requests.
• Temporarily removed the sandbox mechanism in theexit transformer plugin.

3.2.16.4.1

Release Date: 2024-12-09

Fixes

• Fixed issue: The DP Manager had entered an infinite loop when it received truncated Prometheus metrics.
• Fixed issue: Data plane synchronization with the control plane may have been disrupted due to an interrupted watch.

3.2.16.4

Release Date: 2024-11-01

Features

Send Notification through Email

Alert policies can send notification through webhook and email at the same time by utilizing the new Contact Points. A Contact Point defines a set of email addresses or webhook URLs that can be used by multiple alert policies.

See Trigger Gateway Alerts for instruction.

note

Existing Webhook Templates will be migrated to new contact points and notifications, ensuring seamless transition and backward compatibility for alert policies.

Limit Count Advanced Plugin

Enhanced the open-source limit count plugin with a sliding window algorithm for more accurate rate limiting.

Exit Transformer Plugin

The exit-transformer plugin supports the customization of gateway responses based on the status codes, headers, and bodies returned from APISIX plugins. When configured as a global plugin, it also supports the response customization when a route that does not exist is requested.

Count Healthy Gateway Instances in a Gateway Group Through Alert Policy

If the number of healthy gateway instances in a gateway group falls below a critical threshold, it indicates potential service disruptions and impacts on traffic handling. This scenario is particularly relevant in Kubernetes deployments, where gateway instances may experience failures or be scaled down unexpectedly.

Create an alert policy for counting healthy gateway instances in a gateway group and send notifications to relevant personnel.

Utilized Expression Matching

Enable Expression Match in a route to match requests based on specific variables for greater precision, similar to nginx. Use expressions in the format [[var, operator, val], [var, operator, val], ...] to define matching criteria. Note that cookie name matching is case-sensitive.

See Expressions and lua-resty-expr for more details.

Security

• Added a status interface for self health checks on the data plane. For details, see enable data plane health check for high availability.

Improvements

• JWT Auth Plugin now supports more algorithm.
• Enriched more metrics in Grafana Dashboard Template.
• Allowed users to log in by pressing Enter.

Fixes

• Fixed issue: CORS Plugin expose_headers default value should not be *.
• Fixed issue: Successfully added first stream route when adding stream service.
• Fixed issue: max_req_body_bytes limit does not take effect in logger plugins.
• Fixed issue: Dynamic updates to rate limiting parameters in the Limit Count Plugin are now reflected in the data plane.
• Fixed issue: Services deleted via API are now consistently removed from the data plane.

3.2.16.3

Release Date: 2024-10-21

Features

Reference Secrets in AWS Secrets Manager

A secret object is a piece of sensitive information that needs to be protected from unauthorized access, while a secret provider object is used to set up integration with an external secret manager(HashiCorp Vault, AWS Secret Manager, etc.), so that API7 Gateway can establish connections and fetch secrets from the secret manager dynamically at runtime.

See Reference Secrets in AWS Secrets Manager for more details.

Anonymous Consumers for API authentication

An anonymous consumer does not need to authenticate, but can be restricted by rate limiting. You should configure anonymous consumers in authentication plugins on the service/route, then combined with rate limiting plugins.

For details, see the following documentation:

• Key Authentication
• Basic Authentication
• JWT Authentication
• HMAC Authentication
• Rate Limit with Anonymous Consumers

Security

• Added a status interface for self health checks on the data plane. For details, see enable data plane health check for high availability.

Improvements

• Supported for 2 million consumers.
• Sorted the consumer list by name.
• Removed conf_server from API7 gateway.
• Improved rate limiting related plugins to be more flexible, allowed for consumer-specific rate limits on a per-service/route basis. For details, see Limit Count Plugin and Limit Req Plugin.
• Advanced request & response transformation:
  • During request transformation, support passing Lua code to obtain values.
  • Aligned the capabilities of Kong's Request Transformation and Response Transformation.
• Displayed the total number of routes added in a service.
• Changed plugin list configuration from data plane to control plane. Not compatible with version under 3.2.15.0
• Added certificate expiration reminder in alert policies.
• Displayed a notification explaining the logout reason before redirecting to the login page due to multi-device login.
• Improved frontend page responsiveness and loading speed.
• Optimized the "Use Upstream Timeout" UI.
• Optimized API7 Portal(Beta) list page rendering speed.

Fixes

• Fixed issue: multiple paths can now be configured for a single route on the Dashboard.
• Fixed issue：the OpenTelemetry Plugin did not support set_ngx_var.
• Fixed issue: the ACL Plugin should not output warning logs during normal use.
• Enhanced data plane lua_ssl_trusted_certificate configuration item.
• Synchronized the Body Transformer Plugin code with the APISIX mainline version.
• Resolve issue: when a plugin that is not available to the stream module is configured on a service, the data plane prints error logs.
• Changed the Edit operation for Token to Edit Name.
• Resolve issue: when editing a service registry, the service discovery type does not match the form.

3.2.16.2

Release Date: 2024-10-11

Fixes

• Fixed the issue where plugin configuration updates in Consumer were not taking effect.

3.2.16.1

Release Date: 2024-10-04

Improvements

• Improved Developer Portal(Beta) performance.

Fixes

• Fixed panic issue in the radixtree_host_uri routing mode when deleting routes.
• Fixed incompatibility between custom authentication type plugins and the multi-auth plugin.

3.2.16.0

Release Date: 2024-09-30

Features

Reference Secrets in HashiCorp Vault

info

This is a breaking change. The secrets resource has been renamed to secret provider to align with best practices and facilitate integration with external secret management tools. All associated APIs have been updated accordingly.

A secret object is a piece of sensitive information that needs to be protected from unauthorized access, while a secret provider object is used to set up integration with an external secret manager(HashiCorp Vault, AWS Secret Manager, etc.), so that API7 Gateway can establish connections and fetch secrets from the secret manager dynamically at runtime.

See Reference Secrets in HashiCorp Vault for more details.

Improvements

• 【Breaking Change】Removed the JWT plugin's functionality for issuing tokens, and removed the ability to upload private keys. See JWT Plugin for details.
• Added support for deleting offline gateway instances.
• Added a sync_rate parameter to plugins that utilize Redis to control the frequency of counter synchronization with Redis. Real-time synchronization can put significant pressure on Redis.
• Supported accessing specific route detail pages via URL.
• Supported API online test for API7 Portal(Beta).
• UI Improvement: shorten the custom host input box.
• UI Improvement: change the load balancing algorithm dropdown to radio buttons.
• UI Improvement: new style for creating labels.

Fixes

• Fixed issue: the data plane failed to start due to an improperly cleaned config_listen.sock.
• Fixed issue: requests return a 404 error after disabling the service.
• Added keepalive_timeout configuration to splunk-hec-logging plugin.
• Removed whitespace before and after the delimiter after splitting consumer labels.
• Fixed issue: the Skywalking plugin cannot be restarted after being destroyed.
• Handled encryption and decryption correctly when non-authentication plugin configurations were applied to the consumer.
• Fixed issue: built-in permission policies should not be able to deleted.
• Fixed issue: ingress controller type gateway group should be able to delete.
• Fixed issue: data plane now supports / as a path prefix.
• Fixed UI issue: clicking on the label page jumps to the search bar.
• Fixed UI issue: after creating and deleting a token, the new token prompt does not disappear.
• Added Chinese translation for the plugin categories.
• Enlarged the plugin description text box to fully display the plugin's introduction.
• Fixed the issue where the new token prompt did not disappear after creating and deleting a token.

3.2.15.2.1

Release Date: 2024-12-09

Fixes

• Fixed issue: The DP Manager had entered an infinite loop when it received truncated Prometheus metrics.
• Fixed issue: Data plane synchronization with the control plane may have been disrupted due to an interrupted watch.

3.2.15.2

Release Date: 2024-09-19

Fixes

• Adjusted the attach-consumer-label plugin to execute in the before_proxy phase.

3.2.15.1

Release Date: 2024-09-18

Fixes

• Fixed issue: Using token to get instance_token returns 401.

3.2.15.0

Release Date: 2024-09-14

Features

Consumer Credentials

info

This is a breaking change. Creating new authentication plugins (key-auth, basic-auth, JWT-auth, or HMAC-auth) for consumers is no longer supported. Please use consumer credentials instead. Existing plugin configurations will remain accessible and editable until disabled.

Consumer credentials offer enhanced flexibility by allowing multiple credentials per consumer. They replace traditional authentication plugins like key-auth, basic-auth, JWT-auth, and HMAC-auth, providing a more user-friendly experience. See Manage Consumer Credentials for details.

Security

• The root user, admin, becomes a protected account that cannot be modified by roles, permission policies, or other users. It cannot be deleted or have its password reset by other users.

Improvements

• Sorted the service list alphabetically by name is now supported.
• Added gateway group ID to every audit log, so you can search or filter audit logs by gateway group.
• Recorded audit log for automatically deleted gateway instances that have been offline for more than 7 days.
• Supported filtering published services on a gateway group by label.
• Ensured control plane addresses do not end with a slash.
• Supported annotations in Helm.
• Provided configuration options to control the timeout for data plane heartbeat and telemetry requests, and adjust the default value to 30s.

Fixes

• Clarified the error message when a user logs in via SSO after SCIM is enabled, but the user does not exist in the system.
• Fixed the issue of failed canary configuration adjustments after modifying no version published service.

3.2.14.6

Release Date: 2024-08-28

Features

ARM Installation

Standardized ARM installation packages are available since version 3.2.14.6.

Security

• Fixed known CVE vulnerabilities.

Improvements

• Reduced installation image size through component optimization.
• Enabled mqtt-proxy plugin support for stream routes.
• Enhanced alert policy trigger conditions to include Allowed license CPU quota exceeded.

Fixes

• Wrote data plane certificate to a fixed local file.
• Fixed the issue of not being able to directly set the weight of the canary upstream to 100 when starting canary.
• Adjusted the order of custom plugins in the init_worker phase to avoid printing warning logs when the data plane restarts.
• Fixed UI display of blank route Methods when calling Admin API without methods.
• Fixed the issue where the route name length limit was 100 characters when synchronizing with ADC.
• Fixed the issue of alerts being sent even after the alert policy was disabled.

3.2.14.5.1

Release Date: 2024-12-09

Fixes

• Fixed issue: The DP Manager had entered an infinite loop when it received truncated Prometheus metrics.
• Fixed issue: Data plane synchronization with the control plane may have been disrupted due to an interrupted watch.

3.2.14.5

Release Date: 2024-08-20

Fixes

• Fixed a body validation bug in the response-rewrite plugin when body_base64 is set to false.

3.2.14.4.1

Release Date: 2024-12-09

Fixes

• Fixed issue: The DP Manager had entered an infinite loop when it received truncated Prometheus metrics.
• Fixed issue: Data plane synchronization with the control plane may have been disrupted due to an interrupted watch.

3.2.14.4

Release Date: 2024-08-14

Features

Override Upstream Timeout for Each Route

API7 Gateway offers granular control over request handling by enabling the configuration of distinct upstream timeouts for individual routes, to override the timeout configuration at the upstream side.

User Permission Boundary

Permissions boundaries define the maximum allowable permissions for a user, acting as a safeguard against excessive privilege escalation.

Security

• Upgraded frontend dependency.
• Ensured single device login - new login will revoke previous active sessions.
• Prohibited importing old license.
• Upgraded OpenResty version to fix security vulnerabilities.

Improvements

• Added service description in service hub list and published services list.
• Added "Connecting" status for service registry to avoid misunderstanding.
• Optimized custom plugin: Code Obfuscation and Encrypted Storage.
• Displayed a notification when using a test environment license.
• Implemented card-based UI for plugin management and modification.
• Supported configuration of custom plugin metadata.
• Minimized the image size of API7 Enterprise.

Fixes

• Fixed the issue of empty values for service runtime configuration parameters (e.g., host, path prefix) being lost when publishing a service version to a gateway group.
• Eliminated unnecessary audit log generation for dry-run license uploads.
• Fixed issue with incorrect route creation and modification timestamps.
• Fixed plugin metadata schema validation errors.
• Improved service search accuracy.
• Fixed issue with plugin loss during service template publishing.

3.2.14.3

Release Date: 2024-08-06

Fixes

• Supported referencing $env in SSL Certificates.
• Fixed UI instability when labels contained periods.
• Removed source code from frontend build artifacts.

3.2.14.2

Release Date: 2024-07-30

Fixes

• Fixed UI error for viewing Ingress Controller routes on the Dashboard.
• Fixed missing default Helm release name when installing gateway instance on Kubernetes.
• Enhanced Microsoft Entra ID (Azure AD) integration through ID token utilization.
• Fixed the issue that plugin inconsistencies may occur between service templates and published gateway groups.

3.2.14.1

Release Date: 2024-07-22

Improvements

Import OpenAPI to Create Service on Gateway Group

Simply import your OpenAPI specification directly into a gateway group to have your new service and all its routes ready.

Unveiling Granular Access Control with API7 Portal

Leverage custom roles and permission policies for granular control over access to API Products.

Security

• Control plane address must be HTTPs.
• Removed the use of ngx.req.get_post_args(0), use the default value instead to avoid potential attacks.
• Regenerate Ingress Controller deployment scripts now requires second confirmation.

Managing Published Service Basics without Versioning

Service name/description/labels now can be modified without publishing a new version.

First Route Creation During Service Setup

Allowing you to define the initial route right from the start. This eliminates the need for a separate step and simplifies your workflow.

Fixes

• Merged datadog plugin fix(https://github.com/apache/apisix/pull/11354) to API7 Enterprise.
• Fixed the issue of DP being invisible on the console.
• Fixed an issue: service registry status was always displayed as "disconnected" after changing the Prometheus data reporting method from remote-write to scrape.
• Fixed issue: Data plane encountered errors after deploying a custom plugin through the Dashboard.
• Fixed UI issue: you can not modify upstream of published service on a Ingress Controller gateway group.
• Wrong notification: When switching to Nodes, even if health checks are enabled, the prompt for users to enable health checks still exists.
• Fixed issue: When uploading a custom plugin, if there is a parsing error, the plugin name displayed in the error message does not match the actual file name.

3.2.14.0

Release Date: 2024-07-08

Features

Brand Access Control

info

This is a breaking change. Roles from older versions can not be kept.

API7 Enterprise moves beyond traditional role-based permissions, adopting a permission policy architecture for granular access control through reusable policies assigned to roles. See roles and permission policies

Improvements

Configure Priority for Routes

In specific scenarios, you can configure same routes within two different services. With priority determining which route handles the request. The route with a higher assigned priority will be used first.

Harden mTLS Certificate Security

Improved following issues:

• Overly Long Certificate: The certificate string is too long and should be shortened.
• Unnecessary Tokens: The certificate contains unnecessary tokens that should be removed.
• Shared CA: Using the same Certificate Authority (CA) for multiple certificates is insecure.
• Mismatched Certificate Handling: When a certificate mismatch occurs, the handshake should immediately fail, rejecting the client's request instead of proceeding with further validation.

Include Parameter lua_shared_dict in API7 Helm Chart

Introduced new parameter to Helm chart.

Fixes

• Upgrading from older version may cause missing upstream data or 404 errors.
• UI error encountered during service request URL update.
• Fixed Developer Portal library issue.
• Fixed HTTP logger plugin memory leak.
• Frontend and backend password policies are inconsistent.
• The data-mask plugin reports an error when the GET request does not match any route.
• The status field of the ApisixUpstream CRD is recorded incorrectly
• Data Plane supports configuring the reporting interval for monitoring data.
• Fixed warning logs after configuring plugin metadata.
• Fixed plugin reload issue.
• Reduced the number of PostgreSQL connections.
• Optimized frontend resource consumption.
• Removed trailing dot in FQDN.
• Plugin Metadata should be able to be deleted.

3.2.11.8

Release Date: 2024-06-26

Fixes

• Reduced API latency by minimizing etcd calls.
• Kine database connection pool configuration can function normally.

3.2.11.7

Release Date: 2024-06-24

Fixes

• Improve API performance.
• Data Plane supports disabling telemetry data collection and configuring reporting intervals.
• Custom plugins can function even without a schema definition.

3.2.11.6

Release Date: 2024-06-24

Fixes

• Large data sets no longer cause etcd range API error.

3.2.13.0

Release Date: 2024-06-19

Admin API Breaking Changes

1. The service template API has been migrated to the "/api/services/template" path prefix.

• Service template APIs
• Route template APIs

2. The original "/apisix/admin/services" endpoint now requires the gateway_group_id parameter.

• Service APIs on the gateway group
• Route APIs on the gateway group

Features

Create/Update Service on Gateway Group without Publishing

If version control is not your requirement, you can now directly create services on the gateway group. These services become active immediately, eliminating the need for a separate publishing step. This simplifies the deployment process and saves you time.

However, it is important to consider the trade-off involved. By bypassing the publishing stage, you also lose the ability to easily roll back to a previous version or track the version changes.

See the latest starter tutorial for details: Launch your first API.

Integrate with Ingress Controller(UI Support)

API7 Gateway officially introduces Ingress Controllers, a new type of gateway group. While the dashboard offers convenient management for creating and viewing your Ingress Controller, configuration modifications require to declarative way for any configuration changes.

Improvement

Search for Gateway Group Name and Filter by Labels

Makes it easier to find the specific gateway group you are looking for within the gateway group list.

Secure Sensitive Data in Configuration File

The database's DSN configuration (including access address, username, and password) can be configured through environment variables and Helm chart.

Support Prometheus Authentication

Prometheus remote write now supports Basic Auth/mTLS.

Support Secret Feature for SSL Variables

Secure ssl.certs and ssl.keys with encrypted secrets.

Fixes

• The ctx.var variable will be updated promptly after setting headers.
• Duplicate SSL certificates cannot be uploaded.

3.2.11.5

Release Date: 2024-06-18

Fixes

• The ssl_verify configuration now works fine for the Login Option OIDC and LDAP protocols.

3.2.11.4

Release Date: 2024-06-07

Fixes

• Protect sensitive fields within the login options related to API.

3.2.12.0

Release Date: 2024-05-24

Admin API Breaking Changes

1. The "service status" field has been changed from "0: enabled, 1: disabled" to "0: disabled, 1: enabled".

• Publish a service
• Update service runtime configurations by ID
• Get all published services in Gateway Group

2. The "ID" field has been removed from the consumer API. Queries and deletions are now performed using "gateway group ID" and "username".

• Consumers APIs

3. SSL-related APIs now require the "gateway group ID" parameter.

• SSL APIs

Features

Stream Route

API7 Gateway extends beyond API management. It can also handle Layer 4 (L4) traffic, like database or Kafka connections. Add a stream service and several stream routes to Proxy TCP Traffic.

Custom Role (UI Support)

Design your own custom roles with granular permission control. See Add Custom Role.

Ingress Controller (Beta, API Support Only)

Integrate with Ingress Controller.

Improvement

Optimize Left Navigation Menu

• Users will now see the gateway group menu as the primary landing page.
• Change the Service menu item to Service Hub.

Fixes

• Avoid duplicate API keys when using key-auth plugin.
• Enable allowlist and denylist at the same time in ua-restriction plugin.
• Reset the password without expiring the access token.
• Labels can be up to 64 characters long and include spaces.
• Validate the configuration of loggly plugin successfully.
• Force configuration synchronization to the data plane, even with schema validation errors. This prevents data loss and ensures uninterrupted workflow.
• The meaning of API7 Gateway service status is consistent with the corresponding field in Apache APISIX.

3.2.11.3

Release Date: 2024-05-20

Fixes

• etcd watch can pass SNI correctly.
• API7 Enterprise will attempt to create a database automatically. If permission issues arise, it will launch using a pre-configured database provided by the user, preventing installation failure.

3.2.11.2

Release Date: 2024-05-20

Fixes

• Labels can be up to 64 characters long and include spaces.
• Force configuration synchronization to the data plane, even with schema validation errors. This prevents data loss and ensures uninterrupted workflow.

3.2.11.1

Release Date: 2024-05-08

Features

SSO Role Mapping

This automated role mapping eliminates the need for manual role assignment by Super Admins. Users who satisfy the defined key-value mapping rules will be automatically assigned the corresponding roles upon login. For details, see Set Role Mapping.

SCIM Provisioning

Streamline your identity management with SCIM Provisioning. It automatically synchronizes user data from your Identity Provider, ensuring consistent and effortless user management. For details, see Sync User Data from IdP.

Custom Role (Beta, API Support Only)

Design your own custom roles with granular permission control. UI support coming soon.

Improvement

Upgrade to OpenSSL 3

Improved Security, Performance, and Availability.

Plugin Global Rules Ordering

To streamline the management of global rules, API7 Enterprise merges multiple rules into a single rule, ensuring that plugin configurations are unique within each rule.

Fixes

Settings Modal Add HTTP Protocol Detection

Not properly detecting whether HTTP or HTTPS is required, leading to errors when deploying gateway instances using the given script.

Error Uploading SSL Certificate

An issue exists where uploading an SSL certificate intended for gateway group A may inadvertently assign it to gateway group B.

Support Host Level Dynamic Setting of TLS Protocol Version

Incorporated the fix from the resolved Apache APISIX issue.

3.2.10.1

Release Date: 2024-04-28

Features

Support MySQL 5.7

API7 Enterprise now supports MySQL 5.7.

3.2.10.0

Release Date: 2024-04-22

Breaking Changes

Bind Token with User

Tokens are bound to specific users and share the same permissions. When the user is deleted, the associated token will also be deleted.

3.2.9.5

Release Date: 2024-04-16

Features

Upstream mTLS(API Support Only)

API7 Enterprise now supports mutual TLS (mTLS) authentication between the gateway and upstream services. mTLS is a form of communication security that requires both parties to present certificates to each other. This ensures that both parties are who they claim to be and that the data transmitted between them is encrypted. UI support coming soon.

3.2.9.4

Release Date: 2024-04-07

Fixes

Assessment of CPU Core Limitations

Fixed the issue that occurs when the maximum number of CPU cores is reached.

3.2.9.3

Release Date: 2024-04-03

Features

Integrate with Vault (Beta)

You can store sensitive data securely in your Vault. Admin API support is available; UI support coming soon.

3.2.9.2

Release Date: 2024-04-01

Features

Support SAML SSO Login

API7 Enterprise supports Single Sign-On (SSO) with SAML implementations. For details about how to configure SAML SSO login method, see configure SSO with SAML.

Plugin: Data Mask

The data-mask plugin provides the capability to remove or replace sensitive information in request headers, request bodies, and URL queries. Learn more about Data Mask.

Feature Enhancements

Skip Path Prefix

You can opt to skip the path prefix when sending requests to the upstream. This adjustment is imperceptible to users and may be useful when using different path prefixes to identify APIs sent to different gateway groups.

Better Health Check Configuration UI

Introduced a user-friendly and intuitive UI for your health check configuration in upstreams.

Upgraded Encryption Algorithm

Upgraded from AES128 to AES256 algorithm.

Performance Improvement

Eliminated the impact caused by disabling plugins.

3.2.9.1

Release Date: 2024-03-19

Features

Support Add Custom Plugin

API7 Enterprise now allows you to build custom plugins to add extra functionalities and manage API traffic with custom flow. See how to Add Custom Plugin

Support OIDC SSO Login

API7 Enterprise supports Single Sign-On (SSO) with OIDC implementations. For details about how to configure the LDAP SSO login method, see configure SSO with LDAP.

Use Service Labels as API Provider Scope

By assigning service labels as the scope for an API Provider, you can grant them access to all services with a specific label. It will help reduce the workload of the Super Admin. Typically, services can be grouped using a 'Department' label. Thus, users from that department will be able to access all services belonging to that department.

3.2.8.1

Release Date: 2024-02-08

Features

Support Nacos Service Discovery

API7 Enterprise uses service discovery to automatically detect available upstream services, keeping their addresses in a database (called a service registry). Therefore, an API gateway can always fetch the latest list of upstream addresses through the service registry, ensuring all requests are forwarded to healthy upstream nodes.

In this release, API7 Enterprise supports integrating with Nacos service discovery, which can be used to publish services and synchronize services between gateway groups.

Support LDAP SSO Login

API7 Enterprise supports Single Sign-On (SSO) with LDAP implementations. Integrating API7 Enterprise with LDAP enables you to log your LDAP users into API7 Enterprise as part of API7 Enterprise' SSO infrastructure. For details about how to configure the LDAP SSO login method, see configure SSO with LDAP.

Support Adding Gateway Instances using Kubernetes

A gateway instance is a single proxy that handles traffic. In this release, API7 Enterprise supports adding gateway instances to a gateway group using Kubernetes. For details, see add gateway instances.