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

PATCH 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

Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

Yes

 
{
  "resolved": true,
  "priority": 0
}
 
{
  "$ref": "DetectionUpdateRequestSchema",
  "resolved": {
    "type": "boolean"
  },
  "priority": {
    "type": "integer",
    "maximum": 3
  }
}

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

204

No content

No content


Response schema

{
  "$ref": "NoContent",
  "description": "No content",
  "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"
    }
  }
}

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