Resource Settings API

  • The Resource Settings API empowers users to manage and adjust the behavior of their Google Cloud Platform (GCP) resources, including virtual machines, firewalls, and projects, within the Cloud Resource Hierarchy.

  • This API provides access to modify resource settings across various levels of the hierarchy, such as folders, organizations, and projects, using REST resources.

  • You can use the API to perform operations like getting, setting, deleting, listing, searching, and looking up effective settings values.

  • Google recommends using their client libraries for interacting with the API, but a discovery document and service endpoint are available for custom integrations.

  • The service endpoint for this API is https://resourcesettings.googleapis.com.

The Resource Settings API allows users to control and modify the behavior of their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud Resource Hierarchy.

Service: resourcesettings.googleapis.com

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://resourcesettings.googleapis.com

REST Resource: v1alpha1.folders.settings

Methods
deleteValue DELETE /v1alpha1/{name=folders/*/settings/*/value}
Deletes a setting value.
getValue GET /v1alpha1/{name=folders/*/settings/*/value}
Gets a setting value.
list GET /v1alpha1/{parent=folders/*}/settings
Lists all the settings that are available on the Cloud resource parent.
lookupEffectiveValue GET /v1alpha1/{parent=folders/*/settings/*}:lookupEffectiveValue
Computes the effective setting value of a setting at the Cloud resource parent.
search GET /v1alpha1/{parent=folders/*}/settings:search
Searches for all setting values that exist on the resource parent.
updateValue PATCH /v1alpha1/{settingValue.name=folders/*/settings/*/value}
Updates a setting value.

REST Resource: v1alpha1.folders.settings.value

Methods
create POST /v1alpha1/{settingValue.name=folders/*/settings/*/value}
Creates a setting value.

REST Resource: v1alpha1.organizations.settings

Methods
deleteValue DELETE /v1alpha1/{name=organizations/*/settings/*/value}
Deletes a setting value.
getValue GET /v1alpha1/{name=organizations/*/settings/*/value}
Gets a setting value.
list GET /v1alpha1/{parent=organizations/*}/settings
Lists all the settings that are available on the Cloud resource parent.
lookupEffectiveValue GET /v1alpha1/{parent=organizations/*/settings/*}:lookupEffectiveValue
Computes the effective setting value of a setting at the Cloud resource parent.
search GET /v1alpha1/{parent=organizations/*}/settings:search
Searches for all setting values that exist on the resource parent.
updateValue PATCH /v1alpha1/{settingValue.name=organizations/*/settings/*/value}
Updates a setting value.

REST Resource: v1alpha1.organizations.settings.value

Methods
create POST /v1alpha1/{settingValue.name=organizations/*/settings/*/value}
Creates a setting value.

REST Resource: v1alpha1.projects.settings

Methods
deleteValue DELETE /v1alpha1/{name=projects/*/settings/*/value}
Deletes a setting value.
getValue GET /v1alpha1/{name=projects/*/settings/*/value}
Gets a setting value.
list GET /v1alpha1/{parent=projects/*}/settings
Lists all the settings that are available on the Cloud resource parent.
lookupEffectiveValue GET /v1alpha1/{parent=projects/*/settings/*}:lookupEffectiveValue
Computes the effective setting value of a setting at the Cloud resource parent.
search GET /v1alpha1/{parent=projects/*}/settings:search
Searches for all setting values that exist on the resource parent.
updateValue PATCH /v1alpha1/{settingValue.name=projects/*/settings/*/value}
Updates a setting value.

REST Resource: v1alpha1.projects.settings.value

Methods
create POST /v1alpha1/{settingValue.name=projects/*/settings/*/value}
Creates a setting value.