acceleratorTypes3

addresses8

advice3

autoscalers8

backendBuckets14

backendServices17

crossSiteNetworks5

disks20

diskTypes3

externalVpnGateways6

firewallPolicies18

firewalls7

forwardingRules8

futureReservations7

globalAddresses7

globalForwardingRules7

globalFrontendSettings2

globalNetworkEndpointGroups7

globalOperations5

globalOrganizationOperations3

globalPublicDelegatedPrefixes5

globalVmExtensionPolicies6

healthChecks8

hosts3

httpHealthChecks7

httpsHealthChecks7

imageFamilyViews1

images11

imageViews2

instanceGroupManagerResizeRequests5

instanceGroupManagers24

instanceGroups10

instances51

instanceSettings2

instanceTemplates8

instantSnapshotGroups7

instantSnapshots9

interconnectAttachmentGroups9

interconnectAttachments7

interconnectGroups10

interconnectLocations2

interconnectRemoteLocations2

interconnects8

licenseCodes4

licenses8

machineImages8

machineTypes3

managedRulesets2

networkAttachments9

networkEdgeSecurityServices5

networkEndpointGroups9

networkFirewallPolicies21

networkProfiles2

networks13

nodeGroups15

nodeTemplates8

nodeTypes3

organizationSecurityPolicies16

packetMirrorings7

previewFeatures3

projects14

projectViews1

publicAdvertisedPrefixes7

publicDelegatedPrefixes8

regionAutoscalers7

regionBackendBuckets9

regionBackendServices12

regionCommitments5

regionCompositeHealthChecks8

regionDisks18

regionDiskTypes2

regionHealthAggregationPolicies7

regionHealthChecks7

regionHealthCheckServices7

regionHealthSources8

regionInstanceGroupManagerResizeRequests5

regionInstanceGroupManagers23

regionInstanceGroups5

regionInstances1

regionInstanceTemplates4

regionInstantSnapshotGroups7

regionInstantSnapshots8

regionNetworkEndpointGroups7

regionNetworkFirewallPolicies18

regionNotificationEndpoints6

regionOperations4

regions2

regionSecurityPolicies10

regionSnapshots9

regionSnapshotSettings2

regionSslCertificates4

regionSslPolicies6

regionTargetHttpProxies5

regionTargetHttpsProxies7

regionTargetTcpProxies4

regionUrlMaps7

regionZones1

reliabilityRisks2

reservationBlocks6

reservations11

reservationSlots5

reservationSubBlocks8

resourcePolicies9

rolloutPlans4

rollouts7

routers22

routes5

securityPolicies12

serviceAttachments9

snapshots9

snapshotSettings2

sslCertificates5

sslPolicies7

storagePools10

storagePoolTypes3

subnetworks12

targetGrpcProxies5

targetHttpProxies7

targetHttpsProxies11

targetInstances7

targetPools13

targetSslProxies10

targetTcpProxies8

targetVpnGateways6

urlMaps10

vpnGateways8

vpnTunnels6

wireGroups5

zoneOperations4

zones2

zoneVmExtensionPolicies5

instances

POST /projects/{project}/zones/{zone}/instances/{instance}/setScheduling

Changed on Oct 30, 2026

Sets an instance's scheduling options. You can only call this method on astopped instance, that is, a VM instance that is in a TERMINATED state. SeeInstance Life Cycle for more information on the possible instance states. For more information about setting scheduling options for a VM, seeSet VM host maintenance policy.

Request

Base URL
https://compute.googleapis.com/compute/v1
URL
https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/instances/{instance}/setScheduling
Auth
- OAuth 2 and OAuth 2
  Implicit: https://accounts.google.com/o/oauth2/auth
  Scopes: https://www.googleapis.com/auth/cloud-platform
  Authorization code: https://accounts.google.com/o/oauth2/auth
  Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
- or OAuth 2 and OAuth 2
  Implicit: https://accounts.google.com/o/oauth2/auth
  Scopes: https://www.googleapis.com/auth/compute
  Authorization code: https://accounts.google.com/o/oauth2/auth
  Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/compute

Path parameters

projectstring required

Project ID for this request.

zonestring required

The name of the zone for this request.

instancestring required

Instance name for this request.

Query parameters

requestIdstring

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

automaticRestartboolean

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances.Preemptible instances cannot be automatically restarted.

By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.

availabilityDomaininteger

Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

exposeHostTopologyboolean

This optional flag exposes the hashed physical host ID in the ResourceStatus resource of the VM.

hostErrorTimeoutSecondsinteger

Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.

instanceTerminationAction'DELETE' | 'INSTANCE_TERMINATION_ACTION_UNSPECIFIED' | 'STOP'

Specifies the termination action for the instance.

locationHintstring

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.

minNodeCpusinteger

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

onHostMaintenance'MIGRATE' | 'TERMINATE'

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. Forpreemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy.

preemptibleboolean

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance isstopped and therefore, in a TERMINATED state. SeeInstance Life Cycle for more information on the possible instance states.

provisioningModel'FLEX_START' | 'RESERVATION_BOUND' | 'SPOT' | 'STANDARD'

Specifies the provisioning model of the instance.

skipGuestOsShutdownboolean

Defines whether GCE ACPI G2 Soft Off signal should be skipped during shutdown operation of VM.

Default is false, meaning there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs.

terminationTimestring

Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance termination action will be performed at the termination time.

Response

Successful response

clientOperationIdstring

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

creationTimestampstring

[Deprecated] This field is deprecated.

descriptionstring

[Output Only] A textual description of the operation, which is set when the operation is created.

endTimestring

[Output Only] The time that this operation was completed. This value is inRFC3339 text format.

httpErrorMessagestring

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

httpErrorStatusCodeinteger

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

idstring uint64

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

insertTimestring

[Output Only] The time that this operation was requested. This value is inRFC3339 text format.

kindstring

Output only. [Output Only] Type of the resource. Always compute#operation for Operation resources.

namestring

[Output Only] Name of the operation.

operationGroupIdstring

Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

operationTypestring

[Output Only] The type of operation, such as insert, update, or delete, and so on.

progressinteger

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

regionstring

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

selfLinkstring

[Output Only] Server-defined URL for the resource.

startTimestring

[Output Only] The time that this operation was started by the server. This value is inRFC3339 text format.

status'DONE' | 'PENDING' | 'RUNNING'

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

statusMessagestring

[Output Only] An optional textual description of the current status of the operation.

targetIdstring uint64

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

targetLinkstring

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.

userstring

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

zonestring

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Changes

Oct 30, 20268b85e897d3dc Revision changes
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c
- info
  the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c
Oct 23, 202648929bf89eeb Revision changes
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c
- info
  the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2
- info
  the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

Operation history (4 revisions)