Method: projects.settings.patch

Updates a specified setting.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting 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.

On success, the response will contain only name, localValue and etag. The metadata and effectiveValue cannot be updated through this API.

Note: the supplied setting will perform a full overwrite of the localValue field.

HTTP request

PATCH https://resourcesettings.googleapis.com/v1/{setting.name=projects/*/settings/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
setting.name

string

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

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

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

Request body

The request body contains an instance of Setting.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.