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

GET Get the detection details

Relative path: /api/v1/detections/{alarm}

Query parameters

Name

Type

Description

$idType

string

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

Parameters in path

Name

Type

Required

Description

alarm

string

Yes

ID or UUID

Responses

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

Code

Description and Example

Description, Schema and Headers

200

OK


Response example

{
  "DETECTION": {
    "computerId": 0,
    "computerName": "string",
    "computerUuid": "string",
    "creationTime": "string",
    "event": "string",
    "handled": 0,
    "id": 0,
    "moduleFirstSeenLocally": "string",
    "moduleId": 0,
    "moduleUuid": "string",
    "moduleLastExecutedLocally": "string",
    "moduleLgAge": 0,
    "moduleLgPopularity": 0,
    "moduleLgReputation": 0,
    "moduleName": "string",
    "moduleSha1": "string",
    "moduleSignatureType": 0,
    "moduleSigner": "string",
    "priority": 0,
    "processCommandLine": "string",
    "processId": 0,
    "processPath": "string",
    "processUser": "string",
    "processUuid": "string",
    "resolved": true,
    "ruleName": "string",
    "ruleUuid": "string",
    "severity": 0,
    "severityScore": 0,
    "threatName": "string",
    "threatUri": "string",
    "type": null,
    "uuid": "string"
  }
}

OK


Response schema

{
  "$ref": "DetectionDetailsResponseSchema",
  "DETECTION": {
    "computerId": {
      "type": "integer"
    },
    "computerName": {
      "type": "string",
      "format": "hostname"
    },
    "computerUuid": {
      "type": "string",
      "format": "uuid"
    },
    "creationTime": {
      "type": "string",
      "format": "date-time"
    },
    "event": {
      "type": "string"
    },
    "handled": {
      "type": "integer",
      "enum": [
        0,
        1
      ]
    },
    "id": {
      "type": "integer"
    },
    "moduleFirstSeenLocally": {
      "type": "string",
      "format": "date-time"
    },
    "moduleId": {
      "type": "integer"
    },
    "moduleUuid": {
      "type": "string",
      "format": "uuid"
    },
    "moduleLastExecutedLocally": {
      "type": "string",
      "format": "date-time"
    },
    "moduleLgAge": {
      "type": "integer"
    },
    "moduleLgPopularity": {
      "type": "integer"
    },
    "moduleLgReputation": {
      "type": "integer",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ]
    },
    "moduleName": {
      "type": "string"
    },
    "moduleSha1": {
      "type": "string"
    },
    "moduleSignatureType": {
      "type": "integer"
    },
    "moduleSigner": {
      "type": "string"
    },
    "priority": {
      "type": "integer",
      "enum": [
        0,
        1,
        2,
        3
      ]
    },
    "processCommandLine": {
      "type": "string"
    },
    "processId": {
      "type": "integer"
    },
    "processPath": {
      "type": "string"
    },
    "processUser": {
      "type": "string"
    },
    "processUuid": {
      "type": "string",
      "format": "uuid"
    },
    "resolved": {
      "type": "boolean"
    },
    "ruleName": {
      "type": "string"
    },
    "ruleUuid": {
      "type": "string",
      "format": "uuid"
    },
    "severity": {
      "type": "integer"
    },
    "severityScore": {
      "type": "integer"
    },
    "threatName": {
      "type": "string"
    },
    "threatUri": {
      "type": "string",
      "format": "uri"
    },
    "type": {
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ]
    },
    "uuid": {
      "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"
  }
}