RuleService

BatchUpdateRules

Updates existing rules or creates rules that do not exist.

put/api/v1/rules:batchUpdate

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/rules:batchUpdate
  • Auth: HTTP bearer

Request body

validateOnlyboolean

If validate_only is true, the request will only validate the request and not save the rules.

overrideExpressionValidationboolean

Discouraged escape hatch for saving rules whose expression cannot be fully validated server-side. When true:

  • Per-asset expression validation errors (e.g. channel not present on the in-scope asset) are returned in validation_results for visibility but do not block the save.
  • If the rule's UDF/calculated-channel inlining cannot resolve types (typically because the referenced channels haven't been ingested yet, or there are too many distinct identifiers for the type-inference budget) the rule is still persisted, but its is_live_evaluation_enabled is forced to false. Live alerts will skip it; report generation and on-demand EvaluateRules calls still work because they re-resolve types at run time. To bring such a rule back online, fix the underlying problem (ingest the channels, simplify the expression, etc.) and reissue an update with is_live_evaluation_enabled = true.

Marked deprecated = true because new integrations should validate input before submitting; existing SDK call sites that rely on this flag continue to work.

Response

A successful response.

successboolean required

True if no rule has an error, or override_expression_validation is true. False if any rule has an error and that override is unset. When false and validate_only is false.

rulesCreatedCountinteger required

Number of request rules classified as creates (no matching rule_id or existing client_key). Includes rules that failed validation. If validate_only is true, nothing is written unless override_expression_validation is true.

rulesUpdatedCountinteger required

Number of request rules classified as updates (matched by rule_id or an existing client_key). Includes rules that failed validation. If validate_only is true, nothing is written unless override_expression_validation is true.

validateOnlyboolean required

True if the request only validated the rules and did not save them.

Changes

No recorded changes to this operation across all 1 revision of this API.