Get detection rule set for a policy

Get the detection rule set assigned to a policy.

Service Endpoint

/opticsPolicies/v2/configurations/{policy_id}

Optional query string parameters

Example

https://protectapi.cylance.com/opticsPolicies/v2/configurations/d5c6d6a3-0599-4fb5-96bc-0fdc7eacb6ea

Method

HTTP/1.1 GET

Request headers

  • Accept: application/json
  • Authorization: Bearer JWT Token returned by Auth API with the opticspolicy:read 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.

policy_id

This is the unique ID for the policy.

type

This is the configuration type. For Detection Rule Sets, this is DETECTION.