2026-02-03
▼ ▲ kmsinventory.projects.protectedResources.search
HTTP Method : GET
Description : Returns metadata about the resources protected by the given Cloud KMS CryptoKey in the given Cloud organization/project.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+scope}/protectedResources:search
Parameter Order : scope
Flat Path : v1/projects/{projectsId}/protectedResources:search
Parameters :
scope
Location : path
Pattern : ^projects/[^/]+$
Description : Required. A scope can be an organization or a project. Resources protected by the crypto key in provided scope will be returned. The allowed values are: * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/12345678") * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678")
Required : Yes
Type : string
cryptoKey
Description : Required. The resource name of the CryptoKey.
Type : string
Location : query
resourceTypes
Description : Optional. A list of resource types that this request searches for. If empty, it will search all the [trackable resource types](https://cloud.google.com/kms/docs/view-key-usage#tracked-resource-types). Regular expressions are also supported. For example: * `compute.googleapis.com.*` snapshots resources whose type starts with `compute.googleapis.com`. * `.*Image` snapshots resources whose type ends with `Image`. * `.*Image.*` snapshots resources whose type contains `Image`. See [RE2](https://github.com/google/re2/wiki/Syntax) for all supported regular expression syntax. If the regular expression does not match any supported resource type, an INVALID_ARGUMENT error will be returned.
Repeated : Yes
Location : query
Type : string
pageSize
Description : The maximum number of resources to return. The service may return fewer than this value. If unspecified, at most 500 resources will be returned. The maximum value is 500; values above 500 will be coerced to 500.
Location : query
Format : int32
Type : integer
pageToken
Location : query
Description : A page token, received from a previous KeyTrackingService.SearchProtectedResources call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to KeyTrackingService.SearchProtectedResources must match the call that provided the page token.
Type : string
▼ ▲ kmsinventory.projects.locations.keyRings.cryptoKeys.getProtectedResourcesSummary
Parameters :
fallbackScope
Enum Descriptions :
Description : Optional. The scope to use if the kms organization service account is not configured.
Type : string
Location : query
Enum :