Skip Navigation
  1. BlackBerry Docs
  2. Cylance Endpoint Security
  3. Cylance User API guide
  4. CylanceOPTICS policy API
  5. Update a detection rule set in a policy

Update a detection rule set in a policy

Update the detection rule set assigned to a policy.
Service endpoint
/opticsPolicies/v2/configurations
Optional query string parameters
—
Example
https://protectapi.cylance.com/opticsPolicies/v2/configurations
Method
HTTP/1.1 POST
Request headers
  • Accept: application/json
  • Authorization: Bearer
    JWT Token returned by Auth API
     with the opticspolicy:create scope encoded

Request

{
    "configuration_type": "DETECTION",
    "configuration_id": "d23198bd-2725-4660-969c-971f1548ffc3",
    "link": [d5c6d6a3-0599-4fb5-96bc-0fdc7eacb6ea],
    "unlink": []
}

Response

Please see the Response status codes for more information.

Request JSON schema

Field Name
Description
configuration_id
This is the detection rule set unique identifier (ID). Use get all detection rule sets or get single detection rule set requests to get this ID.
configuration_type
This is the configuration type. For detection rule sets, this is DETECTION.
link
This adds the policy ID to assign the detection rule set to the policy.
unlink
This adds the policy ID to remove the detection rule set from the policy.

Response JSON schema

Field Name
Description
id
This is the policy ID.
message
This displays the assignment of the detection rule set to the policy.
  • link: This is the detection rule set is assigned to the policy.
  • unlink: This is the detection rule set was removed from the policy.
success
This displays if the update was successful or not.
  • false: The process of updating the detection rule set in the policy failed.
  • true: The process of updating the detection rule set in the policy succeeded.