Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)



API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Addresses
  2. BackendServices
  3. Disks
  4. DiskTypes
  5. Firewalls
  6. ForwardingRules
  7. GlobalForwardingRules
  8. GlobalOperations
  9. HttpHealthChecks
  10. Licenses
  11. Images
  12. Instances
  13. MachineTypes
  14. Networks
  15. Projects
  16. RegionOperations
  17. Regions
  18. Routes
  19. Snapshots
  20. TargetHttpProxies
  21. TargetInstances
  22. TargetPools
  23. UrlMaps
  24. ZoneOperations
  25. Zones

Addresses

For Addresses Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/addresses Retrieves the list of addresses grouped by scope.
delete DELETE  / project /regions/ region /addresses/ address Deletes the specified address resource.
get GET  / project /regions/ region /addresses/ address Returns the specified address resource.
insert POST  / project /regions/ region /addresses Creates an address resource in the specified project using the data included in the request.
list GET  / project /regions/ region /addresses Retrieves the list of address resources contained within the specified region.

Disks

For Disks Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/disks Retrieves the list of disks grouped by scope.
createSnapshot POST  / project /zones/ zone /disks/ disk /createSnapshot Creates a snapshot of this disk.
delete DELETE  / project /zones/ zone /disks/ disk Deletes the specified persistent disk resource.
get GET  / project /zones/ zone /disks/ disk Returns the specified persistent disk resource.
insert POST  / project /zones/ zone /disks Creates a persistent disk resource in the specified project using the data included in the request.
list GET  / project /zones/ zone /disks Retrieves the list of persistent disk resources contained within the specified zone.

Firewalls

For Firewalls Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/firewalls/ firewall Deletes the specified firewall resource.
get GET  / project /global/firewalls/ firewall Returns the specified firewall resource.
insert POST  / project /global/firewalls Creates a firewall resource in the specified project using the data included in the request.
list GET  / project /global/firewalls Retrieves the list of firewall resources available to the specified project.
patch PATCH  / project /global/firewalls/ firewall Updates the specified firewall resource with the data included in the request. This method supports patch semantics.
update PUT  / project /global/firewalls/ firewall Updates the specified firewall resource with the data included in the request.

ForwardingRules

For ForwardingRules Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/forwardingRules Retrieves the list of forwarding rules grouped by scope.
delete DELETE  / project /regions/ region /forwardingRules/ forwardingRule Deletes the specified ForwardingRule resource.
get GET  / project /regions/ region /forwardingRules/ forwardingRule Returns the specified ForwardingRule resource.
insert POST  / project /regions/ region /forwardingRules Creates a ForwardingRule resource in the specified project and region using the data included in the request.
list GET  / project /regions/ region /forwardingRules Retrieves the list of ForwardingRule resources available to the specified project and region.
setTarget POST  / project /regions/ region /forwardingRules/ forwardingRule /setTarget Changes target url for forwarding rule.

GlobalOperations

For GlobalOperations Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/operations Retrieves the list of all operations grouped by scope.
delete DELETE  / project /global/operations/ operation Deletes the specified operation resource.
get GET  / project /global/operations/ operation Retrieves the specified operation resource.
list GET  / project /global/operations Retrieves the list of operation resources contained within the specified project.

HttpHealthChecks

For HttpHealthChecks Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/httpHealthChecks/ httpHealthCheck Deletes the specified HttpHealthCheck resource.
get GET  / project /global/httpHealthChecks/ httpHealthCheck Returns the specified HttpHealthCheck resource.
insert POST  / project /global/httpHealthChecks Creates a HttpHealthCheck resource in the specified project using the data included in the request.
list GET  / project /global/httpHealthChecks Retrieves the list of HttpHealthCheck resources available to the specified project.
patch PATCH  / project /global/httpHealthChecks/ httpHealthCheck Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports patch semantics.
update PUT  / project /global/httpHealthChecks/ httpHealthCheck Updates a HttpHealthCheck resource in the specified project using the data included in the request.

Licenses

For Licenses Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
get GET  / project /global/licenses/ license Returns the specified License resource.

Images

For Images Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/images/ image Deletes the specified image resource.
deprecate POST  / project /global/images/ image /deprecate Sets the deprecation status of an image. If no message body is given, clears the deprecation status instead.
get GET  / project /global/images/ image Returns the specified image resource.
insert POST  / project /global/images Creates an image resource in the specified project using the data included in the request.
list GET  / project /global/images Retrieves the list of image resources available to the specified project.

Instances

For Instances Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
addAccessConfig POST  / project /zones/ zone /instances/ instance /addAccessConfig Adds an access config to an instance's network interface.

Required query parameters: networkInterface
aggregatedList GET  / project /aggregated/instances Retrieves the list of Instance resources across all available zones.
attachDisk POST  / project /zones/ zone /instances/ instance /attachDisk Attaches a Persistent Disk resource to an instance.


You can also attach one persistent disk to multiple instances in read-only mode; it is not possible to attach one persistent disk to multiple instances in read-write mode.
delete DELETE  / project /zones/ zone /instances/ instance Deletes the specified instance resource.
deleteAccessConfig POST  / project /zones/ zone /instances/ instance /deleteAccessConfig Deletes an access config from an instance's network interface.

Required query parameters: accessConfig , networkInterface
detachDisk POST  / project /zones/ zone /instances/ instance /detachDisk Detaches a disk from an instance.

Required query parameters: deviceName
get GET  / project /zones/ zone /instances/ instance Returns the specified instance resource.
getSerialPortOutput GET  / project /zones/ zone /instances/ instance /serialPort Returns the specified instance's serial port output.
insert POST  / project /zones/ zone /instances Creates an instance resource in the specified project using the data included in the request.
list GET  / project /zones/ zone /instances Retrieves the list of instance resources contained within the specified zone.
reset POST  / project /zones/ zone /instances/ instance /reset Performs a hard reset on the instance.
setDiskAutoDelete POST  / project /zones/ zone /instances/ instance /setDiskAutoDelete Sets the auto-delete flag for a disk attached to an instance

Required query parameters: autoDelete , deviceName
setMetadata POST  / project /zones/ zone /instances/ instance /setMetadata Sets metadata for the specified instance to the data included in the request.
setScheduling POST  / project /zones/ zone /instances/ instance /setScheduling Sets an instance's scheduling options.
setTags POST  / project /zones/ zone /instances/ instance /setTags Sets tags for the specified instance to the data included in the request.

MachineTypes

For MachineTypes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/machineTypes Retrieves the list of machine type resources grouped by scope.
get GET  / project /zones/ zone /machineTypes/ machineType Returns the specified machine type resource.
list GET  / project /zones/ zone /machineTypes Retrieves the list of machine type resources available to the specified project.

Networks

For Networks Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/networks/ network Deletes the specified network resource.
get GET  / project /global/networks/ network Returns the specified network resource.
insert POST  / project /global/networks Creates a network resource in the specified project using the data included in the request.
list GET  / project /global/networks Retrieves the list of network resources available to the specified project.

Projects

For Projects Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
get GET  / project Returns the specified project resource.
setCommonInstanceMetadata POST  / project /setCommonInstanceMetadata Sets metadata common to all instances within the specified project using the data included in the request.
setUsageExportBucket POST  / project /setUsageExportBucket Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.

RegionOperations

For RegionOperations Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /regions/ region /operations/ operation Deletes the specified region-specific operation resource.
get GET  / project /regions/ region /operations/ operation Retrieves the specified region-specific operation resource.
list GET  / project /regions/ region /operations Retrieves the list of operation resources contained within the specified region.

Regions

For Regions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
get GET  / project /regions/ region Returns the specified region resource.
list GET  / project /regions Retrieves the list of region resources available to the specified project.

Routes

For Routes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/routes/ route Deletes the specified route resource.
get GET  / project /global/routes/ route Returns the specified route resource.
insert POST  / project /global/routes Creates a route resource in the specified project using the data included in the request.
list GET  / project /global/routes Retrieves the list of route resources available to the specified project.

Snapshots

For Snapshots Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/snapshots/ snapshot Deletes the specified persistent disk snapshot resource.
get GET  / project /global/snapshots/ snapshot Returns the specified persistent disk snapshot resource.
list GET  / project /global/snapshots Retrieves the list of persistent disk snapshot resources contained within the specified project.

TargetPools

For TargetPools Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
addHealthCheck POST  / project /regions/ region /targetPools/ targetPool /addHealthCheck Adds health check URL to targetPool.
addInstance POST  / project /regions/ region /targetPools/ targetPool /addInstance Adds instance url to targetPool.
aggregatedList GET  / project /aggregated/targetPools Retrieves the list of target pools grouped by scope.
delete DELETE  / project /regions/ region /targetPools/ targetPool Deletes the specified TargetPool resource.
get GET  / project /regions/ region /targetPools/ targetPool Returns the specified TargetPool resource.
getHealth POST  / project /regions/ region /targetPools/ targetPool /getHealth Gets the most recent health check results for each IP for the given instance that is referenced by given TargetPool.
insert POST  / project /regions/ region /targetPools Creates a TargetPool resource in the specified project and region using the data included in the request.
list GET  / project /regions/ region /targetPools Retrieves the list of TargetPool resources available to the specified project and region.
removeHealthCheck POST  / project /regions/ region /targetPools/ targetPool /removeHealthCheck Removes health check URL from targetPool.
removeInstance POST  / project /regions/ region /targetPools/ targetPool /removeInstance Removes instance URL from targetPool.
setBackup POST  / project /regions/ region /targetPools/ targetPool /setBackup Changes backup pool configurations. For more information, see backup pools.

ZoneOperations

For ZoneOperations Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /zones/ zone /operations/ operation Deletes the specified zone-specific operation resource.
get GET  / project /zones/ zone /operations/ operation Retrieves the specified zone-specific operation resource.
list GET  / project /zones/ zone /operations Retrieves the list of operation resources contained within the specified zone.

Zones

For Zones Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
get GET  / project /zones/ zone Returns the specified zone resource.
list GET  / project /zones Retrieves the list of zone resources available to the specified project.

TargetInstances

For TargetInstances Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/targetInstances Retrieves the list of target instances grouped by scope.
delete DELETE  / project /zones/ zone /targetInstances/ targetInstance Deletes the specified TargetInstance resource.
get GET  / project /zones/ zone /targetInstances/ targetInstance Returns the specified TargetInstance resource.
insert POST  / project /zones/ zone /targetInstances Creates a TargetInstance resource in the specified project and zone using the data included in the request.
list GET  / project /zones/ zone /targetInstances Retrieves the list of TargetInstance resources available to the specified project and zone.

BackendServices

For BackendServices Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/backendServices/ backendService Deletes the specified BackendService resource.
get GET  / project /global/backendServices/ backendService Returns the specified BackendService resource.
getHealth POST  / project /global/backendServices/ backendService /getHealth Gets the most recent health check results for this BackendService.
insert POST  / project /global/backendServices Creates a BackendService resource in the specified project using the data included in the request.
list GET  / project /global/backendServices Retrieves the list of BackendService resources available to the specified project.
patch PATCH  / project /global/backendServices/ backendService Update the entire content of the BackendService resource. This method supports patch semantics.
update PUT  / project /global/backendServices/ backendService Update the entire content of the BackendService resource.

DiskTypes

For DiskTypes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
aggregatedList GET  / project /aggregated/diskTypes Retrieves the list of disk type resources grouped by scope.
get GET  / project /zones/ zone /diskTypes/ diskType Returns the specified disk type resource.
list GET  / project /zones/ zone /diskTypes Retrieves the list of disk type resources available to the specified project.

GlobalForwardingRules

For GlobalForwardingRules Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/forwardingRules/ forwardingRule Deletes the specified ForwardingRule resource.
get GET  / project /global/forwardingRules/ forwardingRule Returns the specified ForwardingRule resource.
insert POST  / project /global/forwardingRules Creates a ForwardingRule resource in the specified project and region using the data included in the request.
list GET  / project /global/forwardingRules Retrieves the list of ForwardingRule resources available to the specified project.
setTarget POST  / project /global/forwardingRules/ forwardingRule /setTarget Changes target url for forwarding rule.

TargetHttpProxies

For TargetHttpProxies Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/targetHttpProxies/ targetHttpProxy Deletes the specified TargetHttpProxy resource.
get GET  / project /global/targetHttpProxies/ targetHttpProxy Returns the specified TargetHttpProxy resource.
insert POST  / project /global/targetHttpProxies Creates a TargetHttpProxy resource in the specified project using the data included in the request.
list GET  / project /global/targetHttpProxies Retrieves the list of TargetHttpProxy resources available to the specified project.
setUrlMap POST  / project /targetHttpProxies/ targetHttpProxy /setUrlMap Changes the URL map for TargetHttpProxy.

UrlMaps

For UrlMaps Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/compute/v1/projects, unless otherwise noted
delete DELETE  / project /global/urlMaps/ urlMap Deletes the specified UrlMap resource.
get GET  / project /global/urlMaps/ urlMap Returns the specified UrlMap resource.
insert POST  / project /global/urlMaps Creates a UrlMap resource in the specified project using the data included in the request.
list GET  / project /global/urlMaps Retrieves the list of UrlMap resources available to the specified project.
patch PATCH  / project /global/urlMaps/ urlMap Update the entire content of the UrlMap resource. This method supports patch semantics.
update PUT  / project /global/urlMaps/ urlMap Update the entire content of the UrlMap resource.
validate POST  / project /global/urlMaps/ urlMap /validate Run static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License , and code samples are licensed under the Apache 2.0 License . For details, see our Site Policies .

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.