REST API integration configuration fields

  • Release version: Zurich
  • Updated July 31, 2025
  • 1 minute to read

    • Description of the fields on the REST API integration configuration forms for Health Log Analytics.

    For the REST API integration setup procedure, see Set up a REST API integration for Health Log Analytics.

    Note:
    REST API integrations support only UTF-8 encoding for incoming data.
    Table 1. Provide details tab
    Field Description
    Integration Name Unique name of this integration. For example: My REST API integration. This field is required.
    Note:
    When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you entered.
    MID web server The MID Web Server to use. This field is required.
    Service instance The service instance (formerly the application service) to which to bind the log data. This field is required.
    Note:
    If no relevant service instance exists, Create a service instance and add CIs (Configuration Items) to it. Set the status of the new service instance to Operational.
    Transport The protocol used for streaming log messages to your ServiceNow instance: REST. This field is read-only.
    Description Option to add a brief description of the integration to help identify it.
    MID server name The MID Server to which the log data is pushed.

    This field is auto-populated when the MID Web Server is chosen. It is read-only.
    Port The port for the MID Server.

    This field is read-only. It is auto-populated when the MID Web Server is chosen.