REST Resource: folders.locations.muteConfigs

Resource: MuteConfig

A mute config is a Cloud SCC resource that contains the configuration to mute create/update events of findings.

JSON representation 
{
  "name": string,
  "description": string,
  "filter": string,
  "createTime": string,
  "updateTime": string,
  "mostRecentEditor": string,
  "type": enum (MuteConfigType),
  "expiryTime": string
}
Fields
name

string

Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format:

  • organizations/{organization}/muteConfigs/{muteConfig} + organizations/{organization}locations/{location}//muteConfigs/{muteConfig}
  • folders/{folder}/muteConfigs/{muteConfig}
  • folders/{folder}/locations/{location}/muteConfigs/{muteConfig}
  • projects/{project}/muteConfigs/{muteConfig}
  • projects/{project}/locations/{location}/muteConfigs/{muteConfig}
description

string

A description of the mute config.
filter

string

Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings.

The following field and operator combinations are supported:

  • severity: =, :
  • category: =, :
  • resource.name: =, :
  • resource.project_name: =, :
  • resource.project_display_name: =, :
  • resource.folders.resource_folder: =, :
  • resource.parent_name: =, :
  • resource.parent_display_name: =, :
  • resource.type: =, :
  • findingClass: =, :
  • indicator.ip_addresses: =, :
  • indicator.domains: =, :
createTime

string (Timestamp format)

Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
mostRecentEditor

string

Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update.
type

enum (MuteConfigType)

Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.
expiryTime

string (Timestamp format)

Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

MuteConfigType

The type of MuteConfig.

Enums
MUTE_CONFIG_TYPE_UNSPECIFIED Unused.
STATIC A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.
DYNAMIC A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to "muted". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become "unmuted" (unless other configs still match).

Methods

create

 Creates a mute config.

delete

 Deletes an existing mute config.

get

 Gets a mute config.

list

 Lists mute configs.

patch

 Updates a mute config.