---
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 MID Web Server API key authentication

# Configure MID Web Server API key authentication {#ariaid-title1}

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

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.

## Before you begin

Create a MID Web Server extension to use API Key authentication, as
described in [Configure the MID Web Server extension](https://servicenow-prod.fluidtopics.net/_6TI0U~gdVg0W_7HIWP7AA "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."). Ensure that you
select API Key in the extension's Authentication Type field.

Role required: event_mgmt_admin

## About this task

By default, the maximum number of API keys you can create on an instance is 10. To change this number, modify the mid.webserver.max.api.keys property value on the System Properties page.

When working in the global domain while Domain Separation is
enabled, API keys are available to all extensions, regardless of their domain. When
working in a specific domain, API keys are available to extensions in that domain,
its parent
domains,
and the global domain.

You can configure API keys to expire on a specified
date.

When creating a new extension with API key authentication (or updating
an existing one to use API key authentication), the system checks for an available
API key for the extension. If there is no available API key, the system creates
one.

## Procedure

1. Navigate to AllMID ServerProfiles and DeploymentsMID Web Server API Key.
2. Either create a new API key or modify an existing API key.  
   * To create a new API key:
     1. Select New.
     2. On the MID Web Server API Key form, fill in the fields.{#mid-web-server-api-key-authentication__table_bn5_25k_lrb__entry__2}

        | Field | Description |
        |-|-|
        | Name | Name for the API key. |
        | Active | Option for activating the API key. |
        | Authentication key | Read-only encoded value of the authentication key. No value appears until after you configure the key. |
        | Expires | Option for setting an expiration date for the API key. Expired, deactivated, or deleted API keys are not accepted by the web server extension. |
        [Table 1. MID Web Server API Key form]

        {#mid-web-server-api-key-authentication__table_bn5_25k_lrb}
     3. Select Submit to save the API key.

        The
        API key appears on the Mid Web Server API Keys
        page.
     {#mid-web-server-api-key-authentication__ol_otp_hrt_1sb}
   * To modify an existing API key:
     1. Navigate to MID ServerProfiles and DeploymentsMID Web Server API Key.
     2. Select an API key on the page.
     3. In the Related Links section, select View API Key.
     4. Copy the API key that appears in the MID Web Server dialog box.When connecting to a MID Web Server
        extension configured with API Key authentication, place an
        API key that the extension has access to in the
        Authorization header of the request in the following
        format:

        `Key <API_KEY>`
        where `<API_KEY>` is the value of the API key displayed after selecting View API Key.
     5. Select Submit.
     {#mid-web-server-api-key-authentication__ol_i25_tst_1sb}
   {#mid-web-server-api-key-authentication__ul_esg_grt_1sb}

*[\>]: and then