---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Configure the websocket server on the MID Server

# Configure the websocket server on the MID Server {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 1 minute to read

Configure the websocket server on MID Servers to enable
connections from agents to the MID Server. You can configure only one
websocket server per MID Server.

## Before you begin

* Ensure that you download and install curl (or similar software) on your MID Server Windows machine.
* Role required: agent_client_collector_admin
{#acc-configure-web-server__ul_mrs_dbg_j1c}

## Procedure

1. Navigate to AllMID ServerServers.
2. Select the relevant MID Server name.
3. In the Related Links section, click Setup ACC Listener.  
   The Agent Client Collector Setup dialog box appears.  

   <br />

4. Enter the MID web server port (8800) in the displayed field.  
   Note:  
   You can change the default port, 8800, as needed.
   * To invoke secure TLS configuration, configure the following in the acc.yml file: `wss://<mid_ip>:<websocket_port>/ws/events`
   * To invoke TLS 1.3 support on the MID Web Server, set the following parameter in the `wrapper-override.conf` file on the MID Server: `-Djdk.tls.server.protocols="TLSv1.3"`
   * In a Linux environment, port numbers under 1024 can be used only with superuser privileges.
   {#acc-configure-web-server__ul_mbr_hk4_4xb}
5. Click OK.  
   A confirmation message with the URL for the agent configuration file appears.

   The web server and websocket extension are configured for the MID Server. To verify that the configuration is working, you must navigate to the following menu options:
   * Agent Client CollectorMID Web Server. When editing the fields on the resulting form, you must restart the MID web server extension to save your changes.
   * Agent Client CollectorWebsocket Endpoint
   {#acc-configure-web-server__ul_xgc_x5x_vjb}
6. Verify the validity of the websocket, using curl:
   1. Enter the following command into a cmd or terminal window: curl -Lk -H "Authorization: Key \<API_KEY\>" https://\<mid_server_address\>:\<port\>/api/mid/mon
   2. Verify that you receive a valid JSON response (and not an error message), such as the following:  
      Successful installation JSON message:  

          { 
                       "connectedAgentsNum" : 1
          }

   {#acc-configure-web-server__substeps_gfh_zrc_4nb}

*[\>]: and then