REST Resource: projects.snoozes

Resource: Snooze

ASnooze will prevent any alerts from being opened, and close any that are already open. TheSnooze will work on alerts that match the criteria defined in theSnooze. TheSnooze will be active frominterval.start_time throughinterval.end_time.

JSON representation
{"name":string,"criteria":{object (Criteria)},"interval":{object (TimeInterval)},"displayName":string}
Fields
name

string

Required. Identifier. The name of theSnooze. The format is:

projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

The ID of theSnooze will be generated by the system.

criteria

object (Criteria)

Required. This defines the criteria for applying theSnooze. SeeCriteria for more information.

interval

object (TimeInterval)

Required. TheSnooze will be active frominterval.start_time throughinterval.end_time.interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.

displayName

string

Required. A display name for theSnooze. This can be, at most, 512 unicode characters.

Criteria

Criteria specific to theAlertPolicys that thisSnooze applies to. TheSnooze will suppress alerts that come from one of theAlertPolicys whose names are supplied.

JSON representation
{"policies":[string],"filter":string}
Fields
policies[]

string

The specificAlertPolicy names for the alert that should be snoozed. The format is:

projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]

There is a limit of 16 policies per snooze. This limit is checked during snooze creation. Exactly 1 alert policy is required iffilter is specified at the same time.

filter

string

Optional. When you define a snooze, you can also define a filter for that snooze. The filter is a string containing one or more key-value pairs. The string uses the standardhttps://google.aip.dev/160 filter syntax. If you define a filter for a snooze, then the snooze can only apply to one alert policy. When the snooze is active, incidents won't be created when the incident would have key-value pairs (labels) that match those specified by the filter in the snooze.

Snooze filters support resource, metric, and metadata labels. If multiple labels are used, then they must be connected with an AND operator. For example, the following filter applies the snooze to incidents that have a resource label with an instance ID of1234567890, a metric label with an instance name oftest_group, a metadata user label with a key offoo and a value ofbar, and a metadata system label with a key ofregion and a value ofus-central1:

"filter": "resource.labels.instance_id=\"1234567890\" ANDmetric.labels.instance_name=\"test_group\" ANDmetadata.user_labels.foo=\"bar\" ANDmetadata.system_labels.region=\"us-central1\""

TimeInterval

Describes a time interval:

  • Reads: A half-open time interval. It includes the end time but excludes the start time:(startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric.
  • Writes: A closed time interval. It extends from the start time to the end time, and includes both:[startTime, endTime]. Valid time intervals depend on theMetricKind of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future.
    • ForGAUGE metrics, thestartTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only forGAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval.
    • ForDELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. ForDELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval.
    • ForCUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval.
    • The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time.
JSON representation
{"endTime":string,"startTime":string}
Fields
endTime

string (Timestamp format)

Required. The end of the time interval.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

startTime

string (Timestamp format)

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

Methods

create

 Creates aSnooze that will prevent alerts, which match the provided criteria, from being opened.

get

 Retrieves aSnooze byname.

list

 Lists theSnoozes associated with a project.

patch

 Updates aSnooze, identified by itsname, with the parameters in the givenSnooze object.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-25 UTC.