{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":30897,"path":"it-operations-management/health-log-analytics/il-connector-hla-rest-api.md","title":"Set up a REST API integration for Health Log Analytics","bundle":null,"doc_type":null,"release":"australia","body":"\n# Set up a REST API integration for Health Log Analytics\n\nSet up an integration for streaming log data to your ServiceNow instance for processing by Health Log Analytics.\n\n## Before you begin\n\n-   Verify that the Health Log Analytics application is installed and provisioned on your instance. For more information, see [Install Health Log Analytics \\(HLA\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/health-log-analytics/install-health-log-analytics.md).\n-   Verify that a service instance is available.\n-   Verify that the Health Log Analytics AI Engine is up and running.\n\n-   Verify that a MID Server is installed and configured with the Log Ingestion capability enabled. For more information, see [MID Server system requirements](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/r_MIDServerSystemRequirements.md).\n\n    \\[Omitted image \"hla-mid-log-ingestion.png\"\\] Alt text: MID Server configuration with Log Ingestion capability enabled.\n\n    **Important:** Health Log Analytics does not support IPv6. To work with the application, configure the MID Server to IPv4.\n\n    On the MID Web Server Context form, in the **Execute on** field, select Specific MID Server and not the cluster option. In the **MID Server** field, select the specific MID Server to which the log data is pulled.\n\n-   Unless the MID Server and external clients are on the same network, the MID Server must have a public IP address. This is required when its IP is exposed through network address translation \\(NAT\\), a load balancer, or a similar device. The public IP address enables external clients, such as Filebeat agents located outside its network, to reach the MID Server. Private IP addresses aren't routable over the internet. Without a public IP, external clients can't connect to the MID Server even if they are configured with its address. In the MID Server properties, add a property named **mid.public\\_ip** with the public IP address as the value. For more information, see [Create a MID Server property](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/r_MIDServerProperties.md). If the MID Server and external clients are on the same network, connections can be made using the private IP address.\n\n**Note:** REST API integrations support only UTF-8 encoding for incoming data.\n\nRole required: evt\\_mgmt\\_admin\n\n## About this task\n\nSet up an integration from the Integrations Launchpad in Service Operations Workspace, which you access from the ITOM AIOps configuration center. The AIOps configuration center is a centralized workspace for configuring and managing AIOps features from a single place. The integrations setup process reduces implementation time compared to manual data input setup in the classic interface in Health Log Analytics. For more information, see [Integrations Launchpad in Service Operations Workspace for ITOM](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/integrations-launchpad.md).\n\n## Procedure\n\n1.  Navigate to **Workspaces** > **Service Operations Workspace**.\n\n2.  From the navigation pane, select the AIOps configuration center icon \\[Omitted image \"icon-itom-aiops-config.png\"\\] Alt text: ITOM AIOps configuration center icon.\n\n    The ITOM AIOps configuration center page appears. The configuration center is a centralized workspace. Use it to configure and manage AIOps features from a single place.\n\n3.  From the Integrate section, under Integrations, select **Add integration**.\n\n    The Integrations Launchpad appears.\n\n4.  In the **Browse integrations** tab, enter `REST` in the search field.\n\n5.  Select the REST API integration tile.\n\n    **Note:** If you start an integration setup before meeting all prerequisites, a message appears. You can cancel the setup and complete the prior requirements first. Alternatively, you can continue in draft mode and complete the requirements later. Note that you can't activate the integration until you have completed all the prerequisites.\n\n6.  On the **Provide details** form, fill in the fields.\n\n    For a description of the fields, see [REST API integration configuration fields](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/health-log-analytics/il-connector-hla-restapi-fields.md).\n\n7.  Select **Next**.\n\n8.  In the **Set-up instruction** screen, copy the provided URL to the clipboard.\n\n    The format of the URL is: `http://(MID_SERVER_IP):(MID_WEB_SERVER_PORT)/ap1/mid/hla/raw`, where `/aps/mid/hla/raw` is the endpoint. HLA has replaced `(MID_SERVER_IP)` and `(MID_WEB_SERVER_PORT)` with the values you configured on the **Provide details** form.\n\n9.  Do one of the following.\n\n    -   If you completed all the prerequisites before starting the configuration, activate the integration either with or without AI-powered capabilities. Select the appropriate option.\n\n        -   **Activate with AI** enables AI-powered automatic parsing and mapping of log data to service instances and components for contextual alerts.\n\n            When the integration is activated successfully, the **Overview** tab is displayed. ServiceNow Otto for ITOM collects and analyzes log data. An AI icon indicates that AI is active.\n\n        -   **Activate** activates the integration without AI-powered mapping. The integration is activated and the **Overview** tab is displayed.\n        On the Integrations Launchpad, the integration tile is available in the **Installed integrations** tab.\n\n    -   If you didn't complete all the prior requirements, select **Save draft**.\n\n        The system saves the integration as a draft in the Integrations Launchpad **Installed integrations** tab, under **Waiting for your action**. At a later time, complete the prerequisites and activate the installation. For more information, see [Activate a draft integration in Health Log Analytics](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/health-log-analytics/il-connector-hla-activate-draft.md).\n\n\n## What to do next\n\nInstruct your API client to send log messages to the MID Server.\n\n1.  In the API client, configure a request with the following parameters:\n    -   HTTP Method: POST.\n    -   URL: The URL you copied in the **Set-up instruction** screen.\n    -   Authentication: The required authentication credentials. For example, Basic authentication \\(username and password\\).\n\n        **Note:** The authentication method must be the same as the method configured on the MID Web Server.\n\n    -   Headers: Set the `Content-Type` header to match your payload format.\n        -   For JSON: `application/json`.\n        -   For raw text: `text/plain`.\n    -   Body: The logs payload in JSON or raw text.\n2.  Send the request.\n\n    A successful response indicates that the MID Server has received the payload. When the MID Server has processed the log messages, the data input streams them to your ServiceNow instance using the REST protocol.\n\n\nIf you activated the integration with AI, verify that AI correctly auto-mapped log data to service instances and components. To do this, select **View mapping** under **Log context mapping**. You can override the AI mapping by selecting a different log field from each list. For more information, see [Map logs to service instances, components, source types](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/health-log-analytics/il-connector-hla-map-business-context.md).\n\n**Parent Topic:**[Set up Health Log Analytics on your ServiceNow instance](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/health-log-analytics/hla-implement.md)\n\n"}}