- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask
. Returns the updated alerting policy.
Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to alertPolicies.create, alertPolicies.delete and alertPolicies.patch.
HTTP request
PATCH https://monitoring.googleapis.com/v3/{alertPolicy.name}
Path parameters
| Parameters | |
|---|---|
alertPolicy.name
|
Identifier. Required if the policy exists. The resource name for this policy. The format is:
|
Query parameters
updateMask
string (
FieldMask
format)
Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy ( alertPolicy
), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.
Examples of valid field masks include displayName
, documentation
, documentation.content
, documentation.mime_type
, userLabels
, user_label.nameofkey
, enabled
, conditions
, combiner
, etc.
If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:
- The new policy will have the same
[ALERT_POLICY_ID]as the former policy. This gives you continuity with the former policy in your notifications and incidents. - Conditions in the new policy will keep their former
[CONDITION_ID]if the supplied condition includes thenamefield with that[CONDITION_ID]. If the supplied condition omits thenamefield, then a new[CONDITION_ID]is created.
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
Request body
The request body contains an instance of AlertPolicy
.
Response body
If successful, the response body contains an instance of AlertPolicy
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/monitoring
For more information, see the Authentication Overview .
