Skip to main content
Version: v1.26.x LTS

WebSocket support in API Gateway

WebSocket support in API Gateway

The API Gateway includes a basic WebSocket proxy which enables the Gateway access to applications that use the WebSocket protocol together with a web UI and REST API.

The service can define what WebSocket services are exposed using Eureka metadata.


eureka:    instance:        metadata-map:            apiml:                routes:                    ws_v1:                        gatewayUrl: "ws/v1"                        serviceUrl: /discoverableclient/ws

These metadata make it possible for requests from wss://gatewayHost:port/ws/v1/serviceId/path to map to ws://serviceHost:port/discoverableclient/ws/path, where:

  • serviceId is the service ID of the service
  • path is the remaining path segment in the URL.

Security and Authentication#

The API Gateway is usually using TLS with the wss protocol. Services that use TLS enable the API Gateway to use wss to access these services. Services that do not use TLS require the API Gateway to use the ws protocol without TLS. The API Gateway also supports basic authentication via WebSocket.

High availability#

In the high availability scenario, the API Gateway makes it possible to open a new Websocket session by leveraging the load balancing mechanism. As such, even if an instance of the service which implements WebSocket is taken off, the communication between the client and the server can be handled by the API Gateway by propagating the session to the alive instance.


The list of active routed WebSocket sessions is available at the Actuator endpoint websockets. On localhost, it is available at https://localhost:10010/application/websockets.


Different HTTP status code errors may result. The WebSocket session starts before the session between the Gateway and the service starts. When a failure occurs when connecting to a service, the WebSocket session terminates with a WebSocket close code and a description of the failure rather than an HTTP error code.