Configure a secure MID Web Server extension

task australia Updated Sep 10, 2026 2 min read configure-midwebserver-extension-secure.md

Configure a TLS listener for extra security and encryption of data transferred to and from the MID Web Server extension. Access a private key and certificate (or certificate chain) from a Java keystore. The keystore is used during the TLS handshake where the MID Web Server and the client acknowledge each other.

Before you begin

Role required: agent_client_collector_admin

Procedure

Navigate to MID Server > Extensions > MID Web Server.
Select New.
In the Authentication Type field, select an authentication type to be used.
- Keybased – See Configure key-based MID Web Server authentication
- Basic – Standard username/password authentication
- API key – See Configure MID Web Server API key authentication
- mTLS – See MID Web Server and agent mTLS Authentication
Select either the MID unified keystore or the web server keystore.

The MID Web Server unified keystore is the most efficient option. To enable backward compatibility and store keypairs in an additional keystore, use the Web server keystore. The Web server keystore allows you to use the MID unified keystore as well.

Option	Description
MID unified keystore	Select the Use MID Unified Keystore check box Enter an alias name in the Keystore Certificate Alias field or leave the field empty to use the keystore's default alias. For more information, see the Install custom certificates in the MID Server unified key store section in MID Server unified key store. Important: Leaving the Keystore Certificate Alias field empty causes connecting clients to skip certificate verification. Instead, the MID Server uses its own self-signed certificate.
Web server keystore	Clear the Use MID Unified Keystore check box. Specify an alias name in the Keystore Certificate Alias field or leave the field empty if you have a single alias in that keystore. If the password to the private key of the required alias is different from the keystore password, specify the alias in the Keystore Key Password field. Enter the keystore password in the Keystore Password field.

Option

Description

MID unified keystore

Select the Use MID Unified Keystore check box
Enter an alias name in the Keystore Certificate Alias field or leave the field empty to use the keystore's default alias.

For more information, see the Install custom certificates in the MID Server unified key store section in MID Server unified key store.

Important: Leaving the Keystore Certificate Alias field empty causes connecting clients to skip certificate verification. Instead, the MID Server uses its own self-signed certificate.

Web server keystore

Clear the Use MID Unified Keystore check box.
Specify an alias name in the Keystore Certificate Alias field or leave the field empty if you have a single alias in that keystore.
If the password to the private key of the required alias is different from the keystore password, specify the alias in the Keystore Key Password field.
Enter the keystore password in the Keystore Password field.

79 lines · 4.1 KB Wrap lines

---
title: Configure a secure MID Web Server extension
description: Configure a TLS listener for extra security and encryption of data transferred to and from the MID Web Server extension. Access a private key and certificate \(or certificate chain\) from a Java keystore. The keystore is used during the TLS handshake where the MID Web Server and the client acknowledge each other.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/it-operations-management/event-management/configure-midwebserver-extension-secure.html
release: australia
product: Event Management
classification: event-management
topic_type: task
last_updated: "2026-09-10"
reading_time_minutes: 2
breadcrumb: [Configure the MID Web Server extension, MID Web Server, Event Management setup, Configure, Event Management, ITOM AIOps, IT Operations Management]
---

# Configure a secure MID Web Server extension

Configure a TLS listener for extra security and encryption of data transferred to and from the MID Web Server extension. Access a private key and certificate \(or certificate chain\) from a Java keystore. The keystore is used during the TLS handshake where the MID Web Server and the client acknowledge each other.

## Before you begin

Role required: agent\_client\_collector\_admin

## Procedure

1.  Navigate to **MID Server** &gt; **Extensions** &gt; **MID Web Server**.

2.  Select **New**.

3.  In the **Authentication Type** field, select an authentication type to be used.

    -   Keybased – See [Configure key-based MID Web Server authentication](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/event-management/configure-mid-web-server-extension-metric-data.md)
    -   Basic – Standard username/password authentication
    -   API key – See [Configure MID Web Server API key authentication](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/event-management/mid-web-server-api-key-authentication.md)
    -   mTLS – See [MID Web Server and agent mTLS Authentication](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/event-management/mid-web-server-mTLS-authentication.md)
4.  Select either the MID unified keystore or the web server keystore.

    The MID Web Server unified keystore is the most efficient option. To enable backward compatibility and store keypairs in an additional keystore, use the Web server keystore. The Web server keystore allows you to use the MID unified keystore as well.

<table id="choicetable_ezm_tvg_dsb"><thead><tr><th align="left" id="d84055e157">

Option

</th><th align="left" id="d84055e160">

Description

</th></tr></thead><tbody><tr><td id="d84055e166">

**MID unified keystore**

</td><td>

1.  Select the **Use MID Unified Keystore** check box
2.  Enter an alias name in the **Keystore Certificate Alias** field or leave the field empty to use the keystore's default alias.

For more information, see the **Install custom certificates in the MID Server unified key store** section in [MID Server unified key store](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/mid-unified-keystore.md).

**Important:** Leaving the **Keystore Certificate Alias** field empty causes connecting clients to skip certificate verification. Instead, the MID Server uses its own self-signed certificate.

</td></tr><tr><td id="d84055e209">

**Web server keystore**

</td><td>

1.  Clear the **Use MID Unified Keystore** check box.
2.  Specify an alias name in the **Keystore Certificate Alias** field or leave the field empty if you have a single alias in that keystore.
3.  If the password to the private key of the required alias is different from the keystore password, specify the alias in the **Keystore Key Password** field.
4.  Enter the keystore password in the **Keystore Password** field.


</td></tr></tbody>
</table>
**Related topics**  


[Connect the agent to the MID Server using mTLS](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/event-management/enable-tls-agent.md)