API Client v1

MetaDefender OT Security Configuration

Create a MetaDefender OT Security User

MetaDefender OT Security will utilize multiple APIs to communicate with its products. Access to the API is validated via a combination of credentials (Token). This user requires a minimum access level; do not use a Super Administrator account.

Create a user from Enterprise -> User Management → User → Create User → {Create a user, ensure that you use the Role of API-Client }

Clicking on the Save button → Create user successfully → Copy this API-Client Token to be used for authentication

API

[Device] Get the server IP address

Title	[Device] Get the server IP address
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure/v1/managements/components
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Response

Response, 200 OK

JSON
    
xxxxxxxxxx
 
{    "error": false,    "errors": [],    "data": [        {            "siteIp": "10.40.172.144",            "sensorIps": [                "10.40.172.172"            ]        }    ]}
Copy

Response, 401 - Unauthorized

Javascript
    
xxxxxxxxxx
 
{    "error": true,    "errors": [        {            "code": "NEM-3003-000204",            "message": "Invalid authentication token"        }    ]}
Copy

2. [Device] Get device list

Title	[Device] Get device list
URL Path	https://{IP_Enterprise}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/device/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: Number of records “page”: The value should ALWAYS be 1. "sortBy": "discovTime" "sortType": "desc" Example:{"limit":20,"page":1,"sortBy":"discovTime","sortType":"desc"}
Response	Response, 200 OK Ex:

JSON
    
xxxxxxxxxx
 
{{...}
Copy

3. [Device] Get a device list by site id

Title	[Device] Get device list by site id
URL Path	https://{IP_Enterprise}:3003/neu-exposure/exposure/v1/devices/items?siteId=[2]&data={"isAll":false}
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteId: Type: `number[]` Description: The IP address of the site to fetch device data for. Example: `[1,2]` data: Type: `Object` Description: Pagination Info “limit”: Number of records “page”: The value should ALWAYS be 1. "sortBy": "discovTime" "sortType": "desc" Example: {"limit":20,"page":1,"sortBy":"discovTime","sortType":"desc"}
Response	Response, 200 OK Ex:

JSON
    
Copy

4. [Device] Get a device alert list

Title	[Device] Get a device alert list
URL Path	https://{IP_Enterprise}:3003/neu-exposure/exposure-external/alert-main/exposure/v1/sensor/device-alert/items?
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: {Number of records} “page”: The value should ALWAYS be 1. "sortBy":"alertStarted" "sortType": "desc" Example:{"limit":200,"page":1,"sortBy":"alertStarted","sortType":"desc"}
Response	Response, 200 OK Ex:

JSON
    
Copy

5. [Device] Get the connection alert list

Title	[Device] Get the connection alert list
URL Path	https://{IP_Enterprise}:3003/neu-exposure/exposure-external/alert-main/exposure/v1/sensor/conn-alert/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: {Number of records} “page”: The value should ALWAYS be 1. "sortBy":"alertStarted" "sortType": "desc" Example:{"limit":200,"page":1,"sortBy":"alertStarted","sortType":"desc"}
Response	Response, 200 OK Ex:

Javascript
    
Copy

6. [Device] Get the Suricata alert list

Title	[Device] Get the Suricata alert list
URL Path	https://{IP_Enterprise}:3003/neu-exposure/exposure-external/alert-main/exposure/v1/sensor/suricata-alert/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: {Number of records} “page”: The value should ALWAYS be 1. "sortBy":"alertStarted" "sortType": "desc" Example:{"limit":200,"page":1,"sortBy":"alertStarted","sortType":"desc"}
Response	Response, 200 OK Ex:

Javascript
    
Copy

7. [Device] Get CVE list

Title	[Device] Get the list of CVEs for the device
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-report/exposure/v1/sensor/device-cves/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: {Number of records} “page”: The value should ALWAYS be 1. "sortBy":"alertStarted" "sortType": "desc" Example:{"limit":250,"page":1,"sortBy":"name","sortType":"desc"}
Response	Response, 200 OK Ex:

Javascript
    
Copy

8. [Device] Get the list of CVEs for the device by site id

Title	[Device] Get the list of CVEs for the device by site id
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure/v1/devices/items?siteId=[2]&data={"isAll":false}
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` data: Type: `Object` Description: Pagination Info “limit”: {Number of records} “page”: The value should ALWAYS be 1. "sortBy":"alertStarted" "sortType": "desc" Example:{"limit":20,"page":1,"sortBy":"discovTime","sortType":"desc"}
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

9. [Components] Get component info

Title	[Components] Get the list of Site and Sensor infor
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure/v1/managements/components
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

10. [Components] Get sites address

Title	[Device] Get sites address
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure/v1/managements/sites
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

Title	[Device Firmware File] Get available version
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure/v1/device-firmware-files/check-available-version
Method	POST
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`

Request body:

Raw format:

Javascript
    
Copy

Response:

Response, 200 OK

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

2. [Device] Get the device ID for patching

Title	[Device] Get the device ID for patching
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/device/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	Get based on IPv4 or the MAC address of the Device siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “limit”: Number of records “page”: The value should ALWAYS be 1. "sortBy": "discovTime" "sortType": "desc" “properties“: {"ipv4":"", "mac":""} Example: {"limit":20,"page":1,"sortBy":"discovTime","sortType":"desc","properties":{"ipv4":"192.168.1.103","mac":"E0:DC:A0:C4:6A:42"}}
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

3. [Device] Get the list of CVEs for device

Title	[Device] Get the list of CVEs for the device
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/device/cves
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: Pagination Info “id”: the device ID “status”: /unpatched/patched/potential or ““ to get all Example: {"id":1, "status": ""}
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

4. [Request Patching] Get list

Title	[Request Patching] Get list
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"`
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

5. [Request Patching] Get detail

Title	[Request Patching] Get detail
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-report/exposure/v1/sensor/device-cves/items
Method	GET
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: “id”: the id of the request patching Example:{"id": 3}
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

6. [Request Patching] Create request

Title	[Request Patching] Create request
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/item
Method	POST
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"`

Request body

Raw format

Javascript
    
Copy

Response

Response, 200 OK

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

7. [Request Patching] Update request

Title	[Request Patching] Create request
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/item
Method	PUT
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch conn alert list data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"`

Request body

Raw format

Javascript
    
Copy

Response

Response, 200 OK

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

8. [Request Patching] Approve request

Title	[Request Patching] Approve request
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/approve
Method	PUT
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: “id”: the id of the request patching Example: `{"id": 6}`
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

9. [Request Patching] Reject request

Title	[Request Patching] Reject request
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/reject
Method	PUT
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: “id”: the id of the request patching Example: `{"id": 5}`
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

10. [Request Patching] Delete request

Title	[Request Patching] Delete request
URL Path	https://{IP of Enterprise Manager}:3003/neu-exposure/exposure-external/asset-main/exposure/v1/sensor/request-patching/item
Method	DELETE
Authentication method	Bearer Token
Request headers	Bearer Token: retrieved after creating API-Client user (mandatory) This API requires Bearer Token Authentication. You must include a valid Bearer token in the `Authorization` header. Format: `Authorization: Bearer <token>`
Params	siteIp: Type: `string` Description: The IP address of the site to fetch device data for. Example: `"10.40.172.144"` sensorIp: Type: `string` Description: The IP address of the sensor associated with the site. Example: `"10.40.172.172"` data: Type: `Object` Description: “id”: the id of the request patching Example: `{"id": 5}`
Response	Response, 200 OK Ex:

Javascript
    
Copy

Response, 401 - Unauthorized

Javascript
    
Copy

Javascript
    
Copy

Last updated on

Was this page helpful?