api-management-self-hosted-gateway

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.7.0

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Our image tagging strategy

What is new?

Features

• Support for WebSocket APIs is now generally available (GA)
• Support for decryption keys to the validate-azure-ad-token policy

Fixes / Changes

• Fixed a bug where expressions did not work as expected for in the elements in the validate-jwt policy
• Fixed a bug where JSON payloads are malformed when log volume is high (https://github.com/Azure/api-management-self-hosted-gateway/issues/278)
• Improve Configuration API integration logging for improved support/troubleshooting:
  • Provide information about request path that failed
  • Provide RequestId in all logs that helps during support cases
• Fixed a bug where Configuration API integration will fail with 404 because of missing sanitizing of gateway.name setting (Entra ID authentication only)
• Fix for all CVEs
• Various improvements

Breaking Changes

• Automatic failover to Configuration API v1 is no longer supported given it is no longer supported since October 1st, 2023

Removal

None.

Chart: v1.11.0 | App: v2.7.0

What is new?

Features

• Use container image v2.7.0 (release notes)

Fixes / Changes

• Fix a bug where Helm installation namespace was not respected (https://github.com/Azure/api-management-self-hosted-gateway/pull/296 - Contributed by @midhun-mohan 🙏)

Breaking Changes

None.

Removal

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.10.0...v1.11.0

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.6.0

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Our image tagging strategy

What is new?

Features

• Support for gRPC APIs is now generally available (GA)
• Support for Load Balancer is now generally available (GA)
• Support for Circuit Breaker is now generally available (GA)
• Introduce Azure OpenAI Token Limit policy and is generally available (GA)
• Introduce Azure OpenAI Emit Token Metric policy and is generally available (GA)
• Introduce Azure OpenAI Semantic Caching policy in public preview
• Provide support for mounting authentication certificate through Azure Key Vault Secrets Store CSI Driver
• Provide insights on HTTP version used when calling backend in API Inspector

Fixes / Changes

• Improve logging related to local logging to better understand what is going on
• Reduce log volume by omitting LoggerCouldNotBeResolved events related to Azure Monitor which is not supported
• Fixed a bug where log lines were spread across multiple lines due to newline characters which causes log processors to fail (https://github.com/Azure/api-management-self-hosted-gateway/issues/190)
• Fixed a bug where local request logs were no longer showing when loading from snapshot and logging on API was removed
• Fixed a bug where cipher suite filtering was not honoured (https://github.com/Azure/api-management-self-hosted-gateway/issues/176)
• Fixed a bug where startup was blocked when authentication has expired, which prevented new replicas to no longer start up with local backup
• Fix for CVE-2024-21386 vulnerability in our image (Critical severity | details | https://github.com/Azure/api-management-self-hosted-gateway/issues/282)
• Fix for CVE-2023-6129 vulnerability in our base image (Medium severity | details)
• Fix for CVE-2024-0727 vulnerability in our base image (Medium severity | details)
• Fix for CVE-2024-29992 vulnerability in our image (Unknown severity | details)
• Fix for CVE-2024-27086 vulnerability in our base image (Low severity | details)
• Fix for CVE-2024-2511 vulnerability in our base image (Low severity | details)
• Fix for CVE-2023-6237 vulnerability in our base image (Low severity | details)
• Various improvements

Breaking Changes

None.

Removal

None.

Chart: v1.10.0 | App: v2.6.0

What is new?

Features

• Use container image v2.6.0 (release notes)
• Automatically configure socket volume when using syslog (https://github.com/Azure/api-management-self-hosted-gateway/pull/283)
• Introduce startup probe (https://github.com/Azure/api-management-self-hosted-gateway/pull/281 - Contributed by @RomanDvorsky 🙏 )
• Introduce capability to dynamically allocate new node ports for load balancer service (https://github.com/Azure/api-management-self-hosted-gateway/pull/280 - Contributed by @allevimi 🙏)

Fixes / Changes

• Use high-availability by default (https://github.com/Azure/api-management-self-hosted-gateway/pull/275)
• Fix a bug where assigning 0 replicas was not applied (https://github.com/Azure/api-management-self-hosted-gateway/pull/277 - Contributed by @RomanDvorsky 🙏)

Breaking Changes

None.

Removal

None.

New Contributors

• @allevimi

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.9.0...v1.10.0

Chart: v1.9.0 | App: v2.5.0

What is new?

Features

• Use container image v2.5.0 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.8.0...v1.9.0

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.5.0

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

• Support for x-forwarded-proto (opt-in, see setting reference)

Fixes / Changes

• Fix a bug where non-ASCII characters were not allowed in HTTP headers
• Fix for CVE-2023-46218 vulnerability in our base image (Medium severity | details)
• Fix for CVE-2023-46219 vulnerability in our base image (Medium severity | details)
• Fix for CVE-2023-5678 vulnerability in our base image (Medium severity | details)
• Various improvements

Breaking Changes

None.

Removal

None.

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.6

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

• Support for gRPC APIs (public preview | docs)
• Support for GraphQL Passthrough APIs (public preview)
• Support for Synthetic GraphQL APIs (public preview)
• Support for using Circuit Breaker on backends (public preview | docs)
• Support for quota policies
• Support for IngressClass for Kubernetes Ingress (experimental)
• Support for configuring DNS suffix for Kubernetes Ingress (experimental)
• Provide customer-friendly validation errors in validate-azure-ad-token
• Allow using 'Bearer' prefix when using custom header in validate-jwt/validate-azure-ad-token

Fixes / Changes

• Remove Server header in responses
• Improve container startup to show a link to available settings
• Fix a bug where local diagnostics on API-level are ignored
• Fix a bug in emit-metric where emitting metrics to Application Insights are dropped because one or more dimensions do not have a value
• Fix for CVE-2023-5363 vulnerability in our base image (Medium severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.8.0 | App: v2.4.0

What is new?

Features

• Use container image v2.4.0 (release notes)
• Provide support for enabling ingress controller (https://github.com/Azure/api-management-self-hosted-gateway/pull/245, experimental)
• Provide support for IngressClass resource (https://github.com/Azure/api-management-self-hosted-gateway/pull/245, experimental)
• Provide capability to configure DNS suffix for ingress controller (https://github.com/Azure/api-management-self-hosted-gateway/pull/258, experimental)

Fixes / Changes

• Provide capability to ignore replicaCount (https://github.com/Azure/api-management-self-hosted-gateway/pull/263 | Contributed by @RomanDvorsky 🎉)

Breaking Changes

• Remove support for creating Ingress resource 1
• Remove support for ingress class annotation, use IngressClass resource instead 1

Removal

None.

New Contributors

None.

1 We are making a breaking change in a minor version given this feature is in experimental support.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.6...v1.8.0

Chart: v1.7.6 | App: v2.3.6

What is new?

Features

• Use container image v2.3.6 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.5...v1.7.6

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.6

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix a bug where certificate revocation list (CRL) validation is on by default, which is a breaking change
  • Configuration security.certificate-revocation.validation.enabled allows customers to turn it on by default
  • There is a known issue where getting CRL through HTTP proxy with basic authentication is not working
• Fix for CVE-2023-36414 vulnerability in our image (High severity | details)
• Fix for CVE-2023-38545 vulnerability in our base image (High severity | details)
• Fix for CVE-2023-38546 vulnerability in our base image (Medium severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.7.5 | App: v2.3.5

What is new?

Features

• Use container image v2.3.5 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.4...v1.7.5

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.5

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix a bug where loading configuration from Configuration API times out without capability to increase timeout
  • Configuration config.service.integration.timeout allows defining timeout, for example 00:05:00 for 5 minutes
• Fix for CVE-2023-44487 vulnerability in our image (High severity | details | blog post)
• Fix for CVE-2023-38039 vulnerability in our base image (High severity | details)
• Fix for CVE-2023-44487 vulnerability in our base image (High severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.7.4 | App: v2.3.4

What is new?

Features

• Use container image v2.3.4 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.3...v1.7.4

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.4

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix for CVE-2023-36799 vulnerability in our image (Medium severity | details)
• Use Alpine 3.18

Breaking Changes

None.

Removal

None.

Chart: v1.7.3 | App: v2.3.3

What is new?

Features

• Use container image v2.3.3 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.1...v1.7.2

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.3

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix for CVE-2023-33170 vulnerability in our image (High severity | details)
• Fix for CVE-2023-35945 vulnerability in our image (High severity in base image | details)
• Fix for CVE-2023-3446 vulnerability in our image (Medium severity in base image | details)
• Fix for CVE-2023-3446 vulnerability in our image (Medium severity in base image | details)
• Fix for CVE-2023-3817 vulnerability in our image (Medium severity in base image | details)

Breaking Changes

None.

Removal

None.

Chart: v1.7.2 | App: v2.3.2

What is new?

Features

• Use container image v2.3.2 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.1...v1.7.2

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.2

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix for CVE-2023-1428 vulnerability in our image (High Severity | details)
• Fix for CVE-2023-32731 vulnerability in our image (High Severity | details)
• Fix for CVE-2022-26907 vulnerability in our image (High Severity | details)
• Fix for CVE-2023-32732 vulnerability in our image (Moderate Severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.7.1 | App: v2.3.1

What is new?

Features

• Use container image v2.3.1 (release notes)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.7.0...v1.7.1

Getting started

You can easily install the self-hosted gateway with Docker:

docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.3.1

Learn how you can install it on other container platforms:

• Deploy self-hosted gateway on Kubernetes with Helm
• Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
• Deploy self-hosted gateway on Kubernetes with YAML

Here are other relevant resources:

• Authenticate self-hosted gateway with Azure AD
• Self-hosted gateway on Microsoft Artifact Registry
• Migrate to self-hosted gateway v2
• Our image tagging strategy

What is new?

Features

None.

Fixes / Changes

• Fix for CVE-2023-29331 vulnerability in our base image (High Severity | .NET announcement | details)
• Fixed a bug where instance discovery through DNS was not consistent and use scheduled DNS synchronization instead
• Fixed a bug where logs were duplicated and caused unneeded log volume

Breaking Changes

None.

Removal

None.