Method: curatedRuleSetDeployments.batchUpdate

Full name: projects.locations.instances.curatedRuleSetCategories.curatedRuleSets.curatedRuleSetDeployments.batchUpdate

Update multiple deployments of curated rule sets. - can be used as a wildcard value for {curatedRuleSetCategory} and {curatedRuleSet} to update deployments across different curated rule set categories/curated rule sets.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/curatedRuleSetDeployments:batchUpdate

Path parameters

Parameters
parent

string

Required. The parent resource shared by all deployments being updated. Formats: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/-/curatedRuleSets/- projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curatedRuleSetCategory}/curatedRuleSets/- projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curatedRuleSetCategory}/curatedRuleSets/{curatedRuleSet}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "requests": [
    {
      object (UpdateCuratedRuleSetDeploymentRequest)
    }
  ]
}
Fields
requests[]

object (UpdateCuratedRuleSetDeploymentRequest)

Required. The request message specifying the resources to update. A maximum of 1000 deployments can be modified in a batch.

Response body

Response message for BatchUpdateCuratedRuleSetDeployment.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "deployments": [
    {
      object (CuratedRuleSetDeployment)
    }
  ]
}
Fields
deployments[]

object (CuratedRuleSetDeployment)

The updated deployments.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.curatedRuleSetDeployments.batchUpdate

For more information, see the IAM documentation.

UpdateCuratedRuleSetDeploymentRequest

Request message for curatedRuleSetDeployments.patch.

JSON representation 
{
  "curatedRuleSetDeployment": {
    object (CuratedRuleSetDeployment)
  },
  "updateMask": string,
  "ruleSetDeploymentSyncDisabled": boolean
}
Fields
curatedRuleSetDeployment

object (CuratedRuleSetDeployment)

Required. The curated rule set deployment to update.

The deployments's name field is used to identify the deployment to update. Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{curatedRuleSetCategory}/curatedRuleSets/{curatedRuleSet}/curatedRuleSetDeployments/{curated_rule_set_precision}
updateMask

string (FieldMask format)

Optional. The list of fields to update. If no field mask or * is provided, all fields will be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
ruleSetDeploymentSyncDisabled

boolean

Optional. Controls the synchronization of live and alerting statuses between the Curated Rule Set and its individual rules when updating the rule set's deployment.

Default behavior (when false or unset): When you enable or disable the Curated Rule Set, this status is automatically applied to all individual rules within the set. For example: - Enabling the rule set: All its rules become active and will generate alerts if an alerting status is set. - Disabling the rule set: All its rules become inactive and stop generating alerts. Any prior individual on/off or alerting settings for rules in this set will be overridden by the set-level action.

Behavior when true: Enabling or disabling the Curated Rule Set will NOT change the current live or alerting status of the individual rules within it. This allows you to: - Keep a specific, useful rule running even if you disable the rest of the Curated Rule Set. - Disable a noisy rule without disabling the entire Curated Rule Set.