---
sourceDocument: Australia Operational Technology Management
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/operational-technology

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia Operational Technology Management

ft:clusterId :

    - optm

bundleId :

    - optm

workflow :

    - Technology


---

# Discovery Console for OT API

# Discovery Console for OT API {#ariaid-title1}

Release version: Australia  
Updated November 5, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of Discovery Console for OT API

The Discovery Console for OT API enables communication between the Service Graph Connector (SGC) for ServiceNow Operational Technology (OT) Discovery and the OT Discovery components.
This API facilitates data exchange between the Discovery Console for OT, other Discovery components, external APIs, and the ServiceNow instance, enabling efficient OT asset discovery and management.
Show full answer Show less  

## API Settings and Management

Within the Discovery Console's Settings page under the API tab, you can manage active tokens, denied tokens, and API endpoints essential for secure communication with the SGC. Tokens can be imported or exported, and endpoints can be downloaded to support integration and data exchange workflows.

## Key Features

* **User License Status:** Sends the current status of the user license through the API.
* **Software Inventory:** Imports software programs identified on devices and returns paginated lists with detailed attributes such as software name, version, vendor, and asset linkage.
* **Image and Screenshot Transfer:** Transfers images and screenshots from the Discovery Console to the ServiceNow instance with filtering options by attributes like creation date, size, and OCR data.
* **Sensor Data Integration:** Pushes Discovery Sensor for OT information, including sensor IDs and health metrics of sensors and collectors, to the ServiceNow instance for enhanced asset discovery and monitoring.
* **Health Metrics Monitoring:** Provides visibility into VM health, installed processes, and host metrics of sensors and collectors to ensure operational integrity.

## Support for Air-Gapped Networks

For environments without direct internet or network connectivity (air-gapped), the API supports offline data transfer using JSON export files. These files can be generated on the Discovery Console, manually moved via physical media (e.g., thumb drives) to the MID Server, and then imported through the Service Graph Connector to the ServiceNow instance. Scheduled exports allow automated generation of these files, enhancing data transfer in isolated environments.

## Practical Use for ServiceNow Customers

* Configure and manage API tokens and endpoints to establish secure, reliable communication between OT Discovery components and ServiceNow via the SGC.
* Leverage software inventory and sensor data APIs to enrich your CMDB with detailed OT asset and software information.
* Utilize image transfer capabilities for visual asset documentation within ServiceNow.
* Implement air-gap solutions using JSON exports to maintain discovery data synchronization in secure or isolated network environments.
* Monitor OT sensor and collector health metrics for proactive operational management.

## Next Steps

ServiceNow customers should review and edit API settings as needed to generate active tokens, manage denied tokens, and access API endpoints. Additionally, leverage scheduled exports for air-gapped environments to ensure continuous data flow to your ServiceNow instance.  
You can access the discovery data from the Console via the API. On the Settings page, select the API tab to view and use the active tokens, denied tokens, and endpoints needed to communicate with the
Service Graph Connector (SGC).  
Note:  
For more information, see [Service Graph Connector for ServiceNow Operational Technology (OT) Discovery](https://www.servicenow.com/docs/gNV0MxCpkiwLOrQ1UU12Ig "The Service Graph Connector for ServiceNow Operational Technology (OT) Discovery (SGC) imports data from a connected Operational Technology Discovery OT Discovery environment and leverages the Integration Hub ETL framework.").

## API settings {#api-discovery-console__section_lmd_31j_jgc}

The API settings are used to set up the active tokens, denied tokens, and endpoints needed to communications between the Service Graph Connector for ServiceNow OT Discovery and the Operational Technology Discovery components.

Tokens can be imported or exported, and endpoints can be downloaded.

The Service Graph Connector for ServiceNow OT Discovery enables the API to communicate data from the Discovery Console for OT and other Discovery components to the ServiceNow instance. Data can also be communicated to and from external APIs.

## Functionality {#api-discovery-console__section_xng_gfx_lgc}

The Service Graph Connector for ServiceNow OT Discovery has been enhanced for better connection to and from the Discovery components, the Discovery Console for OT API, and your ServiceNow instance.  
The Service Graph Connector for ServiceNow OT Discovery makes available for the Discovery Console for OT API functions such as:

* Sends the status of the user license.
* Imports all software programs that are identified on the devices and returns a paginated list from the SoftwaresAPI view.  
  The API ingests software and provides the following program attributes:
  * `inputProduct`: Software name
  * `Version`: Version of the installed software
  * `inputVendor`: Manufacturer of the software
  * `lastSeenOn`: Assets' LastSeenOn field added to the object
  * `assetId`: Derived from the _id for the asset document containing the software array.
  * `_id`: For the document; should be the _id for the object in the software array
  {#api-discovery-console__ul_ch3_chx_lgc}
* Transfers images and screen shots from the Console to the ServiceNow instance. This returns images in a paginated list with these filters:
  * `UpdateOn`
  * `CreatedOn`
  * `ScreenShot`
  * `Size`
  * `OCR Words`
  * `Titles`
  {#api-discovery-console__ul_aqy_bjx_lgc}
* Pushes Discovery Sensor for OT information to the ServiceNow instance.
  * The API can be used to return the `sensorId`.
  * You can gather information about the Sensor and use it to discover assets.
  * Sensor information can be pushed via the API to the ServiceNow instance.
  {#api-discovery-console__ul_ayd_p3x_lgc}
* Sends to the Console virtual machine (VM) health metrics and host metrics of the Sensor and the Collector. This helps with visibility of version, installed processes, and the health of the host machine for the Discovery Console for OT, the Discovery Sensor for OT, and the OT Discovery Collector.
{#api-discovery-console__ul_q35_kgx_lgc}

## Indirect network connection (air-gapped) {#api-discovery-console__section_xbv_ybt_pgc}

For security reasons, a computer or system may not be directly connected to the internet or may be on an unsecured LAN. In such a situation, the Operational Technology Discovery components can't push files or data to the MID Server and from there via the Service Graph Connector on to the ServiceNow instance.

To solve the air-gap issue, the Discovery Console for OT can generate JSON files. These JSON files are physical files and can be manually copied and then moved to the MID Server via an external drive. They can then be manually
copied to a specific directory on the MID Server and then consumed through the SGC to the ServiceNow instance.

For example, if you navigate to Settings \> Exports on the Discovery Console for OT, you can download data generated by the Discovery components as a JSON export file. You can schedule the frequency of these downloads setting the number of days and time of
day. These files are saved to the /opt/MSi/srv/apiexports directory. From there you can move them to physical media like a thumb drive. You can then copy or import the JSON files to the MID Server and
through Service Graph Connector for ServiceNow OT Discovery and then on to the ServiceNow instance.
* **[Edit API settings](https://www.servicenow.com/docs/qCGSLPI~pp7aZs8nhbyGlw)**   
  Edit the API settings for the Discovery Console for OT to generate active tokens, remove denied tokens, or view the available API endpoints needed to communicate with the Service Graph Connector for ServiceNow OT Discovery.

**Related concepts**   

* [Air-gapped networks and OT Discovery installation](https://www.servicenow.com/docs/nYlNklfzYytaTn1cENoj~g "This section explains the options for air-gapped and non-air-gapped network, installation of Discovery for OT components, and accessing data from scans and queries.")  
**Related tasks**   

* [Export data](https://www.servicenow.com/docs/~XjVqOymTF1iy17qifz6WA "The Discovery Console for OT exports data as a JSON export file.")
* [Edit API settings](https://www.servicenow.com/docs/qCGSLPI~pp7aZs8nhbyGlw "Edit the API settings for the Discovery Console for OT to generate active tokens, remove denied tokens, or view the available API endpoints needed to communicate with the Service Graph Connector for ServiceNow OT Discovery.")

