Method: projects.settings.updateValue

  • Updates a setting value, performing a full overwrite of all fields.

  • Returns errors if the setting or value doesn't exist, is read-only, or the etag doesn't match.

  • Requires the https://www.googleapis.com/auth/cloud-platform OAuth scope for authorization.

  • Uses the PATCH HTTP method and provides details on the request and response body structures.

  • Identifies the required path parameter settingValue.name with format and example.

Updates a setting value.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting or the setting value does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.

Note: the supplied setting value will perform a full overwrite of all fields.

HTTP request

PATCH https://resourcesettings.googleapis.com/v1alpha1/{settingValue.name=projects/*/settings/*/value}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
settingValue.name

string

The resource name of the setting value. Must be in one of the following forms:

  • projects/{project_number}/settings/{setting_name}/value
  • folders/{folder_id}/settings/{setting_name}/value
  • organizations/{organization_id}/settings/{setting_name}/value

For example, "/projects/123/settings/gcp-enableMyFeature/value"

Request body

The request body contains an instance of SettingValue.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.