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

POST Get process hierarchy information

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

Query parameters

Name

Type

Description

$idType

string

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

$device

string

Device UUID

Request body

Type

Required

Example

Schema

application/json

Yes

 
{
  "ancestorDepth": 0,
  "childrenDepth": 0,
  "detectionsPerProcessLimit": 0,
  "processesPerLevelLimit": 0
}
 
{
  "$ref": "ProcessTreeRequestSchema",
  "ancestorDepth": {
    "type": "integer"
  },
  "childrenDepth": {
    "type": "integer"
  },
  "detectionsPerProcessLimit": {
    "type": "integer"
  },
  "processesPerLevelLimit": {
    "type": "integer"
  }
}

Parameters in path

Name

Type

Required

Description

process

string

Yes

ID or UUID of the process specific to EI

Responses

Code

Description and Example

Description, Schema and Headers

200

OK

OK


Response schema

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


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