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
,
"displayName"
:
string
,
"description"
:
string
,
"filter"
:
string
,
"createTime"
:
string
,
"updateTime"
:
string
,
"mostRecentEditor"
:
string
,
"type"
:
enum (
|
name
string
This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{muteConfig}
folders/{folder}/muteConfigs/{muteConfig}
projects/{project}/muteConfigs/{muteConfig}
organizations/{organization}/locations/global/muteConfigs/{muteConfig}
folders/{folder}/locations/global/muteConfigs/{muteConfig}
projects/{project}/locations/global/muteConfigs/{muteConfig}
displayName
(deprecated)
string
The human readable name to be displayed for the mute config.
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.
Uses RFC 3339, where generated output will always be Z-normalized and uses 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"
.
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.
Uses RFC 3339, where generated output will always be Z-normalized and uses 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"
.
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
)
Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during 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.
Uses RFC 3339, where generated output will always be Z-normalized and uses 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 |
|
|---|---|
|
Creates a mute config. |
|
Deletes an existing mute config. |
|
Gets a mute config. |
|
Lists mute configs. |
|
Updates a mute config. |
