Full name: projects.locations.instances.rules.updateDeployment
Updates a RuleDeployment. Failures are not necessarily atomic. If there is a request to update multiple fields, and any update to a single field fails, an error will be returned, but other fields may remain successfully updated.
HTTP request
Path parameters
Parameters
ruleDeployment.name
string
Required. The resource name of the rule deployment. Note that RuleDeployment is a child of the overall Rule, not any individual revision, so the resource ID segment for the Rule resource must not reference a specific revision. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis webpage details the process for updating a \u003ccode\u003eRuleDeployment\u003c/code\u003e resource using the \u003ccode\u003eprojects.locations.instances.rules.updateDeployment\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses the \u003ccode\u003ePATCH\u003c/code\u003e method and requires a URL that includes the specific \u003ccode\u003eruleDeployment.name\u003c/code\u003e within the Chronicle API path.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a rule requires the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, a comma-separated string that determines which fields are being updated.\u003c/p\u003e\n"],["\u003cp\u003eThe request body and the response body both use the \u003ccode\u003eRuleDeployment\u003c/code\u003e object, which contains the new \u003ccode\u003eRuleDeployment\u003c/code\u003e data and updated properties.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a \u003ccode\u003eRuleDeployment\u003c/code\u003e necessitates the \u003ccode\u003echronicle.ruleDeployments.update\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: rules.updateDeployment\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.rules.updateDeployment\n\nUpdates a RuleDeployment. Failures are not necessarily atomic. If there is a request to update multiple fields, and any update to a single field fails, an error will be returned, but other fields may remain successfully updated.\n\n### HTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [RuleDeployment](/chronicle/docs/reference/rest/v1alpha/RuleDeployment).\n\n### Response body\n\nIf successful, the response body contains an instance of [RuleDeployment](/chronicle/docs/reference/rest/v1alpha/RuleDeployment).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `chronicle.ruleDeployments.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
