Method: folders.settings.search

  • This documentation outlines how to search for all setting values on a specified Cloud resource using the Resource Settings API.

  • The search is performed using a GET request to a specific endpoint, passing the parent resource in the path.

  • While pageSize and pageToken are present as query parameters, they are currently unused.

  • Successful requests will return a SearchSettingValuesResponse containing the search results.

  • Authorization requires the cloud-platform OAuth scope and the resourcesettings.settingvalues.list IAM permission on the parent resource.

Searches for all setting values that exist on the resource parent. The setting values are not limited to those of a particular setting.

HTTP request

GET https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*}/settings:search

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The Cloud resource that parents the setting. Must be in one of the following forms:

  • projects/{project_number}
  • projects/{project_id}
  • folders/{folder_id}
  • organizations/{organization_id}

Authorization requires the following IAM permission on the specified resource parent:

  • resourcesettings.settingvalues.list

Query parameters

Parameters
pageSize

integer

Unused. The size of the page to be returned.
pageToken

string

Unused. A page token used to retrieve the next page.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of SearchSettingValuesResponse.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.