Select the tab
ESET Inspect On-Prem – Table of Contents

GET Get a list of computers with ID, UUID and name

Relative path: /api/v1/computers

Query parameters

Name

Type

Description

$top

integer

System query option requests the number of items in the queried collection to be included in the result

$skip

integer

System query option requests the number of items in the queried collection that are to be skipped and not included in the result

$count

integer

System query option allows clients to request a count of the matching resources included with the resources in the response. If set to $count=1, the number of detections is returned

$orderBy

string

System query option allows clients to request resources in either ascending order using asc or descending order using desc. If not specified the order is in the ascending way in: query

$filter

string

System query option allows clients to filter a collection of resources that are addressed by the request URL. The query supports the following operators eq, ne, gt, ge, lt, le, and, or, and (). Operators can be combined with values to filter data. For instance, “resolved eq 0” will report only unresolved detections

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

OK


Response example

{
  "count": 0,
  "computers": [
    {
      "id": 0,
      "uuid": "string",
      "name": "string"
    }
  ]
}

OK


Response schema

{
  "$ref": "GetComputersResponseSchema",
  "count": {
    "type": "integer",
    "nullable": true
  },
  "computers": [
    {
      "id": {
        "type": "integer"
      },
      "uuid": {
        "type": "string",
        "format": "uuid"
      },
      "name": {
        "type": "string"
      }
    }
  ]
}


Headers

{
  "X-Security-Token": {
    "$ref": "X-Security-Token",
    "description": "Authentication token",
    "schema": {
      "$ref": "AuthenticateTokenResponse",
      "type": "string",
      "example": "eyJhbGciOi[..]ziJSUGusY5kAI"
    }
  }
}

400

Request is invalid

Request is invalid


Response schema

{
  "$ref": "BadRequestResponse",
  "description": "Request is invalid"
}

403

Insufficient permissions to perform action

Insufficient permissions to perform action


Response schema

{
  "$ref": "ForbiddenError",
  "description": "Insufficient permissions to perform action"
}