EnableAlerting (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 (EnableAlerting) to the modern Chronicle API (UpdateRuleDeployment).

Protocol and mapping overview

Feature Legacy API (EnableAlerting V2) Modern Chronicle API (UpdateRuleDeployment)
HTTP method POST PATCH
Permissions Partner token or legacy API keys chronicle.googleapis.com/ruleDeployments.update

Request payload field-by-field parity

The legacy backstory API implemented enabling alerting as a dedicated POST RPC endpoint. The modern Chronicle API models alerting configuration as a PATCH modification of the alerting boolean attribute (setting to true) on the sub-resource RuleDeployment.

Legacy field (EnableAlertingRequest) Modern field (UpdateRuleDeploymentRequest / RuleDeployment) Field type Parity & migration notes
rule_id rule_deployment.name (in HTTP path) string Google Cloud scoping / resource unification: Legacy passed the raw rules engine parameter rule_id. The modern API routes this using parent resource paths: projects/{project}/locations/{location}/instances/{instance}/rules/{rule_id}/deployment.
— rule_deployment.alerting bool Target attribute mapping: Set alerting = true to elevate rule detections to alerting status.
— update_mask FieldMask Required mask: Include alerting in JSON updateMask.

Response payload field-by-field parity

In legacy backstory, EnableAlerting returned an empty response. In the modern API, UpdateRuleDeployment returns the modified deployment state.

Legacy field (Empty response) Modern field (RuleDeployment response) Field type Parity & migration notes
google.protobuf.Empty name string Canonical resource path name: projects/{project}/locations/{location}/instances/{instance}/rules/{rule_id}/deployment.
— alerting bool Returns true confirming alerting is enabled.
— enabled, archived, or run_frequency bool or enum Returns other deployment properties.

Key differences

  • Google Cloud project scoping integration:
    • Scoped natively under parent project instance folder bindings (rule_deployment.name path parameter).
  • Stateful attributes (alerting):
    • Rather than launching custom POST endpoints :enableAlerting, alerting configuration is parameterized by setting alerting = true inside the sub-resource RuleDeployment.
  • Execution dependency on archive states:
    • Alert status cannot be modified on archived rules; if archived = true, the update request fails.
  • IAM permissions:
    • Request validation maps to standard Cloud IAM permission validation check (chronicle.googleapis.com/ruleDeployments.update).