ESET Inspect On-Prem – Table of Contents

Isolate the computer from the network

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

Relative path: /api/v1/machines/{machine}/isolate

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 { "taskUuid": "string" }	OK Response schema { "$ref": "IsolateResponseSchema", "taskUuid": { "type": "string", "format": "uuid" } } Headers { "X-Security-Token": { "$ref": "X-Security-Token", "description": "Authentication token", "schema": { "$ref": "AuthenticateTokenResponse", "type": "string", "example": "eyJhbGciOi[..]ziJSUGusY5kAI" } } }
401	Credentials or access token missing or invalid Response example { "error": "string" }	Credentials or access token missing or invalid Response schema { "$ref": "UnauthorizedError", "error": { "type": "string" } }
403	Insufficient permissions to perform action	Insufficient permissions to perform action Response schema { "$ref": "ForbiddenError", "description": "Insufficient permissions to perform action" }

Code

Description and Example

Description, Schema and Headers

200

Response example

{
  "taskUuid": "string"
}

Response schema

{
  "$ref": "IsolateResponseSchema",
  "taskUuid": {
    "type": "string",
    "format": "uuid"
  }
}

Headers

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

401

Credentials or access token missing or invalid

Response example

{
  "error": "string"
}

Credentials or access token missing or invalid

Response schema

{
  "$ref": "UnauthorizedError",
  "error": {
    "type": "string"
  }
}

403

Insufficient permissions to perform action

Response schema

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

˄˅