ESET PROTECT On-Prem

https://help.eset.com/protect_admin/13.1/en-US/
Admin
ESET PROTECT On-Prem is a security management console that enables administrators to centrally...
Tokens:185,101
Snippets:1,298
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Response Example

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_devices_deviceUuid-move_post.html

Example of a successful response. The response contains the moved device details.

```json
{
  "device": {
    "activeProducts": [
      {
        "activateDate": {
          "year": 0,
          "month": 0,
          "day": 0
        },
        "subscriptionUuid": "string",
        "unitPoolUuid": "string",
        "validityDate": {
          "year": 0,
          "month": 0,
          "day": 0
        },
        "id": 0,
        "name": "string"
      }
    ],
    "deployedComponents": [
      {
        "displayName": "string",
        "version": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        },
        "id": 0,
        "name": "string"
      }
    ],
    "description": "string",
    "deviceToken": "string",
    "deviceType": "DEVICE_TYPE_UNSPECIFIED",
    "displayName": "string",
    "enrollmentStatus": "DEVICE_ENROLLMENT_STATUS_UNSPECIFIED",
    "functionalityProblemCount": 0,
    "functionalityStatus": "DEVICE_FUNCTIONALITY_STATUS_UNSPECIFIED",
    "hardwareProfiles": [
      {
        "bios": {
          "manufacturer": "string",
          "serialNumber": "string",
          "uuid": "string"
        },
        "hardDrives": [
          {
            "capacityBytes": "string",
            "displayName": "string",
            "driveType": "DRIVE_TYPE_UNSPECIFIED",
            "hardwareEncryptionSupported": true,
            "malformedData": "string",
            "manufacturerName": "string",
            "serialNumber": "string"
          }
        ],
        "malformedData": "string",
        "manufacturer": "string",
        "model": "string",
        "networkAdapters": [
          {
            "caption": "string",
            "macAddress": "string",
            "malformedData": "string"
          }
        ],
        "processors": [
          {
            "architecture": "CPU_ARCHITECTURE_UNSPECIFIED",
            "caption": "string",
            "id": "string",
            "malformedData": "string",
            "manufacturer": "string"
          }
        ],
        "resettableIdentifier": "string",
        "salt": "string"
      }
    ],
    "isMaster": true,
    "isMobile": true,
    "isMuted": true,
    "lastSyncTime": "string",
    "managementDomain": "string",
    "cloningConfiguration": {
      "cloneNamingPatterns": [
        "string"
      ],
      "securityGroupUuid": "string",
      "securityGroupDisplayName": "string"
    },
    "operatingSystem": {
      "bitness": 0,
      "displayName": "string",
      "editionId": 0,
      "familyId": 0,
      "version": {
        "id": "string",
        "major": 0,
        "minor": 0,
        "name": "string",
        "patch": 0
      }
    },
    "originalDisplayName": "string",
    "parentGroupUuid": "string",
    "primaryLocalIpAddress": "string",
    "publicIpAddress": "string",
    "tags": [
      "string"
    ],
    "uuid": "string",
    "etag": "string",
    "ownerUuid": "string"
  }
}
```

--------------------------------

### GET /v1/devices:batchGet URL example

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_devices-batchGet_get.html

Example URL for the batchGet endpoint. It includes two devicesUuids query parameters. If the devicesUuids array is empty, INVALID_ARGUMENT is returned.

```http
https://10.1.180.105:9443/v1/devices:batchGet?devicesUuids=86726bff-cb30-45cf-a42a-fb51199e64a0 &devicesUuids=a26f7d4c-e689-47cb-939d-91b9c9664a57
```

--------------------------------

### URL example: https://10.1.180.105:9443/v2/policy-assignments

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v2_policy-assignments_get.html

Example URL for the GET request to list policy assignments. The host and port are placeholders; replace with your ESET PROTECT server address and port.

```http
https://10.1.180.105:9443/v2/policy-assignments
```

--------------------------------

### Response Example for 200 Success

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_device_groups_groupUuid_devices_get.html

Example of a successful response with a list of devices, next page token, and total size.

```json
{
  "devices": [
    {
      "displayName": "string",
      "groupUuid": "string",
      "uuid": "string"
    }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}
```

--------------------------------

### Pack and unpack Any in Java

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_device_tasks_taskUuid-updateTaskTargets_post.html

Shows how to pack a Foo message into an Any and unpack it back in Java using Any.pack and Any.unpack.

```java
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
```

--------------------------------

### 200 Response example for /v1/devices:batchGet

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_devices-batchGet_get.html

Example response body for a successful 200 response. It shows the structure of the returned device objects, including fields like activeProducts, hardwareProfiles, operatingSystem, and tags. All values are placeholders.

```json
{
  "devices": [
    {
      "activeProducts": [
        {
          "activateDate": {
            "year": 0,
            "month": 0,
            "day": 0
          },
          "subscriptionUuid": "string",
          "unitPoolUuid": "string",
          "validityDate": {
            "year": 0,
            "month": 0,
            "day": 0
          },
          "id": 0,
          "name": "string"
        }
      ],
      "deployedComponents": [
        {
          "displayName": "string",
          "version": {
            "id": "string",
            "major": 0,
            "minor": 0,
            "name": "string",
            "patch": 0
          },
          "id": 0,
          "name": "string"
        }
      ],
      "description": "string",
      "deviceToken": "string",
      "deviceType": "DEVICE_TYPE_UNSPECIFIED",
      "displayName": "string",
      "enrollmentStatus": "DEVICE_ENROLLMENT_STATUS_UNSPECIFIED",
      "functionalityProblemCount": 0,
      "functionalityStatus": "DEVICE_FUNCTIONALITY_STATUS_UNSPECIFIED",
      "hardwareProfiles": [
        {
          "bios": {
            "manufacturer": "string",
            "serialNumber": "string",
            "uuid": "string"
          },
          "hardDrives": [
            {
              "capacityBytes": "string",
              "displayName": "string",
              "driveType": "DRIVE_TYPE_UNSPECIFIED",
              "hardwareEncryptionSupported": true,
              "malformedData": "string",
              "manufacturerName": "string",
              "serialNumber": "string"
            }
          ],
          "malformedData": "string",
          "manufacturer": "string",
          "model": "string",
          "networkAdapters": [
            {
              "caption": "string",
              "macAddress": "string",
              "malformedData": "string"
            }
          ],
          "processors": [
            {
              "architecture": "CPU_ARCHITECTURE_UNSPECIFIED",
              "caption": "string",
              "id": "string",
              "malformedData": "string",
              "manufacturer": "string"
            }
          ],
          "resettableIdentifier": "string",
          "salt": "string"
        }
      ],
      "isMaster": true,
      "isMobile": true,
      "isMuted": true,
      "lastSyncTime": "string",
      "managementDomain": "string",
      "cloningConfiguration": {
        "cloneNamingPatterns": [
          "string"
        ],
        "securityGroupUuid": "string",
        "securityGroupDisplayName": "string"
      },
      "operatingSystem": {
        "bitness": 0,
        "displayName": "string",
        "editionId": 0,
        "familyId": 0,
        "version": {
          "id": "string",
          "major": 0,
          "minor": 0,
          "name": "string",
          "patch": 0
        }
      },
      "originalDisplayName": "string",
      "parentGroupUuid": "string",
      "primaryLocalIpAddress": "string",
      "publicIpAddress": "string",
      "tags": [
        "string"
      ],
      "uuid": "string",
      "etag": "string",
      "ownerUuid": "string"
    }
  ]
}
```

--------------------------------

### Response example for GET /v1/device_tasks/{taskUuid}

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_device_tasks_taskUuid_get.html

A successful response example showing the structure of the task entity, including action, targets, triggers, and timestamps. The response schema references v1GetTaskResponse and v1DeviceTask.

```json
{
  "task": {
    "action": {
      "name": "string",
      "params": {
        "@type": "string",
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    },
    "assetGroupUuid": "string",
    "description": "string",
    "displayName": "string",
    "source": "DEVICE_TASK_SOURCE_UNSPECIFIED",
    "targets": {
      "deviceGroupsUuids": [
        "string"
      ],
      "devicesUuids": [
        "string"
      ]
    },
    "triggers": [
      {
        "manual": {
          "createTime": "string",
          "expireTime": "string"
        }
      }
    ],
    "uuid": "string",
    "createTime": "string",
    "versionId": "string",
    "updateTime": "string"
  }
}
```

--------------------------------

### Pack and unpack Any in C++

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_device_tasks_taskUuid-updateTaskTargets_post.html

Shows how to pack a Foo message into an Any and unpack it back in C++ using PackFrom and UnpackTo.

```cpp
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) { ... }
```

--------------------------------

### FirewallAggregated_Event JSON log example

Source: https://help.eset.com/protect_admin/13.1/en-US/events-exported-to-json-format.html

Example JSON log for a FirewallAggregated_Event, showing the event structure with fields like event_type, hostname, source_address, target_address, and threat_name. The example includes a timestamp and process path with escaped backslashes.

```json
Jun 21 3: 54: 07 030—MG ERAServer[5648]: {  
"event_type": "FirewallAggregated_Event",  
"ipv4": "192.168.30.30",  
"hostname": "w16test",  
"group_name": "All/Lost & found",  
"os_name": "Microsoft Windows 11 Pro",  
"group_description": "Lost & found static group",  
"source_uuid": "d9477661-8fa4-4144-b8d4-e37b983bcd69",  
"occured": "21-Jun-2021 13:10:04",  
"severity": ""Warning",  
"event": "Security vulnerability exploitation attempt",  
"source_address": "127.0.0.1",  
"source_address_type": "IPv4",  
"source_port": 54568,  
"target_address": "127.0.0.1",  
"target_address_type": "IPv4",  
"target_port": 80,  
"protocol": "TCP",  
"account": "NT AUTHORITY\NETWORK SERVICE",  
"process_name": "C:\Program Files\Apache Software Foundation\apache-tomcat-9.0.41\bin\tomcat9.exe",  
"inbound": true,  
"threat_name": "CVE-2017-5638.Struts2",  
"aggregate_count": 1  
}  
```

--------------------------------

### Request Body Example

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_groups_groupUuid-rename_post.html

Example of the request body for renaming a group. The displayName field is required and must be a string.

```json
{
  "displayName": "string"
}
```

--------------------------------

### Create Policy Response Example

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v2_policies_post.html

Example of a successful response (HTTP 200) from the Create Policy endpoint. Shows the policy object with builtIn flag set to true.

```json
{
  "policy": {
    "builtIn": true,
    "readOnly": true
  },
  "additionalProp3": {
    "applyForcefully": true,
    "readOnly": true
  }
}
```

--------------------------------

### Windows: Replace proxy line with local URL in PROTECTAgentInstaller.bat

Source: https://help.eset.com/protect_admin/13.1/en-US/agent_live_installer.html

Replace the line that uses DownloadUsingHTTPProxy with a simple assignment of the local installer URL. The original line is shown first, followed by the replacement line. Use your own URL (local shared folder) but do not change %installDirectory%.

```batch
echo.packageLocation = DownloadUsingHTTPProxy^("!url!", "!http_proxy_hostname!", "!http_proxy_port!", "!http_proxy_username!", "!http_proxy_password!"^)
```

```batch
echo.packageLocation = "!url!"
```

--------------------------------

### URL Example for ListGroupMembers

Source: https://help.eset.com/protect_admin/13.1/en-US/api_v1_device_groups_groupUuid_devices_get.html

Example URL for the ListGroupMembers endpoint. Replace the groupUuid with the actual device group UUID.

```http
https://10.1.180.105:9443/v1/device_groups/b9f2f160-f3cf-48fc-8b81-2be092558c4a/devices
```
Tokens:
Raw