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

PUT Edit the exclusion body

Relative path: /api/v2/exclusions/{exclusion}

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

 
{
  "body": "string",
  "autoResolve": true,
  "name": "string",
  "ruleIds": [
    0
  ],
  "ruleUuids": [
    "string"
  ],
  "note": "string"
}
 
{
  "$ref": "ExclusionCreateRequestSchema",
  "body": {
    "type": "string",
    "format": "xml"
  },
  "autoResolve": {
    "type": "boolean"
  },
  "name": {
    "type": "string"
  },
  "ruleIds": [
    {
      "type": "integer"
    }
  ],
  "ruleUuids": [
    {
      "type": "string",
      "format": "uuid"
    }
  ],
  "note": {
    "type": "string"
  }
}

Parameters in path

Name

Type

Required

Description

exclusion

string

Yes

Exclusion ID or UUID

Responses

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

Code

Description and Example

Description, Schema and Headers

200

Created


Response example

{
  "EXCLUSION": {
    "body": "string",
    "enabled": true,
    "id": 0,
    "name": "string",
    "note": "string",
    "ruleIds": [
      0
    ],
    "ruleUuids": [
      "string"
    ],
    "uuid": "string"
  }
}

Created


Response schema

{
  "$ref": "ExclusionDetailsResponseSchema",
  "EXCLUSION": {
    "body": {
      "type": "string",
      "format": "xml"
    },
    "enabled": {
      "type": "boolean"
    },
    "id": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "note": {
      "type": "string"
    },
    "ruleIds": [
      {
        "type": "integer"
      }
    ],
    "ruleUuids": [
      {
        "type": "string",
        "format": "uuid"
      }
    ],
    "uuid": {
      "type": "string",
      "format": "uuid"
    }
  }
}


Headers

{
  "Location": {
    "$ref": "Location",
    "description": "Location of resource",
    "schema": {
      "$ref": "LocationResponseSchema",
      "type": "string",
      "example": "https://lab-eei-01.lab.local:443/api/v1/exclusions/5",
      "format": "url"
    }
  },
  "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"
  }
}