Event Management MID Web Server extension form

  • Release version: Australia
  • Updated March 12, 2026
  • 3 minutes to read

    • Fields in the form for creating or modifying a MID Web Server extension.

    Table 1. MID Web Server Context form
    Field Description
    Name Unique name for the extension for easy identification.
    Short description Brief, meaningful description of the extension.
    Status This field is auto-populated with the status of the extension. The field is blank until the extension is started. After issuing a command to the extension, one of the following values is displayed:
    • Started: The extension is running.
    • Stopped: The extension is not running.
    • Offline: The MID Server is down.
    • Error: The extension failed with an error. The error message is displayed in the Error Message field.
    • Warning: A run-time exception has occurred. The extension continues to work.
    HTTP/HTTPS Port Port number the extension listens on for incoming requests.
    Authentication Type The available authentication types are:
    • API Key (default): Any client connecting to the extension must enter an API key into the request's authorization header. For details on viewing existing API keys, see Configure MID Web Server API key authentication.
    • Keybased (deprecated and kept only for compatibility with releases prior to the Australia release): The value in the Secret Key field is used to generate an authentication token sent in the Authorization header of incoming client requests. For details, see Configure key-based MID Web Server authentication.
    • Basic: Define a username and password in the Basic Auth User and Basic Auth User Password fields, which appear when selecting this option.
    • mTLS: A certificate-based authentication that uses the TLS protocol. For details, see MID Web Server and agent mTLS Authentication.
    Secret Key The value generated when Keybased authentication is selected for the value in the Authentication Type field.
    Basic Auth User Username to be used when selecting Basic authentication.
    Basic Auth User Password Password to be used when selecting Basic authentication.
    Secure Connection Option to indicate that the extension is to use the TLS protocol to encrypt incoming connections. A certificate and private key combination must also be provided to the extension. When selecting this option, the MID Server Unified Keystore check box appears.
    Use MID Unified Keystore Option for using the MID Server Unified Keystore option for a secure connection.

    Clear this option to use Web Server Keystore.

    For details, see Configure a secure MID Web Server extension.
    Keystore Certificate Alias The alias name of the keypair inside the selected keystore that the extension uses to establish a secure connection.

    Leave this field empty to use the default alias when using the MID Unified Keystore or when using the Web Server Keystore with a single alias.
    Keystore Password The password for the Web Server Keystore when it is used to establish a secure connection.
    Keystore Key Password The password of the private key entry mapped to the specified alias of the Web Server Keystore. This field can be left empty if the password matches the entry in the Keystore Password field.
    Truststore Password The password to the truststore that holds the Certificate Authority (CA) certificates used to validate the signatures of the client certificates. Appears when the mTLS authentication type is selected.

    Leave this field empty if the extension is configured to use the cacerts truststore of the JRE running the MID Server.
    Error Message Message describing any error that causes a command, such as Start or Stop, to fail. This field appears only when the value in the Status field is Error.
    Execute on Location for running this extension. The available options are Specific MID Server or Specific MID Server Cluster.
    MID Server Depending on your selection in the Execute on field, the name of the designated MID Server or MID Server cluster.
    • If you selected Specific MID Server, the name of the designated MID Server.
    • If you selected Specific MID Server Cluster, the name of the designated MID Server cluster.
    Executing on Displays the name of the MID Server on which the extension is running even if the MID Server is down. If the user stops the extension, this field is empty.