Compute Engine API
Creates and runs virtual machines on Google Cloud Platform.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Creates and runs virtual machines on Google Cloud Platform.
Endpoints 400
acceleratorTypes
- GETRetrieves an aggregated list of accelerator types.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/acceleratorTypes?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of accelerator types. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - GETReturns the specified accelerator type.
/projects/:project/zones/:zone/acceleratorTypes/:acceleratorTypeReturns the specified accelerator type. - GETRetrieves a list of accelerator types that are available to the specified
project.
/projects/:project/zones/:zone/acceleratorTypes?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of accelerator types that are available to the specified project.
addresses
- GETRetrieves an aggregated list of addresses.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/addresses?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of addresses. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - GETReturns the specified address resource.
/projects/:project/regions/:region/addresses/:addressReturns the specified address resource. - DELETEDeletes the specified address resource.
/projects/:project/regions/:region/addresses/:address?requestId=stringDeletes the specified address resource. - GETRetrieves a list of addresses contained within
the specified region.
/projects/:project/regions/:region/addresses?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of addresses contained within the specified region. - POSTCreates an address resource in the specified project by using the data
included in the request.
/projects/:project/regions/:region/addresses?requestId=stringCreates an address resource in the specified project by using the data included in the request. - POSTMoves the specified address resource.
/projects/:project/regions/:region/addresses/:address/move?requestId=stringMoves the specified address resource. - POSTSets the labels on an Address
/projects/:project/regions/:region/addresses/:resource/setLabels?requestId=stringSets the labels on an Address. To learn more about labels, read theLabeling Resources documentation. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/regions/:region/addresses/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
advice
- POSTAdvise how, where and when to create the requested amount of instances
with specified accelerators, within the…
/projects/:project/regions/:region/advice/calendarModeAdvise how, where and when to create the requested amount of instances with specified accelerators, within the specified time and location limits. The method… - POSTAdvice on making real-time decisions (such as choosing zone or
machine types) during deployment to maximize your…
/projects/:project/regions/:region/advice/capacityAdvice on making real-time decisions (such as choosing zone or machine types) during deployment to maximize your chances of obtaining capacity. - POSTGets the capacity history.
/projects/:project/regions/:region/advice/capacityHistoryGets the capacity history.
autoscalers
- GETRetrieves an aggregated list of autoscalers.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/autoscalers?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of autoscalers. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - GETReturns the specified autoscaler resource.
/projects/:project/zones/:zone/autoscalers/:autoscalerReturns the specified autoscaler resource. - DELETEDeletes the specified autoscaler.
/projects/:project/zones/:zone/autoscalers/:autoscaler?requestId=stringDeletes the specified autoscaler. - GETRetrieves a list of autoscalers contained within
the specified zone.
/projects/:project/zones/:zone/autoscalers?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of autoscalers contained within the specified zone. - PUTUpdates an autoscaler in the specified project using the data
included in the request.
/projects/:project/zones/:zone/autoscalers?autoscaler=string&requestId=stringUpdates an autoscaler in the specified project using the data included in the request. - POSTCreates an autoscaler in the specified project using the data
included in the request.
/projects/:project/zones/:zone/autoscalers?requestId=stringCreates an autoscaler in the specified project using the data included in the request. - PATCHUpdates an autoscaler in the specified project using the data
included in the request
/projects/:project/zones/:zone/autoscalers?autoscaler=string&requestId=stringUpdates an autoscaler in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format… - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/zones/:zone/autoscalers/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
backendBuckets
- POSTAdds a key for validating requests with signed URLs for this backend
bucket.
/projects/:project/global/backendBuckets/:backendBucket/addSignedUrlKey?requestId=stringAdds a key for validating requests with signed URLs for this backend bucket. - GETRetrieves the list of all BackendBucket resources, regional and global,
available to the specified project.
To…
/projects/:project/aggregated/backendBuckets?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of all BackendBucket resources, regional and global, available to the specified project. To prevent failure, it is recommended that you set… - GETReturns the specified BackendBucket resource.
/projects/:project/global/backendBuckets/:backendBucketReturns the specified BackendBucket resource. - PUTUpdates the specified BackendBucket resource with the data included in the
request.
/projects/:project/global/backendBuckets/:backendBucket?requestId=stringUpdates the specified BackendBucket resource with the data included in the request. - DELETEDeletes the specified BackendBucket resource.
/projects/:project/global/backendBuckets/:backendBucket?requestId=stringDeletes the specified BackendBucket resource. - PATCHUpdates the specified BackendBucket resource with the data included in the
request
/projects/:project/global/backendBuckets/:backendBucket?requestId=stringUpdates the specified BackendBucket resource with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format… - POSTDeletes a key for validating requests with signed URLs for this backend
bucket.
/projects/:project/global/backendBuckets/:backendBucket/deleteSignedUrlKey?keyName=string&requestId=stringDeletes a key for validating requests with signed URLs for this backend bucket. - GETGets the access control policy for a resource
/projects/:project/global/backendBuckets/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETRetrieves the list of BackendBucket resources available to the specified
project.
/projects/:project/global/backendBuckets?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of BackendBucket resources available to the specified project. - POSTCreates a BackendBucket resource in the specified project using
the data included in the request.
/projects/:project/global/backendBuckets?requestId=stringCreates a BackendBucket resource in the specified project using the data included in the request. - GETRetrieves a list of all usable backend buckets in the specified project.
/projects/:project/global/backendBuckets/listUsable?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of all usable backend buckets in the specified project. - POSTSets the edge security policy for the specified backend bucket.
/projects/:project/global/backendBuckets/:backendBucket/setEdgeSecurityPolicy?requestId=stringSets the edge security policy for the specified backend bucket. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/global/backendBuckets/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/backendBuckets/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
backendServices
- POSTAdds a key for validating requests with signed URLs for this backend
service.
/projects/:project/global/backendServices/:backendService/addSignedUrlKey?requestId=stringAdds a key for validating requests with signed URLs for this backend service. - GETRetrieves the list of all BackendService resources, regional and global,
available to the specified project.
To…
/projects/:project/aggregated/backendServices?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of all BackendService resources, regional and global, available to the specified project. To prevent failure, it is recommended that you… - GETReturns the specified BackendService resource.
/projects/:project/global/backendServices/:backendServiceReturns the specified BackendService resource. - PUTUpdates the specified BackendService resource with the data included in the
request
/projects/:project/global/backendServices/:backendService?requestId=stringUpdates the specified BackendService resource with the data included in the request. For more information, seeBackend services overview. - DELETEDeletes the specified BackendService resource.
/projects/:project/global/backendServices/:backendService?requestId=stringDeletes the specified BackendService resource. - PATCHPatches the specified BackendService resource with the data included in the
request
/projects/:project/global/backendServices/:backendService?requestId=stringPatches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports… - POSTDeletes a key for validating requests with signed URLs for this backend
service.
/projects/:project/global/backendServices/:backendService/deleteSignedUrlKey?keyName=string&requestId=stringDeletes a key for validating requests with signed URLs for this backend service. - GETReturns effective security policies applied to this backend service.
/projects/:project/global/backendServices/:backendService/getEffectiveSecurityPoliciesReturns effective security policies applied to this backend service. - POSTGets the most recent health check results for this
BackendService.
Example request body:
{
"group":…
/projects/:project/global/backendServices/:backendService/getHealthGets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" } - GETGets the access control policy for a resource
/projects/:project/global/backendServices/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETRetrieves the list of BackendService resources available to the specified
project.
/projects/:project/global/backendServices?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of BackendService resources available to the specified project. - POSTCreates a BackendService resource in the specified project using
the data included in the request
/projects/:project/global/backendServices?requestId=stringCreates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. - GETRetrieves a list of all usable backend services for Application Load
Balancers and Proxy Network Load Balancers in the…
/projects/:project/global/backendServices/listUsable?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of all usable backend services for Application Load Balancers and Proxy Network Load Balancers in the specified project. Backend services for… - POSTSets the edge security policy for the specified backend service.
/projects/:project/global/backendServices/:backendService/setEdgeSecurityPolicy?requestId=stringSets the edge security policy for the specified backend service. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/global/backendServices/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTSets the Google Cloud Armor security policy for the specified backend
service
/projects/:project/global/backendServices/:backendService/setSecurityPolicy?requestId=stringSets the Google Cloud Armor security policy for the specified backend service. For more information, seeGoogle Cloud Armor Overview - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/backendServices/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
crossSiteNetworks
- GETReturns the specified cross-site network in the given scope.
/projects/:project/global/crossSiteNetworks/:crossSiteNetworkReturns the specified cross-site network in the given scope. - DELETEDeletes the specified cross-site network in the given scope.
/projects/:project/global/crossSiteNetworks/:crossSiteNetwork?requestId=stringDeletes the specified cross-site network in the given scope. - PATCHUpdates the specified cross-site network with the data included in
the request
/projects/:project/global/crossSiteNetworks/:crossSiteNetwork?requestId=string&updateMask=string&validateOnly=trueUpdates the specified cross-site network with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and… - GETLists the cross-site networks for a project in the given scope.
/projects/:project/global/crossSiteNetworks?filter=string&maxResults=0&orderBy=string&pageToken=stringLists the cross-site networks for a project in the given scope. - POSTCreates a cross-site network in the specified project in the given scope
using the parameters that are included in the…
/projects/:project/global/crossSiteNetworks?requestId=string&validateOnly=trueCreates a cross-site network in the specified project in the given scope using the parameters that are included in the request.
diskTypes
- GETRetrieves an aggregated list of disk types.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/diskTypes?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of disk types. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - GETReturns the specified disk type.
/projects/:project/zones/:zone/diskTypes/:diskTypeReturns the specified disk type. - GETRetrieves a list of disk types available to the specified
project.
/projects/:project/zones/:zone/diskTypes?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of disk types available to the specified project.
disks
- POSTAdds existing resource policies to a disk
/projects/:project/zones/:zone/disks/:disk/addResourcePolicies?requestId=stringAdds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. - GETRetrieves an aggregated list of persistent disks.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/disks?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of persistent disks. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - POSTBulk create a set of disks.
/projects/:project/zones/:zone/disks/bulkInsert?requestId=stringBulk create a set of disks. - POSTSets the labels on many disks at once
/projects/:project/zones/:zone/disks/bulkSetLabels?requestId=string&resource=stringSets the labels on many disks at once. To learn more about labels, read theLabeling Resources documentation. - POSTCreates a snapshot of a specified persistent disk
/projects/:project/zones/:zone/disks/:disk/createSnapshot?guestFlush=true&requestId=stringCreates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more… - GETReturns the specified persistent disk.
/projects/:project/zones/:zone/disks/:diskReturns the specified persistent disk. - DELETEDeletes the specified persistent disk
/projects/:project/zones/:zone/disks/:disk?requestId=stringDeletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any… - PATCHUpdates the specified disk with the data included in the request.
The update is performed only on selected fields…
/projects/:project/zones/:zone/disks/:disk?paths=string&requestId=string&updateMask=stringUpdates the specified disk with the data included in the request. The update is performed only on selected fields included as part of update-mask. - GETGets the access control policy for a resource
/projects/:project/zones/:zone/disks/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETRetrieves a list of persistent disks contained within
the specified zone.
/projects/:project/zones/:zone/disks?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of persistent disks contained within the specified zone. - POSTCreates a persistent disk in the specified project using the data
in the request
/projects/:project/zones/:zone/disks?requestId=string&sourceImage=stringCreates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot,… - POSTRemoves resource policies from a disk.
/projects/:project/zones/:zone/disks/:disk/removeResourcePolicies?requestId=stringRemoves resource policies from a disk. - POSTResizes the specified persistent disk.
You can only increase the size of the disk.
/projects/:project/zones/:zone/disks/:disk/resize?requestId=stringResizes the specified persistent disk. You can only increase the size of the disk. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/zones/:zone/disks/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTSets the labels on a disk
/projects/:project/zones/:zone/disks/:resource/setLabels?requestId=stringSets the labels on a disk. To learn more about labels, read theLabeling Resources documentation. - POSTStarts asynchronous replication.
Must be invoked on the primary disk.
/projects/:project/zones/:zone/disks/:disk/startAsyncReplication?requestId=stringStarts asynchronous replication. Must be invoked on the primary disk. - POSTStops asynchronous replication.
Can be invoked either on the primary or on the secondary disk.
/projects/:project/zones/:zone/disks/:disk/stopAsyncReplication?requestId=stringStops asynchronous replication. Can be invoked either on the primary or on the secondary disk. - POSTStops asynchronous replication for a consistency group of disks.
Can be invoked either in the primary or secondary…
/projects/:project/zones/:zone/disks/stopGroupAsyncReplication?requestId=stringStops asynchronous replication for a consistency group of disks. Can be invoked either in the primary or secondary scope. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/zones/:zone/disks/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource. - POSTRotates the customer-managed
encryption key to the latest version for the specified persistent disk.
/projects/:project/zones/:zone/disks/:disk/updateKmsKey?requestId=stringRotates the customer-managed encryption key to the latest version for the specified persistent disk.
externalVpnGateways
- GETReturns the specified externalVpnGateway
/projects/:project/global/externalVpnGateways/:externalVpnGatewayReturns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. - DELETEDeletes the specified externalVpnGateway.
/projects/:project/global/externalVpnGateways/:externalVpnGateway?requestId=stringDeletes the specified externalVpnGateway. - GETRetrieves the list of ExternalVpnGateway available to the specified
project.
/projects/:project/global/externalVpnGateways?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of ExternalVpnGateway available to the specified project. - POSTCreates a ExternalVpnGateway in the specified project using
the data included in the request.
/projects/:project/global/externalVpnGateways?requestId=stringCreates a ExternalVpnGateway in the specified project using the data included in the request. - POSTSets the labels on an ExternalVpnGateway
/projects/:project/global/externalVpnGateways/:resource/setLabelsSets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/externalVpnGateways/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
firewallPolicies
- POSTInserts an association for the specified firewall policy.
/locations/global/firewallPolicies/:firewallPolicy/addAssociation?replaceExistingAssociation=true&requestId=stringInserts an association for the specified firewall policy. - POSTInserts a rule into a firewall policy.
/locations/global/firewallPolicies/:firewallPolicy/addRule?requestId=stringInserts a rule into a firewall policy. - POSTCopies rules to the specified firewall policy.
/locations/global/firewallPolicies/:firewallPolicy/cloneRules?requestId=string&sourceFirewallPolicy=stringCopies rules to the specified firewall policy. - GETReturns the specified firewall policy.
/locations/global/firewallPolicies/:firewallPolicyReturns the specified firewall policy. - DELETEDeletes the specified policy.
/locations/global/firewallPolicies/:firewallPolicy?requestId=stringDeletes the specified policy. - PATCHPatches the specified policy with the data included in the request.
/locations/global/firewallPolicies/:firewallPolicy?requestId=stringPatches the specified policy with the data included in the request. - GETGets an association with the specified name.
/locations/global/firewallPolicies/:firewallPolicy/getAssociation?name=stringGets an association with the specified name. - GETGets the access control policy for a resource
/locations/global/firewallPolicies/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETGets a rule of the specified priority.
/locations/global/firewallPolicies/:firewallPolicy/getRule?priority=0Gets a rule of the specified priority. - GETLists all the policies that have been configured for the specified
folder or organization.
/locations/global/firewallPolicies?filter=string&maxResults=0&orderBy=string&pageToken=string&parentId=stringLists all the policies that have been configured for the specified folder or organization. - POSTCreates a new policy in the specified project using the data included in
the request.
/locations/global/firewallPolicies?parentId=string&requestId=stringCreates a new policy in the specified project using the data included in the request. - GETLists associations of a specified target, i.e., organization or folder.
/locations/global/firewallPolicies/listAssociations?includeInheritedPolicies=true&targetResource=stringLists associations of a specified target, i.e., organization or folder. - POSTMoves the specified firewall policy.
/locations/global/firewallPolicies/:firewallPolicy/move?parentId=string&requestId=stringMoves the specified firewall policy. - POSTPatches a rule of the specified priority.
/locations/global/firewallPolicies/:firewallPolicy/patchRule?priority=0&requestId=stringPatches a rule of the specified priority. - POSTRemoves an association for the specified firewall policy.
/locations/global/firewallPolicies/:firewallPolicy/removeAssociation?name=string&requestId=stringRemoves an association for the specified firewall policy. - POSTDeletes a rule of the specified priority.
/locations/global/firewallPolicies/:firewallPolicy/removeRule?priority=0&requestId=stringDeletes a rule of the specified priority. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/locations/global/firewallPolicies/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTReturns permissions that a caller has on the specified resource.
/locations/global/firewallPolicies/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
firewalls
- GETReturns the specified firewall.
/projects/:project/global/firewalls/:firewallReturns the specified firewall. - PUTUpdates the specified firewall rule with the data included in the
request.
Note that all fields will be updated if…
/projects/:project/global/firewalls/:firewall?requestId=stringUpdates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not… - DELETEDeletes the specified firewall.
/projects/:project/global/firewalls/:firewall?requestId=stringDeletes the specified firewall. - PATCHUpdates the specified firewall rule with the data included in the
request
/projects/:project/global/firewalls/:firewall?requestId=stringUpdates the specified firewall rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and… - GETRetrieves the list of firewall rules available to the specified
project.
/projects/:project/global/firewalls?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of firewall rules available to the specified project. - POSTCreates a firewall rule in the specified project using the data
included in the request.
/projects/:project/global/firewalls?requestId=stringCreates a firewall rule in the specified project using the data included in the request. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/firewalls/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
forwardingRules
- GETRetrieves an aggregated list of forwarding rules.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/forwardingRules?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of forwarding rules. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - GETReturns the specified ForwardingRule resource.
/projects/:project/regions/:region/forwardingRules/:forwardingRule?view=BASICReturns the specified ForwardingRule resource. - DELETEDeletes the specified ForwardingRule resource.
/projects/:project/regions/:region/forwardingRules/:forwardingRule?requestId=stringDeletes the specified ForwardingRule resource. - PATCHUpdates the specified forwarding rule with the data included in the
request
/projects/:project/regions/:region/forwardingRules/:forwardingRule?requestId=stringUpdates the specified forwarding rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and… - GETRetrieves a list of ForwardingRule resources available to the specified
project and region.
/projects/:project/regions/:region/forwardingRules?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of ForwardingRule resources available to the specified project and region. - POSTCreates a ForwardingRule resource in the specified project and region using
the data included in the request.
/projects/:project/regions/:region/forwardingRules?requestId=stringCreates a ForwardingRule resource in the specified project and region using the data included in the request. - POSTSets the labels on the specified resource
/projects/:project/regions/:region/forwardingRules/:resource/setLabels?requestId=stringSets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. - POSTChanges target URL for forwarding rule
/projects/:project/regions/:region/forwardingRules/:forwardingRule/setTarget?requestId=stringChanges target URL for forwarding rule. The new target should be of the same type as the old target.
futureReservations
- GETRetrieves an aggregated list of future reservations.
To prevent failure, it is recommended that you set…
/projects/:project/aggregated/futureReservations?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of future reservations. To prevent failure, it is recommended that you set the returnPartialSuccess parameter to true. - POSTCancel the specified future reservation.
/projects/:project/zones/:zone/futureReservations/:futureReservation/cancel?requestId=stringCancel the specified future reservation. - GETRetrieves information about the specified future reservation.
/projects/:project/zones/:zone/futureReservations/:futureReservationRetrieves information about the specified future reservation. - DELETEDeletes the specified future reservation.
/projects/:project/zones/:zone/futureReservations/:futureReservation?requestId=stringDeletes the specified future reservation. - PATCHUpdates the specified future reservation.
/projects/:project/zones/:zone/futureReservations/:futureReservation?requestId=string&updateMask=stringUpdates the specified future reservation. - GETA list of all the future reservations that have been configured for the
specified project in specified zone.
/projects/:project/zones/:zone/futureReservations?filter=string&maxResults=0&orderBy=string&pageToken=stringA list of all the future reservations that have been configured for the specified project in specified zone. - POSTCreates a new Future Reservation.
/projects/:project/zones/:zone/futureReservations?requestId=stringCreates a new Future Reservation.
globalAddresses
- GETReturns the specified address resource.
/projects/:project/global/addresses/:addressReturns the specified address resource. - DELETEDeletes the specified address resource.
/projects/:project/global/addresses/:address?requestId=stringDeletes the specified address resource. - GETRetrieves a list of global addresses.
/projects/:project/global/addresses?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of global addresses. - POSTCreates an address resource in the specified project by using the data
included in the request.
/projects/:project/global/addresses?requestId=stringCreates an address resource in the specified project by using the data included in the request. - POSTMoves the specified address resource from one project to another project.
/projects/:project/global/addresses/:address/move?requestId=stringMoves the specified address resource from one project to another project. - POSTSets the labels on a GlobalAddress
/projects/:project/global/addresses/:resource/setLabelsSets the labels on a GlobalAddress. To learn more about labels, read theLabeling Resources documentation. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/addresses/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
globalForwardingRules
- GETReturns the specified GlobalForwardingRule resource
/projects/:project/global/forwardingRules/:forwardingRule?view=BASICReturns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. - DELETEDeletes the specified GlobalForwardingRule resource.
/projects/:project/global/forwardingRules/:forwardingRule?requestId=stringDeletes the specified GlobalForwardingRule resource. - PATCHUpdates the specified forwarding rule with the data included in the
request
/projects/:project/global/forwardingRules/:forwardingRule?requestId=stringUpdates the specified forwarding rule with the data included in the request. This method supportsPATCH semantics and uses theJSON merge patch format and… - GETRetrieves a list of GlobalForwardingRule resources available to the
specified project.
/projects/:project/global/forwardingRules?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of GlobalForwardingRule resources available to the specified project. - POSTCreates a GlobalForwardingRule resource in the specified project using
the data included in the request.
/projects/:project/global/forwardingRules?requestId=stringCreates a GlobalForwardingRule resource in the specified project using the data included in the request. - POSTSets the labels on the specified resource
/projects/:project/global/forwardingRules/:resource/setLabelsSets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation. - POSTChanges target URL for the GlobalForwardingRule resource
/projects/:project/global/forwardingRules/:forwardingRule/setTarget?requestId=stringChanges target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.
globalFrontendSettings
- GETGets the Global Frontend Billing Bundle Settings for a project.
/projects/:project/global/globalFrontendSettingsGets the Global Frontend Billing Bundle Settings for a project. - PATCHUpdates the Global Frontend Billing Bundle Settings for a project.
/projects/:project/global/globalFrontendSettings?requestId=string&updateMask=stringUpdates the Global Frontend Billing Bundle Settings for a project.
globalNetworkEndpointGroups
- POSTAttach a network endpoint to the specified network endpoint group.
/projects/:project/global/networkEndpointGroups/:networkEndpointGroup/attachNetworkEndpoints?requestId=stringAttach a network endpoint to the specified network endpoint group. - GETReturns the specified network endpoint group.
/projects/:project/global/networkEndpointGroups/:networkEndpointGroupReturns the specified network endpoint group. - DELETEDeletes the specified network endpoint group.Note that the NEG cannot be
deleted if there are backend services…
/projects/:project/global/networkEndpointGroups/:networkEndpointGroup?requestId=stringDeletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. - POSTDetach the network endpoint from the specified network endpoint group.
/projects/:project/global/networkEndpointGroups/:networkEndpointGroup/detachNetworkEndpoints?requestId=stringDetach the network endpoint from the specified network endpoint group. - GETRetrieves the list of network endpoint groups that are located in the
specified project.
/projects/:project/global/networkEndpointGroups?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of network endpoint groups that are located in the specified project. - POSTCreates a network endpoint group in the specified project using the
parameters that are included in the…
/projects/:project/global/networkEndpointGroups?requestId=stringCreates a network endpoint group in the specified project using the parameters that are included in the request. Note: Use the following APIs to manage… - POSTLists the network endpoints in the specified network endpoint group.
/projects/:project/global/networkEndpointGroups/:networkEndpointGroup/listNetworkEndpoints?filter=string&maxResults=0&orderBy=string&pageToken=stringLists the network endpoints in the specified network endpoint group.
globalOperations
- GETRetrieves an aggregated list of all operations.
To prevent failure, Google recommends that you set…
/projects/:project/aggregated/operations?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of all operations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. - GETRetrieves the specified Operations resource.
/projects/:project/global/operations/:operationRetrieves the specified Operations resource. - DELETEDeletes the specified Operations resource.
/projects/:project/global/operations/:operationDeletes the specified Operations resource. - GETRetrieves a list of Operation resources contained within the specified
project.
/projects/:project/global/operations?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of Operation resources contained within the specified project. - POSTWaits for the specified Operation resource to return as `DONE`
or for the request to approach the 2 minute deadline,…
/projects/:project/global/operations/:operation/waitWaits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation…
globalOrganizationOperations
- GETRetrieves the specified Operations resource
/locations/global/operations/:operation?parentId=stringRetrieves the specified Operations resource. Gets a list of operations by making a list() request. - DELETEDeletes the specified Operations resource.
/locations/global/operations/:operation?parentId=stringDeletes the specified Operations resource. - GETRetrieves a list of Operation resources contained within the specified
organization.
/locations/global/operations?filter=string&maxResults=0&orderBy=string&pageToken=string&parentId=stringRetrieves a list of Operation resources contained within the specified organization.
globalPublicDelegatedPrefixes
- GETReturns the specified global PublicDelegatedPrefix resource.
/projects/:project/global/publicDelegatedPrefixes/:publicDelegatedPrefixReturns the specified global PublicDelegatedPrefix resource. - DELETEDeletes the specified global PublicDelegatedPrefix.
/projects/:project/global/publicDelegatedPrefixes/:publicDelegatedPrefix?requestId=stringDeletes the specified global PublicDelegatedPrefix. - PATCHPatches the specified global PublicDelegatedPrefix resource with the data
included in the request
/projects/:project/global/publicDelegatedPrefixes/:publicDelegatedPrefix?requestId=stringPatches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge… - GETLists the global PublicDelegatedPrefixes for a project.
/projects/:project/global/publicDelegatedPrefixes?filter=string&maxResults=0&orderBy=string&pageToken=stringLists the global PublicDelegatedPrefixes for a project. - POSTCreates a global PublicDelegatedPrefix in the specified project using the
parameters that are included in the request.
/projects/:project/global/publicDelegatedPrefixes?requestId=stringCreates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.
globalVmExtensionPolicies
- GETRetrieves the list of all VM Extension Policy resources
available to the specified project.
To prevent failure, it's…
/projects/:project/aggregated/vmExtensionPolicies?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of all VM Extension Policy resources available to the specified project. To prevent failure, it's recommended that you set the… - POSTPurge scoped resources (zonal policies) from a global VM extension
policy, and then delete the global VM extension…
/projects/:project/global/vmExtensionPolicies/:globalVmExtensionPolicy/delete?requestId=stringPurge scoped resources (zonal policies) from a global VM extension policy, and then delete the global VM extension policy. Purge of the scoped resources is a… - GETGets details of a global VM extension policy.
/projects/:project/global/vmExtensionPolicies/:globalVmExtensionPolicyGets details of a global VM extension policy. - PATCHUpdates a global VM extension policy.
/projects/:project/global/vmExtensionPolicies/:globalVmExtensionPolicy?requestId=stringUpdates a global VM extension policy. - GETLists global VM extension policies.
/projects/:project/global/vmExtensionPolicies?filter=string&maxResults=0&orderBy=string&pageToken=stringLists global VM extension policies. - POSTCreates a new project level GlobalVmExtensionPolicy.
/projects/:project/global/vmExtensionPolicies?requestId=stringCreates a new project level GlobalVmExtensionPolicy.
healthChecks
- GETRetrieves the list of all HealthCheck resources, regional and global,
available to the specified project.
To prevent…
/projects/:project/aggregated/healthChecks?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of all HealthCheck resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set… - GETReturns the specified HealthCheck resource.
/projects/:project/global/healthChecks/:healthCheckReturns the specified HealthCheck resource. - PUTUpdates a HealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/healthChecks/:healthCheck?requestId=stringUpdates a HealthCheck resource in the specified project using the data included in the request. - DELETEDeletes the specified HealthCheck resource.
/projects/:project/global/healthChecks/:healthCheck?requestId=stringDeletes the specified HealthCheck resource. - PATCHUpdates a HealthCheck resource in the specified project using the data
included in the request
/projects/:project/global/healthChecks/:healthCheck?requestId=stringUpdates a HealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge… - GETRetrieves the list of HealthCheck resources available to the specified
project.
/projects/:project/global/healthChecks?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of HealthCheck resources available to the specified project. - POSTCreates a HealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/healthChecks?requestId=stringCreates a HealthCheck resource in the specified project using the data included in the request. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/healthChecks/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
hosts
- GETRetrieves information about the specified host.
/projects/:project/zones/:zone/:association/hosts/:hostRetrieves information about the specified host. - POSTAllows customers to get SBOM versions of a host.
/projects/:project/zones/:zone/:association/hosts/:host/getVersion?requestId=stringAllows customers to get SBOM versions of a host. - GETRetrieves a list of hosts.
/projects/:project/zones/:zone/:association/hosts?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of hosts.
httpHealthChecks
- GETReturns the specified HttpHealthCheck resource.
/projects/:project/global/httpHealthChecks/:httpHealthCheckReturns the specified HttpHealthCheck resource. - PUTUpdates a HttpHealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/httpHealthChecks/:httpHealthCheck?requestId=stringUpdates a HttpHealthCheck resource in the specified project using the data included in the request. - DELETEDeletes the specified HttpHealthCheck resource.
/projects/:project/global/httpHealthChecks/:httpHealthCheck?requestId=stringDeletes the specified HttpHealthCheck resource. - PATCHUpdates a HttpHealthCheck resource in the specified project using the data
included in the request
/projects/:project/global/httpHealthChecks/:httpHealthCheck?requestId=stringUpdates a HttpHealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON merge… - GETRetrieves the list of HttpHealthCheck resources available to the specified
project.
/projects/:project/global/httpHealthChecks?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of HttpHealthCheck resources available to the specified project. - POSTCreates a HttpHealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/httpHealthChecks?requestId=stringCreates a HttpHealthCheck resource in the specified project using the data included in the request. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/httpHealthChecks/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
httpsHealthChecks
- GETReturns the specified HttpsHealthCheck resource.
/projects/:project/global/httpsHealthChecks/:httpsHealthCheckReturns the specified HttpsHealthCheck resource. - PUTUpdates a HttpsHealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/httpsHealthChecks/:httpsHealthCheck?requestId=stringUpdates a HttpsHealthCheck resource in the specified project using the data included in the request. - DELETEDeletes the specified HttpsHealthCheck resource.
/projects/:project/global/httpsHealthChecks/:httpsHealthCheck?requestId=stringDeletes the specified HttpsHealthCheck resource. - PATCHUpdates a HttpsHealthCheck resource in the specified project using the data
included in the request
/projects/:project/global/httpsHealthChecks/:httpsHealthCheck?requestId=stringUpdates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supportsPATCH semantics and uses theJSON… - GETRetrieves the list of HttpsHealthCheck resources available to the specified
project.
/projects/:project/global/httpsHealthChecks?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of HttpsHealthCheck resources available to the specified project. - POSTCreates a HttpsHealthCheck resource in the specified project using the data
included in the request.
/projects/:project/global/httpsHealthChecks?requestId=stringCreates a HttpsHealthCheck resource in the specified project using the data included in the request. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/httpsHealthChecks/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
imageFamilyViews
- GETReturns the latest image that is part of an image family, is not
deprecated and is rolled out in the specified zone.
/projects/:project/zones/:zone/imageFamilyViews/:familyReturns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.
imageViews
- GETReturns the specified global ImageView resource, with a regional
context.
/projects/:project/regions/:region/imageViews/:resourceIdReturns the specified global ImageView resource, with a regional context. - GETReturns a list of global ImageView resources, with a regional
context.
/projects/:project/regions/:region/imageViews?filter=string&maxResults=0&orderBy=string&pageToken=stringReturns a list of global ImageView resources, with a regional context.
images
- GETReturns the specified image.
/projects/:project/global/images/:imageReturns the specified image. - DELETEDeletes the specified image.
/projects/:project/global/images/:image?requestId=stringDeletes the specified image. - PATCHPatches the specified image with the data included in the request.
Only the following fields can be modified: family,…
/projects/:project/global/images/:image?requestId=stringPatches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. - POSTSets the deprecation status of an image.
If an empty request body is given, clears the deprecation status instead.
/projects/:project/global/images/:image/deprecate?requestId=stringSets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. - GETReturns the latest image that is part of an image family and is not
deprecated
/projects/:project/global/images/family/:familyReturns the latest image that is part of an image family and is not deprecated. For more information on image families, seePublic image families documentation. - GETGets the access control policy for a resource
/projects/:project/global/images/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETRetrieves the list of custom images
available to the specified project
/projects/:project/global/images?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not… - POSTCreates an image in the specified project using the data included
in the request.
/projects/:project/global/images?forceCreate=true&requestId=stringCreates an image in the specified project using the data included in the request. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/global/images/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTSets the labels on an image
/projects/:project/global/images/:resource/setLabelsSets the labels on an image. To learn more about labels, read theLabeling Resources documentation. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/images/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
instanceGroupManagerResizeRequests
- POSTCancels the specified resize request and removes it from the queue.
Cancelled resize request does no longer wait for…
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resizeRequests/:resizeRequest/cancel?requestId=stringCancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel… - GETReturns all of the details about the specified resize request.
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resizeRequests/:resizeRequestReturns all of the details about the specified resize request. - DELETEDeletes the specified, inactive resize request
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resizeRequests/:resizeRequest?requestId=stringDeletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were… - GETRetrieves a list of resize requests that are contained in the
managed instance group.
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resizeRequests?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of resize requests that are contained in the managed instance group. - POSTCreates a new resize request that starts provisioning VMs immediately
or queues VM creation.
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resizeRequests?requestId=stringCreates a new resize request that starts provisioning VMs immediately or queues VM creation.
instanceGroupManagers
- POSTFlags the specified instances to be removed from the
managed instance group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/abandonInstances?requestId=stringFlags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the… - GETRetrieves the list of managed instance groups and groups them by zone.
To prevent failure, Google recommends that you…
/projects/:project/aggregated/instanceGroupManagers?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of managed instance groups and groups them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter… - POSTApplies changes to selected instances on the managed instance group.
This method can be used to apply new overrides…
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/applyUpdatesToInstancesApplies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. - POSTCreates instances with per-instance configurations in this managed instance
group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/createInstances?requestId=stringCreates instances with per-instance configurations in this managed instance group. Instances are created using the current instance template. Thecreate… - GETReturns all of the details about the specified managed instance group.
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManagerReturns all of the details about the specified managed instance group. - DELETEDeletes the specified managed instance group and all of the instances
in that group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager?noGracefulShutdown=true&requestId=stringDeletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read… - PATCHUpdates a managed instance group using the information that you specify
in the request.
This operation is marked as…
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager?requestId=stringUpdates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the… - POSTFlags the specified instances in the managed instance group for immediate
deletion
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/deleteInstances?noGracefulShutdown=true&requestId=stringFlags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a… - POSTDeletes selected per-instance configurations for the managed instance
group.
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/deletePerInstanceConfigsDeletes selected per-instance configurations for the managed instance group. - GETRetrieves a list of managed instance groups that are contained within the
specified project and zone.
/projects/:project/zones/:zone/instanceGroupManagers?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of managed instance groups that are contained within the specified project and zone. - POSTCreates a managed instance group using the information that you specify
in the request
/projects/:project/zones/:zone/instanceGroupManagers?requestId=stringCreates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using… - GETLists all errors thrown by actions on instances for a given managed
instance group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/listErrors?filter=string&maxResults=0&orderBy=string&pageToken=stringLists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported. - POSTLists all of the instances in the managed instance group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/listManagedInstances?filter=string&maxResults=0&orderBy=string&pageToken=stringLists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance… - POSTLists all of the per-instance configurations defined for the managed
instance group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/listPerInstanceConfigs?filter=string&maxResults=0&orderBy=string&pageToken=stringLists all of the per-instance configurations defined for the managed instance group. The orderBy query parameter is not supported. - POSTInserts or patches per-instance configurations for the managed instance
group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/patchPerInstanceConfigs?requestId=stringInserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform… - POSTFlags the specified VM instances in the managed instance group to be
immediately recreated
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/recreateInstances?noGracefulShutdown=true&requestId=stringFlags the specified VM instances in the managed instance group to be immediately recreated. Each instance is recreated using the group's current… - POSTResizes the managed instance group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resize?requestId=string&size=0Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size,… - POSTFlags the specified instances in the managed instance group to be
resumed
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/resumeInstances?requestId=stringFlags the specified instances in the managed instance group to be resumed. This method increases thetargetSize and decreases the targetSuspendedSize of the… - POSTSpecifies the instance template to use when creating new instances in this
group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/setInstanceTemplate?requestId=stringSpecifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you… - POSTModifies the target pools to which all instances in this managed instance
group are assigned
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/setTargetPools?requestId=stringModifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in… - POSTFlags the specified instances in the managed instance group to be
started
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/startInstances?requestId=stringFlags the specified instances in the managed instance group to be started. This method increases thetargetSize and decreases the targetStoppedSize of the… - POSTFlags the specified instances in the managed instance group to be
immediately stopped
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/stopInstances?noGracefulShutdown=true&requestId=stringFlags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This… - POSTFlags the specified instances in the managed instance group to be
immediately suspended
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/suspendInstances?requestId=stringFlags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This… - POSTInserts or updates per-instance configurations for the managed instance
group
/projects/:project/zones/:zone/instanceGroupManagers/:instanceGroupManager/updatePerInstanceConfigs?requestId=stringInserts or updates per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform…
instanceGroups
- POSTAdds a list of instances to the specified instance group
/projects/:project/zones/:zone/instanceGroups/:instanceGroup/addInstances?requestId=stringAdds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding… - GETRetrieves the list of instance groups and sorts them by zone.
To prevent failure, Google recommends that you set…
/projects/:project/aggregated/instanceGroups?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true. - GETReturns the specified zonal instance group
/projects/:project/zones/:zone/instanceGroups/:instanceGroupReturns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use… - DELETEDeletes the specified instance group
/projects/:project/zones/:zone/instanceGroups/:instanceGroup?requestId=stringDeletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting… - GETRetrieves the list of zonal instance group resources contained within the
specified zone.
For managed instance…
/projects/:project/zones/:zone/instanceGroups?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use theinstanceGroupManagers or… - POSTCreates an instance group in the specified project using the
parameters that are included in the request.
/projects/:project/zones/:zone/instanceGroups?requestId=stringCreates an instance group in the specified project using the parameters that are included in the request. - POSTLists the instances in the specified instance group.
The orderBy query parameter is not supported.
The filter query…
/projects/:project/zones/:zone/instanceGroups/:instanceGroup/listInstances?filter=string&maxResults=0&orderBy=string&pageToken=stringLists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for… - POSTRemoves one or more instances from the specified instance group, but does
not delete those instances.
If the group is…
/projects/:project/zones/:zone/instanceGroups/:instanceGroup/removeInstances?requestId=stringRemoves one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has… - POSTSets the named ports for the specified instance group.
/projects/:project/zones/:zone/instanceGroups/:instanceGroup/setNamedPorts?requestId=stringSets the named ports for the specified instance group. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/zones/:zone/instanceGroups/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
instanceSettings
- GETGet Instance settings.
/projects/:project/zones/:zone/instanceSettingsGet Instance settings. - PATCHPatch Instance settings
/projects/:project/zones/:zone/instanceSettings?requestId=string&updateMask=stringPatch Instance settings
instanceTemplates
- GETRetrieves the list of all InstanceTemplates resources, regional and global,
available to the specified project.
To…
/projects/:project/aggregated/instanceTemplates?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves the list of all InstanceTemplates resources, regional and global, available to the specified project. To prevent failure, Google recommends that you… - GETReturns the specified instance template.
/projects/:project/global/instanceTemplates/:instanceTemplateReturns the specified instance template. - DELETEDeletes the specified instance template
/projects/:project/global/instanceTemplates/:instanceTemplate?requestId=stringDeletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are… - GETGets the access control policy for a resource
/projects/:project/global/instanceTemplates/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETRetrieves a list of instance templates that are contained within
the specified project.
/projects/:project/global/instanceTemplates?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of instance templates that are contained within the specified project. - POSTCreates an instance template in the specified project using the
data that is included in the request
/projects/:project/global/instanceTemplates?requestId=stringCreates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing… - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/global/instanceTemplates/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTReturns permissions that a caller has on the specified resource.
/projects/:project/global/instanceTemplates/:resource/testIamPermissionsReturns permissions that a caller has on the specified resource.
instances
- POSTAdds an access config to an instance's network interface.
/projects/:project/zones/:zone/instances/:instance/addAccessConfig?networkInterface=string&requestId=stringAdds an access config to an instance's network interface. - POSTAdds one dynamic network interface to an active instance.
/projects/:project/zones/:zone/instances/:instance/addNetworkInterface?requestId=stringAdds one dynamic network interface to an active instance. - POSTAdds existing resource policies to an instance
/projects/:project/zones/:zone/instances/:instance/addResourcePolicies?requestId=stringAdds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations. - GETRetrieves an aggregated list of all of the instances in your project
across all regions and zones.
The performance of…
/projects/:project/aggregated/instances?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=stringRetrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is… - POSTAttaches an existing Disk resource to an instance
/projects/:project/zones/:zone/instances/:instance/attachDisk?forceAttach=true&requestId=stringAttaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at… - POSTCreates multiple instances
/projects/:project/zones/:zone/instances/bulkInsert?requestId=stringCreates multiple instances. Count specifies the number of instances to create. For more information, seeAbout bulk creation of VMs. - GETReturns the specified Instance resource.
/projects/:project/zones/:zone/instances/:instanceReturns the specified Instance resource. - PUTUpdates an instance only if the necessary resources are available
/projects/:project/zones/:zone/instances/:instance?discardLocalSsd=true&minimalAction=INVALID&mostDisruptiveAllowedAction=INVALID&requestId=stringUpdates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running… - DELETEDeletes the specified Instance resource
/projects/:project/zones/:zone/instances/:instance?noGracefulShutdown=true&requestId=stringDeletes the specified Instance resource. For more information, seeDeleting an instance. - POSTDeletes an access config from an instance's network interface.
/projects/:project/zones/:zone/instances/:instance/deleteAccessConfig?accessConfig=string&networkInterface=string&requestId=stringDeletes an access config from an instance's network interface. - POSTDeletes one dynamic network interface from an active instance.
InstancesDeleteNetworkInterfaceRequest indicates:
-…
/projects/:project/zones/:zone/instances/:instance/deleteNetworkInterface?networkInterfaceName=string&requestId=stringDeletes one dynamic network interface from an active instance. InstancesDeleteNetworkInterfaceRequest indicates: instance from which to delete, using… - POSTDetaches a disk from an instance.
/projects/:project/zones/:zone/instances/:instance/detachDisk?deviceName=string&requestId=stringDetaches a disk from an instance. - GETReturns effective firewalls applied to an interface of the instance.
/projects/:project/zones/:zone/instances/:instance/getEffectiveFirewalls?networkInterface=stringReturns effective firewalls applied to an interface of the instance. - GETReturns the specified guest attributes entry.
/projects/:project/zones/:zone/instances/:instance/getGuestAttributes?queryPath=string&variableKey=stringReturns the specified guest attributes entry. - GETGets the access control policy for a resource
/projects/:project/zones/:zone/instances/:resource/getIamPolicy?optionsRequestedPolicyVersion=0Gets the access control policy for a resource. May be empty if no such policy or resource exists. - GETReturns the screenshot from the specified instance.
/projects/:project/zones/:zone/instances/:instance/screenshotReturns the screenshot from the specified instance. - GETReturns the last 1 MB of serial port output from the specified instance.
/projects/:project/zones/:zone/instances/:instance/serialPort?port=0&start=stringReturns the last 1 MB of serial port output from the specified instance. - GETReturns the Shielded Instance Identity of an instance
/projects/:project/zones/:zone/instances/:instance/getShieldedInstanceIdentityReturns the Shielded Instance Identity of an instance - GETRetrieves the list of instances contained within
the specified zone.
/projects/:project/zones/:zone/instances?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves the list of instances contained within the specified zone. - POSTCreates an instance resource in the specified project using the data
included in the request.
/projects/:project/zones/:zone/instances?requestId=string&sourceInstanceTemplate=string&sourceMachineImage=stringCreates an instance resource in the specified project using the data included in the request. - GETRetrieves a list of resources that refer to the VM instance specified in
the request
/projects/:project/zones/:zone/instances/:instance/referrers?filter=string&maxResults=0&orderBy=string&pageToken=stringRetrieves a list of resources that refer to the VM instance specified in the request. For example, if the VM instance is part of a managed or unmanaged… - POSTPerform a manual maintenance on the instance.
/projects/:project/zones/:zone/instances/:instance/performMaintenance?requestId=stringPerform a manual maintenance on the instance. - POSTRemoves resource policies from an instance.
/projects/:project/zones/:zone/instances/:instance/removeResourcePolicies?requestId=stringRemoves resource policies from an instance. - POSTMark the host as faulty and try to restart the instance on a new host.
/projects/:project/zones/:zone/instances/:instance/reportHostAsFaulty?requestId=stringMark the host as faulty and try to restart the instance on a new host. - POSTPerforms a reset on the instance
/projects/:project/zones/:zone/instances/:instance/reset?requestId=stringPerforms a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, seeResetting an instance. - POSTResumes an instance that was suspended using theinstances().suspend
method.
/projects/:project/zones/:zone/instances/:instance/resume?requestId=stringResumes an instance that was suspended using theinstances().suspend method. - POSTSends diagnostic interrupt to the instance.
/projects/:project/zones/:zone/instances/:instance/sendDiagnosticInterruptSends diagnostic interrupt to the instance. - POSTSets deletion protection on the instance.
/projects/:project/zones/:zone/instances/:resource/setDeletionProtection?deletionProtection=true&requestId=stringSets deletion protection on the instance. - POSTSets the auto-delete flag for a disk attached to an instance.
/projects/:project/zones/:zone/instances/:instance/setDiskAutoDelete?autoDelete=true&deviceName=string&requestId=stringSets the auto-delete flag for a disk attached to an instance. - POSTSets the access control policy on the specified resource.
Replaces any existing policy.
/projects/:project/zones/:zone/instances/:resource/setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. - POSTSets labels on an instance
/projects/:project/zones/:zone/instances/:instance/setLabels?requestId=stringSets labels on an instance. To learn more about labels, read theLabeling Resources documentation. - POSTChanges the number and/or type of accelerator for a stopped instance to the
values specified in the request.
/projects/:project/zones/:zone/instances/:instance/setMachineResources?requestId=stringChanges the number and/or type of accelerator for a stopped instance to the values specified in the request. - POSTChanges the machine type for a stopped instance to the machine
type specified in the request.
/projects/:project/zones/:zone/instances/:instance/setMachineType?requestId=stringChanges the machine type for a stopped instance to the machine type specified in the request. - POSTSets metadata for the specified instance to the data included
in the request.
/projects/:project/zones/:zone/instances/:instance/setMetadata?requestId=stringSets metadata for the specified instance to the data included in the request. - POSTChanges the minimum CPU platform that this instance should use.
This method can only
be called on a stopped instance
/projects/:project/zones/:zone/instances/:instance/setMinCpuPlatform?requestId=stringChanges the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, readSpecifying a… - POSTSets name of an instance.
/projects/:project/zones/:zone/instances/:instance/setName?requestId=stringSets name of an instance. - POSTSets an instance's scheduling options
/projects/:project/zones/:zone/instances/:instance/setScheduling?requestId=stringSets 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… - POSTSets the Google Cloud Armor security policy for the specified instance.
For more information, seeGoogle
Cloud Armor…
/projects/:project/zones/:zone/instances/:instance/setSecurityPolicy?requestId=stringSets the Google Cloud Armor security policy for the specified instance. For more information, seeGoogle Cloud Armor Overview - POSTSets the service account on the instance
/projects/:project/zones/:zone/instances/:instance/setServiceAccount?requestId=stringSets the service account on the instance. For more information, readChanging the service account and access scopes for an instance. - PATCHSets the Shielded Instance integrity policy for an instance
/projects/:project/zones/:zone/instances/:instance/setShieldedInstanceIntegrityPolicy?requestId=stringSets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses… - POSTSets network tags
for the specified instance to the data included in the request.
/projects/:project/zones/:zone/instances/:instance/setTags?requestId=stringSets network tags for the specified instance to the data included in the request. - POSTSimulates a host maintenance event on a VM
/projects/:project/zones/:zone/instances/:instance/simulateMaintenanceEvent?requestId=string&withExtendedNotifications=trueSimulates a host maintenance event on a VM. For more information, see Simulate a host maintenance event. - POSTStarts an instance that was stopped using theinstances().stop
method
/projects/:project/zones/:zone/instances/:instance/start?requestId=stringStarts an instance that was stopped using theinstances().stop method. For more information, seeRestart an instance.
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://compute.googleapis.com/compute/v1- Authentication
- OAuth 2.0 (authorization code flow) with 6 scopes
An API key in the key query parameter - Operations
- 1025 operations on 751 pathsPOST 452GET 389DELETE 98PATCH 72PUT 14
- Main resources
- instances 51instanceGroupManagers 24regionInstanceGroupManagers 23routers 22networkFirewallPolicies 21disks 20firewallPolicies 18regionDisks 18regionNetworkFirewallPolicies 18backendServices 17
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Compute Engine API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Compute Engine API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 6 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves an aggregated list of accelerator types. To prevent failure, it is recommended that you set…” (GET /projects/:project/aggregated/acceleratorTypes?filter=string&includeAllScopes=true&maxResults=0&orderBy=string&pageToken=string&serviceProjectNumber=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Compute Engine API?
Creates and runs virtual machines on Google Cloud Platform. It is listed under Developer tools and has 1025 endpoints.
Who publishes the Compute Engine API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Compute Engine API?
Requests go to https://compute.googleapis.com/compute/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Compute Engine API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 6 scopes; an API key in the key query parameter.
How many endpoints does the Compute Engine API have?
1025 operations on 751 paths (452 POST, 389 GET, 98 DELETE, 72 PATCH, 14 PUT). The largest groups are instances, instanceGroupManagers, regionInstanceGroupManagers, routers. This listing's collection holds the first 400.
Is forking the Compute Engine API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.