Represents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.
If successful, the response body contains data with the following structure:
Specifies a fingerprint for instance settings, which is essentially a hash of the instance settings resource's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance settings resource. You must always provide an up-to-date fingerprint hash in order to update or change the resource, otherwise the request will fail with error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve the resource.
A base64-encoded string.
metadata
object
The metadata key/value pairs assigned to all the instances in the corresponding scope.
metadata.kind
string
[Output Only] Type of the resource. Always compute#metadata for metadata.
metadata.items
map (key: string, value: string)
A metadata key/value items map. The total size of all keys and values must be less than 512KB.
zone
string
[Output Only] URL of the zone where the resource resides You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis document describes how to retrieve instance settings for Compute Engine VM instances using a \u003ccode\u003eGET\u003c/code\u003e request to a specific URL, which includes the project ID and zone as path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for retrieving instance settings must be empty, and the response body will contain details about the instance settings, including the kind, fingerprint, metadata, and zone.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of the instance settings includes fields like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003efingerprint\u003c/code\u003e, \u003ccode\u003emetadata\u003c/code\u003e (containing \u003ccode\u003ekind\u003c/code\u003e and \u003ccode\u003eitems\u003c/code\u003e), and \u003ccode\u003ezone\u003c/code\u003e, with \u003ccode\u003efingerprint\u003c/code\u003e being essential for updating settings and a map of key-value pairs for \u003ccode\u003eitems\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully authorize the request, you must use one of the specified OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/compute\u003c/code\u003e, or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eRetrieving instance settings also requires the \u003ccode\u003ecompute.instanceSettings.get\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: instanceSettings.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.InstanceSettings.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\ninstanceSettings.get Instance settings.\n\n### HTTP request\n\n`GET https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/instanceSettings`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRepresents a Instance Settings resource. You can use instance settings to configure default settings for Compute Engine VM instances. For example, you can use it to configure default machine type of Compute Engine VM instances.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/compute.readonly`\n- `\n https://www.googleapis.com/auth/compute`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nIn addition to any permissions specified on the fields above, authorization requires one or more of the following [IAM](https://cloud.google.com/iam/docs/) permissions:\n\n- `compute.instanceSettings.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]