ESET Inspect On-Prem – Table of Contents

Get a computer object with ID, UUID and name

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

Relative path: /api/v1/computers/{machine}

Query parameters

Name	Type	Description
$idType	string	If $idType=uuid {id} in URL is interpreted as UUID

Parameters in path

Name	Type	Required	Description
machine	string	Yes	Computer ID or UUID

Responses

Code	Description and Example	Description, Schema and Headers
200	OK Response example { "id": 0, "uuid": "string", "name": "string" }	OK Response schema { "$ref": "GetComputerResponseSchema", "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" } } }
404	Specified element was not found	Specified element was not found Response schema { "$ref": "NotFoundResponse", "description": "Specified element was not found" }

Code

Description and Example

Description, Schema and Headers

200

Response example

{
  "id": 0,
  "uuid": "string",
  "name": "string"
}

Response schema

{
  "$ref": "GetComputerResponseSchema",
  "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"
    }
  }
}

404

Specified element was not found

Response schema

{
  "$ref": "NotFoundResponse",
  "description": "Specified element was not found"
}

˄˅