Get detection rule sets to policy mapping

Get a list of Endpoint Defense policies, the unique ID of the detection rule set currently assigned to the policy, and a list of all detection rule sets available to the policy.

Service endpoint

/opticsPolicies/v2/configurations

Optional query string parameters

—

Example

https://protectapi.cylance.com/opticsPolicies/v2/configurations

Method

HTTP/1.1 GET

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

Request

None

Response

Please see the Response status codes for more information.

Response JSON schema

Field Name Description

configuration_id

This is the unique ID for the detection rule set. Matching this number to the DETECTION number gives you the name of the detection rule set assigned to the policy.

DETECTION

This is the unique ID for the detection rule set assigned to the policy.

device_count

This is the number of devices assigned to the policy.

display_name

This is the detection rule set name.

page_number

This is the page number displayed.

page_size

This is the number of items to list per page.

policy_id

This is the unique ID for the policy.

total_number_of_items

This is the total number of policies in a tenant.

total_pages

This is the total number of pages, based on the page_size selected.

type

This is the configuration type. For detection rule sets, this is DETECTION.