Skip Navigation

Get detection rule set

Retrieve the content of a detection rule set, including detection rules, response actions, detection exceptions, package playbooks, and the policies where the detection rule set is applied.
Service endpoint
/rulesets/v2/{ruleset_id}
Optional query string parameters
Example
https://protectapi.cylance.com/rulesets/v2/c407f28a-3805-4014-b32c-0c2553ac1e17
Method
HTTP/1.1 GET
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
    with the opticsruleset:read scope encoded

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name
Description
name
This is the name of the detection rule set.
description
This is the description of the detection rule set.
notification_message
This is the message to display on the endpoint when a detection rule is triggered.
id
This is the unique ID of the detection rule set.
last_modified
This is the timestamp (in UTC) of the last time that the detection rule set was modified.
modified_by
This is an object detailing the last user to modify the detection rule. It includes the following fields:
  • id: This is the unique ID of the user who modified the detection rule.
  • login: This is the email address of the user who modified the detection rule.
rules
This is a list of detection rule objects and their associated response actions, detection exceptions, and package playbooks.
detection_rule_id
This is the unique ID of the detection rule.
detection_rule_version
This is the version of the detection rule.
detection_name
This is the name of the detection rule.
detection_description
This is the description of the detection rule set.
category
This is the category of the detection rule.
severity
This is the severity assigned to the detectionrule. Possible values are:
  • High
  • Medium
  • Low
  • Informational
operating_systems
This is an object detailing the operating systems to which the detection rule can be applied. It will include the "name" field. This can consist of:
  • "Windows"
  • "MacOS"
date_added
This is the timestamp (in UTC) when the detection rule was added to the tenant.
enabled
This determines whether or not a detection rule is enabled in the detection rule set. When viewing the content of a detection rule set, this should always be set to 'true'.
notification_enabled
This determines whether or not the message defined in the 'notification_message' field should display on the device when the detection rule is triggered.
To enable display desktop notification on device using the API, set notification_enabled and DisplayDesktopNotification to "true". To disable, set both to "false". The DisplayDesktopNotification setting enables or disables the feature. The notification_enabled setting affects the display desktop notification on device checkbox in the console as enabled (checked) or disabled (unchecked).
responses
This is a list of response objects for each response action enabled for a particular detection rule. each object will include the following fields:
  • template_id: This is the ID of the response template to use (this is provided by
    BlackBerry
    ).
  • response_rule_id: This is the ID of the response rule to enable (these are provided by
    BlackBerry
    ).
  • response_rule_version: This is the version of the response rule to enable (this is provided by
    BlackBerry
    ).
  • description: This is the description/name of the response rule.
  • value: This is a currently unused field.
  • enabled: This will always be 'true' when viewing a detection rule set.
  • created: This is the date that the response rule was added to the tenant.
exceptions
This is a list of exception rule objects that should be applied to the detection rule. Each object will include the following fields:
  • exception_id: This is the unique ID of the exception rule.
  • enabled: This will always be 'true' when viewing a detection rule set.
  • name: This is the name of the exception rule.
playbooks
This is a list of package playbook unique IDs that will be executed when the detection rule is triggered on the device.