---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://www.servicenow.com/docs/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 MID Web Server extension

# Configure the MID Web Server extension {#ariaid-title1}

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

The MID Web Server is a MID Server extension that enables developing REST APIs to send events and metrics to the MID Server. The extension is leveraged by other MID Server extensions, such as Metric Intelligence, MID WebService Event Listener, and the Agent Client Collector websocket endpoint extension.{#configure-mid-web-server-extension__ph_MIDWebServerShortDesc}

## Before you begin

* Deploy and start a MID Server.{#configure-mid-web-server-extension__li_prerequisite1}
{#configure-mid-web-server-extension__li_prerequisite1}
* Enable the MID Web Server \[com.snc.sa.mid.webserver\] plugin. {#configure-mid-web-server-extension__ph_li-prerequisite2}

{#configure-mid-web-server-extension__ul_nkw_5rp_ky}

Role required:
agent_admin.

## About this task

Agent Client Collector supports the following authentication
strategies:

* Keybased: For backwards (pre-Yokohama release) compatibility only. See [Configure key-based MID Web Server authentication](https://www.servicenow.com/docs/pZUyTnNO1DjS4NgiTf1x6g "Provide added security to your MID Web Server extension by using key-based authentication. Generate an authentication token to be sent in the Authorization header of incoming client requests.").
* API key: See [Configure MID Web Server API key authentication](https://www.servicenow.com/docs/S7AyVLPFGsZ0MGuAzDaFSA "Authenticate incoming requests from clients to the MID Web Server extension using API key authentication. API authentication is a secure and simple way to authenticate your request. You can create or modify a MID Web Server API key.").
* mTLS: See [MID Web Server and agent mTLS Authentication](https://www.servicenow.com/docs/H5M4AD_YkGgzKe40o1Fb~w "Mutual authentication using the Transport Layer Security protocol (mTLS) is a secure, certificate-based authentication scheme. With mTLS, the server (the MID Web Server extension) and the client (the agent) authenticate each other.").
{#configure-mid-web-server-extension__ul_wxr_qfb_wrb}

## Procedure

1. Navigate to AllMID ServerExtensionsMID Web Server.
2. In the MID Web Server Contexts list, click New.
3. Fill in the values on the [Event Management MID Web Server extension form](https://www.servicenow.com/docs/vPJWZ3eOF92Zk98~95WdTg "Fields in the form for creating or modifying a MID Web Server extension.").
4. Click Save to save the data. {#configure-mid-web-server-extension__step_save}
{#configure-mid-web-server-extension__step_save}
5. Restart the MID Web Server extension to apply your changes.
6. Navigate to AllMID ServerExtensionsMID Web Server and select the MID Server you just created.
7. In the Related Links section, click Start to start the extension. {#configure-mid-web-server-extension__cmd_click-start}
{#configure-mid-web-server-extension__steps_nd5_flc_bx}
* **[Configure a secure MID Web Server extension](https://www.servicenow.com/docs/9eHGHat4fsNzozPSNpPKnw)**   
  Configure a TLS listener for extra security and encryption of data transferred to and from the MID Web Server extension. Access both a private key and a certificate (or certificate chain) from a Java keystore to use during the TLS handshake where the MID Web Server and the client acknowledge each other.
* **[Configure key-based MID Web Server authentication](https://www.servicenow.com/docs/pZUyTnNO1DjS4NgiTf1x6g)**   
  Provide added security to your MID Web Server extension by using key-based authentication. Generate an authentication token to be sent in the Authorization header of incoming client requests.
* **[Configure MID Web Server API key authentication](https://www.servicenow.com/docs/S7AyVLPFGsZ0MGuAzDaFSA)**   
  Authenticate incoming requests from clients to the MID Web Server extension using API key authentication. API authentication is a secure and simple way to authenticate your request. You can create or modify a MID Web Server API key.
* **[MID Web Server and agent mTLS Authentication](https://www.servicenow.com/docs/H5M4AD_YkGgzKe40o1Fb~w)**   
  Mutual authentication using the Transport Layer Security protocol (mTLS) is a secure, certificate-based authentication scheme. With mTLS, the server (the MID Web Server extension) and the client (the agent) authenticate each other.

*[\>]: and then