DeleteRule (V2) parity mapping

Supported in:

This guide details the request and response mapping specifications and property parity analysis for migrating from the legacy Backstory Rules Engine V2 API (DeleteRule) to the modern Chronicle API (DeleteRule).

Protocol and mapping overview

Feature Legacy API (DeleteRule V2) Modern Chronicle API (DeleteRule)
HTTP method DELETE DELETE
Permissions Partner token or legacy API keys chronicle.googleapis.com/rules.delete

Request payload field-by-field parity

The modern Chronicle API DeleteRuleRequest routes target paths using Google Cloud resource formats and introduces controls for cascading deletion.

Legacy field (DeleteRuleRequest) Modern field (DeleteRuleRequest) Field type Parity & migration notes
rule_id name (in HTTP path) string Google Cloud scoping / consolidated ID: Legacy passed the raw {rule_id} in the URL path. The modern API routes this using the standard Google Cloud resource path: projects/{project}/locations/{location}/instances/{instance}/rules/{rule_id} (deleting specific revisions is unsupported; target the root rule UUID).
— force bool New parameter: Cascade deletion toggle. If true, deletes all associated retrohunts and legacy alerts. If false, the request fails if there are existing retrohunt logs or alert records. Rename to force in JSON.

Response payload field-by-field parity

Both APIs return empty responses upon successful deletion.

Legacy field Modern field Field type Parity & migration notes
google.protobuf.Empty google.protobuf.Empty Empty Parity mapped: Successful requests return HTTP 200 OK (mapping to an empty response object {}).

Key differences

  • Google Cloud project scoping integration:
    • Scoped natively under parent project instance folder bindings (name path parameter).
  • Cascade safety checks (force):
    • Introduces a force boolean control parameter. Clients must explicitly verify if they want to cascade-delete associated retrohunts and historical alerts, preventing unintended loss of audit artifacts.
  • IAM permissions:
    • Request validation maps to standard Cloud IAM permission validation check (chronicle.googleapis.com/rules.delete).