Get detection exceptions list

Retrieve a list of detection exception rules available in a tenant.

Service endpoint

/exceptions/v2

Optional query string parameters

—

Example

https://protectapi.cylance.com/exceptions/v2

Method

HTTP/1.1 GET

Request headers
  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the opticsexception:list scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name Description

page_size

This is the number of items on the page.

total_pages

This is the total number of pages of this size.

total_number_of_items

This is the total number of exceptions in the tenant.

page_number

This is the current page number of results.

page_items

This is a list of exception objects that are available in the tenant.

Id

This is the unique ID of the exception.

Name

This is the name of the exception.

Description

This is the description of the exception.

DeviceCount

This is the number of devices that have the exception applied.

LastModified

This is the timestamp (in UTC) of the last time that the exception was modified.

ModifiedBy

This is the last user to modify the exception.

  • id: This is the unique ID of the user who modified the exception.
  • login: This is the email address of the user who modified the exception.

OperatingSystem

These are the operating systems that the exception can be applied to. The "name" field can consist of:

  • "Windows"
  • "MacOS"

PolicyCount

This is the number of policies that have the exception applied.

RulesetCount

This is the number of detection rule sets that have the exception applied.

Version

This is the version of the exception.