mute_configs

Creates, updates, deletes, gets or lists a mute_configs resource.

Overview

Name	mute_configs
Type	Resource
Id	google.securitycenter.mute_configs

Fields

The following fields are returned by SELECT queries:

folders_locations_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

projects_locations_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

organizations_locations_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

folders_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

projects_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

organizations_mute_configs_get

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

folders_mute_configs_list

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

projects_mute_configs_list

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

organizations_mute_configs_list

Successful response

Name	Datatype	Description
name	string	This field will be ignored if provided on config creation. Format organizations/{organization}/muteConfigs/{mute_config} folders/{folder}/muteConfigs/{mute_config} projects/{project}/muteConfigs/{mute_config} organizations/{organization}/locations/global/muteConfigs/{mute_config} folders/{folder}/locations/global/muteConfigs/{mute_config} projects/{project}/locations/global/muteConfigs/{mute_config}
createTime	string (google-datetime)	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.
description	string	A description of the mute config.
displayName	string	The human readable name to be displayed for the mute config.
expiryTime	string (google-datetime)	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.
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: =, : * finding_class: =, : * indicator.ip_addresses: =, : * indicator.domains: =, :
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	string	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.
updateTime	string (google-datetime)	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_locations_mute_configs_get	select	foldersId, locationsId, muteConfigsId		Gets a mute config.
projects_locations_mute_configs_get	select	projectsId, locationsId, muteConfigsId		Gets a mute config.
organizations_locations_mute_configs_get	select	organizationsId, locationsId, muteConfigsId		Gets a mute config.
folders_mute_configs_get	select	foldersId, muteConfigsId		Gets a mute config.
projects_mute_configs_get	select	projectsId, muteConfigsId		Gets a mute config.
organizations_mute_configs_get	select	organizationsId, muteConfigsId		Gets a mute config.
folders_mute_configs_list	select	foldersId	pageSize, pageToken	Lists mute configs.
projects_mute_configs_list	select	projectsId	pageSize, pageToken	Lists mute configs.
organizations_mute_configs_list	select	organizationsId	pageSize, pageToken	Lists mute configs.
folders_mute_configs_create	insert	foldersId	muteConfigId	Creates a mute config.
projects_mute_configs_create	insert	projectsId	muteConfigId	Creates a mute config.
organizations_mute_configs_create	insert	organizationsId	muteConfigId	Creates a mute config.
folders_locations_mute_configs_patch	update	foldersId, locationsId, muteConfigsId	updateMask	Updates a mute config.
projects_locations_mute_configs_patch	update	projectsId, locationsId, muteConfigsId	updateMask	Updates a mute config.
organizations_locations_mute_configs_patch	update	organizationsId, locationsId, muteConfigsId	updateMask	Updates a mute config.
folders_mute_configs_patch	update	foldersId, muteConfigsId	updateMask	Updates a mute config.
projects_mute_configs_patch	update	projectsId, muteConfigsId	updateMask	Updates a mute config.
organizations_mute_configs_patch	update	organizationsId, muteConfigsId	updateMask	Updates a mute config.
folders_locations_mute_configs_delete	delete	foldersId, locationsId, muteConfigsId		Deletes an existing mute config.
projects_locations_mute_configs_delete	delete	projectsId, locationsId, muteConfigsId		Deletes an existing mute config.
organizations_locations_mute_configs_delete	delete	organizationsId, locationsId, muteConfigsId		Deletes an existing mute config.
folders_mute_configs_delete	delete	foldersId, muteConfigsId		Deletes an existing mute config.
projects_mute_configs_delete	delete	projectsId, muteConfigsId		Deletes an existing mute config.
organizations_mute_configs_delete	delete	organizationsId, muteConfigsId		Deletes an existing mute config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
foldersId	string
locationsId	string
muteConfigsId	string
organizationsId	string
projectsId	string
muteConfigId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

folders_locations_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

projects_locations_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

organizations_locations_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

folders_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

projects_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

organizations_mute_configs_get

Gets a mute config.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND muteConfigsId = '{{ muteConfigsId }}' -- required;

folders_mute_configs_list

Lists mute configs.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

projects_mute_configs_list

Lists mute configs.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_mute_configs_list

Lists mute configs.

SELECT
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
FROM google.securitycenter.mute_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

folders_mute_configs_create

Creates a mute config.

INSERT INTO google.securitycenter.mute_configs (
data__name,
data__displayName,
data__description,
data__filter,
data__type,
data__expiryTime,
foldersId,
muteConfigId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ filter }}',
'{{ type }}',
'{{ expiryTime }}',
'{{ foldersId }}',
'{{ muteConfigId }}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
;

projects_mute_configs_create

Creates a mute config.

INSERT INTO google.securitycenter.mute_configs (
data__name,
data__displayName,
data__description,
data__filter,
data__type,
data__expiryTime,
projectsId,
muteConfigId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ filter }}',
'{{ type }}',
'{{ expiryTime }}',
'{{ projectsId }}',
'{{ muteConfigId }}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
;

organizations_mute_configs_create

Creates a mute config.

INSERT INTO google.securitycenter.mute_configs (
data__name,
data__displayName,
data__description,
data__filter,
data__type,
data__expiryTime,
organizationsId,
muteConfigId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ description }}',
'{{ filter }}',
'{{ type }}',
'{{ expiryTime }}',
'{{ organizationsId }}',
'{{ muteConfigId }}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: mute_configs
  props:
    - name: foldersId
      value: string
      description: Required parameter for the mute_configs resource.
    - name: projectsId
      value: string
      description: Required parameter for the mute_configs resource.
    - name: organizationsId
      value: string
      description: Required parameter for the mute_configs resource.
    - name: name
      value: string
      description: >
        This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`
        
    - name: displayName
      value: string
      description: >
        The human readable name to be displayed for the mute config.
        
    - name: description
      value: string
      description: >
        A description of the mute config.
        
    - name: filter
      value: string
      description: >
        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: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`
        
    - name: type
      value: string
      description: >
        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.
        
      valid_values: ['MUTE_CONFIG_TYPE_UNSPECIFIED', 'STATIC', 'DYNAMIC']
    - name: expiryTime
      value: string
      description: >
        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.
        
    - name: muteConfigId
      value: string

UPDATE examples

folders_locations_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

projects_locations_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

organizations_locations_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

folders_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

projects_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

organizations_mute_configs_patch

Updates a mute config.

UPDATE google.securitycenter.mute_configs
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__description = '{{ description }}',
data__filter = '{{ filter }}',
data__type = '{{ type }}',
data__expiryTime = '{{ expiryTime }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
displayName,
expiryTime,
filter,
mostRecentEditor,
type,
updateTime;

DELETE examples

folders_locations_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;

projects_locations_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;

organizations_locations_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;

folders_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE foldersId = '{{ foldersId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;

projects_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE projectsId = '{{ projectsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;

organizations_mute_configs_delete

Deletes an existing mute config.

DELETE FROM google.securitycenter.mute_configs
WHERE organizationsId = '{{ organizationsId }}' --required
AND muteConfigsId = '{{ muteConfigsId }}' --required;