REST Resource: addresses

Resource: Address

Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.

Use global internal addresses for reserved peering network range.

Use regional external addresses for the following resources:

  • External IP addresses for VM instances
  • Regional external forwarding rules
  • Cloud NAT external IP addresses
  • GFE based LBs in Standard Tier
  • Network LBs in Premium or Standard Tier
  • Cloud VPN gateways (both Classic and HA)

Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:

  • Internal IP addresses for VM instances
  • Alias IP ranges of VM instances (/32 only)
  • Regional internal forwarding rules
  • Internal TCP/UDP load balancer addresses
  • Internal HTTP(S) load balancer addresses
  • Cloud DNS inbound forwarding IP addresses

For more information, read reserved IP address.

JSON representation
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "address": string,
  "prefixLength": integer,
  "status": enum,
  "region": string,
  "selfLink": string,
  "users": [
  "networkTier": enum,
  "labels": {
    string: string,
  "labelFingerprint": string,
  "ipVersion": enum,
  "addressType": enum,
  "purpose": enum,
  "subnetwork": string,
  "network": string,
  "kind": string

string (fixed64 format)

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



[Output Only] Creation timestamp in RFC3339 text format.



Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.



An optional description of this resource. Provide this field when you create the resource.



The static IP address represented by this resource.



The prefix length if the resource reprensents an IP range.



[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.



[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.



[Output Only] The URLs of the resources that are using this address.



This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.

If this field is not specified, it is assumed to be PREMIUM.


map (key: string, value: string)

Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.


string (bytes format)

A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an Address.

A base64-encoded string.



The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.



The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.



The purpose of this resource, which can be one of the following values:

  • GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
  • DNS_RESOLVER for a DNS resolver address in a subnetwork
  • VPC_PEERING for addresses that are reserved for VPC peer networks.
  • NAT_AUTO for addresses that are external IP addresses automatically reserved for Cloud NAT.



The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.



The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.



[Output Only] Type of the resource. Always compute#address for addresses.



Retrieves an aggregated list of addresses.


Deletes the specified address resource.


Returns the specified address resource.


Creates an address resource in the specified project by using the data included in the request.


Retrieves a list of addresses contained within the specified region.


Sets the labels on an Address.


Returns permissions that a caller has on the specified resource.
Was this page helpful? Let us know how we did:

Send feedback about...

Compute Engine: Virtual Machines (VMs)