Configuring the WebSocket Listener

Edit online

About this task

The API Gateway WebSocket listener processes the requests from the clients. This procedure describes how to create the WebSocket listener to API Gateway.
Note: WebSocket Secure port is not supported.

To configure the WebSocket listener

Procedure

  1. Expand the menu options icon , in the title bar, and select Administration.
  2. Select Security > Ports.
    The ports page lists all the ports configured with API Gateway, if any.
  3. Click Add Ports.
  4. Select the type of port as WS and click Add.
  5. Provide the following information:
    Field Description
    Port Specify the number you want to use for the port.

    Select a number that is not already in use on this host machine.

    Alias Specifies an alias for the port.

    An alias must be between 1 and 255 characters in length and include one or more of the following: letters (a -z, A-Z), numbers (0-9), underscore (_), period (.), and hyphen (-).

    Description (optional) A description of the port.
    Bind address (optional) Specifies the IP address to which to bind this port.

    Specify a bind address if your machine has multiple IP addresses and you want the port to use this specific address. If you do not specify a bind address, API Gateway selects one for you.

    Backlog Specifies the number of requests that can remain in the queue for an enabled port before API Gateway begins rejecting requests.

    The default is 200. The maximum value is 65535.

    Keep alive timeout Specifies when to close the connection if the server has not received a request from the client within this timeout value (in milliseconds) or when to close the connection if the client has explicitly placed a close request with the server.
  6. Click Add.
    The port is created and is listed in the ports table.
    Important: The default access mode of the port is set to Allow by default. This implies that the port allows connection to all ESB services and folders. To avoid any potential security risk, you can set the access mode of the port to Deny by default before enabling it. For information on changing the access mode, see Configuring Access Mode for a Port.

    Also, the global IP access mode will be applied to the newly created WebSocket listener ports. You can modify the IP access mode as per your requirement. For information on modifying IP access mode of ports, see Configuring IP Access Mode for a Port.

  7. Click the icon in the Enabled column next to the port to enable the port.
    The port is enabled and a success message appears.