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

GET Get basic process information

Relative path: /api/v2/processes/{process}

Query parameters

Name

Type

Description

$idType

string

If $idType=uuid {id} in URL is interpreted as UUID

$device

string

Device UUID

Parameters in path

Name

Type

Required

Description

process

string

Yes

ID or UUID of the process specific to EI

Responses

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

Code

Description and Example

Description, Schema and Headers

200

OK


Response example

{
  "id": 0,
  "systemProcessId": 0,
  "moduleId": 0,
  "moduleUuid": "string",
  "commandLine": "string",
  "user": "string",
  "uuid": "string"
}

OK


Response schema

{
  "$ref": "GetProcessResponseSchema",
  "id": {
    "type": "integer"
  },
  "systemProcessId": {
    "type": "integer"
  },
  "moduleId": {
    "type": "integer"
  },
  "moduleUuid": {
    "type": "string",
    "format": "uuid"
  },
  "commandLine": {
    "type": "string"
  },
  "user": {
    "type": "string"
  },
  "uuid": {
    "type": "string",
    "format": "uuid"
  }
}


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"
}

404

Specified element was not found

Specified element was not found


Response schema

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