ESET Inspect On-Prem – Table of Contents

Get the exclusions associated with a rule

Copy current article URL Share via email

This article (PDF) Whole documentation (PDF)

Relative path: /api/v1/exclusions/rule/{rule}

Query parameters

Name	Type	Description
$idType	string	If $idType=uuid {id} in URL is interpreted as UUID

Parameters in path

Name	Type	Required	Description
rule	string	Yes	Rule 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 [ 0 ]	OK Response schema [ { "type": "integer" } ] 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" } }

Code

Description and Example

Description, Schema and Headers

200

Response example

[
  0
]

Response schema

[
  {
    "type": "integer"
  }
]

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

˄˅