Method: networks.list

Retrieves the list of networks available to the specified project.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/networks

The URL usesgRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to theservice error catalog

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.

project

string

Project ID for this request.

Query parameters

Parameters
`maxResults`	`integer (uint32 format)` The maximum number of results per page that should be returned. If the number of available results is larger than`maxResults`, Compute Engine returns a`nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are`0` to`500`, inclusive. (Default:`500`)
`pageToken`	`string` Specifies a page token to use. Set`pageToken` to the`nextPageToken` returned by a previous list request to get the next page of results.
`filter`	`string` A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposalAIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either`=`,`!=`,`>`,`<`,`<=`,`>=` or`:`. For example, if you are filtering Compute Engine instances, you can exclude instances named`example-instance` by specifying`name != example-instance`. The`:` comparison can be used to test whether a key has been defined. For example, to find all objects with`owner` label use: `labels.owner:` You can also filter nested fields. For example, you could specify`scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based onresource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: `(scheduling.automaticRestart = true)(cpuPlatform = "Intel Skylake")` By default, each expression is an`AND` expression. However, you can include`AND` and`OR` expressions explicitly. For example: `(cpuPlatform = "Intel Skylake") OR(cpuPlatform = "Intel Broadwell") AND(scheduling.automaticRestart = true)` If you want to use a regular expression, use the`eq` (equal) or`ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literalfieldname eq 'single quoted literal'fieldname eq "double quoted literal"(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using GoogleRE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use`name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
`orderBy`	`string` Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using`orderBy="creationTimestamp desc"`. This sorts results based on the`creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by`name` or`creationTimestamp desc` is supported.
`returnPartialSuccess`	`boolean` Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.

Request body

The request body must be empty.

Response body

Contains a list of networks.

If successful, the response body contains data with the following structure:

JSON representation
{"kind":string,"id":string,"items":[{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"IPv4Range":string,"gatewayIPv4":string,"selfLink":string,"selfLinkWithId":string,"autoCreateSubnetworks":boolean,"subnetworks":[string],"peerings":[{"name":string,"network":string,"state":enum,"stateDetails":string,"autoCreateRoutes":boolean,"exportCustomRoutes":boolean,"importCustomRoutes":boolean,"exchangeSubnetRoutes":boolean,"exportSubnetRoutesWithPublicIp":boolean,"importSubnetRoutesWithPublicIp":boolean,"peerMtu":integer,"stackType":enum,"updateStrategy":enum,"connectionStatus":{"updateStrategy":enum,"trafficConfiguration":{"stackType":enum,"importCustomRoutesFromPeer":boolean,"exportCustomRoutesToPeer":boolean,"importSubnetRoutesWithPublicIpFromPeer":boolean,"exportSubnetRoutesWithPublicIpToPeer":boolean},"consensusState":{"deleteStatus":enum,"updateStatus":enum}}}],"routingConfig":{"routingMode":enum,"bgpBestPathSelectionMode":enum,"bgpAlwaysCompareMed":boolean,"bgpInterRegionCost":enum,"effectiveBgpAlwaysCompareMed":boolean,"effectiveBgpInterRegionCost":enum},"mtu":integer,"firewallPolicy":string,"networkFirewallPolicyEnforcementOrder":enum,"enableUlaInternalIpv6":boolean,"internalIpv6Range":string,"networkProfile":string,"params":{"resourceManagerTags":{string:string,...}}}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

JSON representation

{"kind":string,"id":string,"items":[{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"IPv4Range":string,"gatewayIPv4":string,"selfLink":string,"selfLinkWithId":string,"autoCreateSubnetworks":boolean,"subnetworks":[string],"peerings":[{"name":string,"network":string,"state":enum,"stateDetails":string,"autoCreateRoutes":boolean,"exportCustomRoutes":boolean,"importCustomRoutes":boolean,"exchangeSubnetRoutes":boolean,"exportSubnetRoutesWithPublicIp":boolean,"importSubnetRoutesWithPublicIp":boolean,"peerMtu":integer,"stackType":enum,"updateStrategy":enum,"connectionStatus":{"updateStrategy":enum,"trafficConfiguration":{"stackType":enum,"importCustomRoutesFromPeer":boolean,"exportCustomRoutesToPeer":boolean,"importSubnetRoutesWithPublicIpFromPeer":boolean,"exportSubnetRoutesWithPublicIpToPeer":boolean},"consensusState":{"deleteStatus":enum,"updateStatus":enum}}}],"routingConfig":{"routingMode":enum,"bgpBestPathSelectionMode":enum,"bgpAlwaysCompareMed":boolean,"bgpInterRegionCost":enum,"effectiveBgpAlwaysCompareMed":boolean,"effectiveBgpInterRegionCost":enum},"mtu":integer,"firewallPolicy":string,"networkFirewallPolicyEnforcementOrder":enum,"enableUlaInternalIpv6":boolean,"internalIpv6Range":string,"networkProfile":string,"params":{"resourceManagerTags":{string:string,...}}}],"nextPageToken":string,"selfLink":string,"warning":{"code":enum,"message":string,"data":[{"key":string,"value":string}]}}

Fields
`kind`	`string` [Output Only] Type of resource. Always`compute#networkList` for lists of networks.
`id`	`string` [Output Only] Unique identifier for the resource; defined by the server.
`items[]`	`object` A list of Network resources.
`items[].kind`	`string` [Output Only] Type of the resource. Always`compute#network` for networks.
`items[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`items[].creationTimestamp`	`string` [Output Only] Creation timestamp inRFC3339 text format.
`items[].name`	`string` Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.
`items[].description`	`string` An optional description of this resource. Provide this field when you create the resource.
`items[].IPv4Range (deprecated)`	`string` Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is aCIDR specification, for example:`192.168.0.0/16`. Provided by the client when the network is created.
`items[].gatewayIPv4`	`string` [Output Only] The gateway address for default routing out of the network, selected by Google Cloud.
`items[].selfLink`	`string` [Output Only] Server-defined URL for the resource.
`items[].selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`items[].autoCreateSubnetworks`	`boolean` Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in`auto` mode. When set to false, the VPC network is created in`custom` mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described inAuto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworksinsert method.
`items[].subnetworks[]`	`string` [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.
`items[].peerings[]`	`object` [Output Only] A list of network peerings for the resource.
`items[].peerings[].name`	`string` Name of this peering. Provided by the client when the peering is created. The name must comply withRFC1035. Specifically, the name must be 1-63 characters long and match regular expression`[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`items[].peerings[].network`	`string` The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.
`items[].peerings[].state`	`enum` [Output Only] State for the peering, either`ACTIVE` or`INACTIVE`. The peering is`ACTIVE` when there's a matching configuration in the peer network.
`items[].peerings[].stateDetails`	`string` [Output Only] Details about the current state of the peering.
`items[].peerings[].autoCreateRoutes`	`boolean` This field will be deprecated soon. Use the`exchangeSubnetRoutes` field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is`ACTIVE`.
`items[].peerings[].exportCustomRoutes`	`boolean` Whether to export the custom routes to peer network. The default value is false.
`items[].peerings[].importCustomRoutes`	`boolean` Whether to import the custom routes from peer network. The default value is false.
`items[].peerings[].exchangeSubnetRoutes`	`boolean` Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is`ACTIVE`.
`items[].peerings[].exportSubnetRoutesWithPublicIp`	`boolean` Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported.IPv4 special-use ranges are always exported to peers and are not controlled by this field.
`items[].peerings[].importSubnetRoutesWithPublicIp`	`boolean` Whether subnet routes with public IP range are imported. The default value is false.IPv4 special-use ranges are always imported from peers and are not controlled by this field.
`items[].peerings[].peerMtu`	`integer` [Output Only] Maximum Transmission Unit in bytes of the peer network.
`items[].peerings[].stackType`	`enum` Which IP version(s) of traffic and routes are allowed to be imported or exported between peer networks. The default value is IPV4_ONLY.
`items[].peerings[].updateStrategy`	`enum` The update strategy determines the semantics for updates and deletes to the peering connection configuration.
`items[].peerings[].connectionStatus`	`object` [Output Only] The effective state of the peering connection as a whole.
`items[].peerings[].connectionStatus.updateStrategy`	`enum` The update strategy determines the update/delete semantics for this peering connection.
`items[].peerings[].connectionStatus.trafficConfiguration`	`object` The active connectivity settings for the peering connection based on the settings of the network peerings.
`items[].peerings[].connectionStatus.trafficConfiguration.stackType`	`enum` Which IP version(s) of traffic and routes are being imported or exported between peer networks.
`items[].peerings[].connectionStatus.trafficConfiguration.importCustomRoutesFromPeer`	`boolean` Whether custom routes are being imported from the peer network.
`items[].peerings[].connectionStatus.trafficConfiguration.exportCustomRoutesToPeer`	`boolean` Whether custom routes are being exported to the peer network.
`items[].peerings[].connectionStatus.trafficConfiguration.importSubnetRoutesWithPublicIpFromPeer`	`boolean` Whether subnet routes with public IP ranges are being imported from the peer network.
`items[].peerings[].connectionStatus.trafficConfiguration.exportSubnetRoutesWithPublicIpToPeer`	`boolean` Whether subnet routes with public IP ranges are being exported to the peer network.
`items[].peerings[].connectionStatus.consensusState`	`object` The consensus state contains information about the status of update and delete for a consensus peering connection.
`items[].peerings[].connectionStatus.consensusState.deleteStatus`	`enum` The status of the delete request.
`items[].peerings[].connectionStatus.consensusState.updateStatus`	`enum` The status of the update request.
`items[].routingConfig`	`object` The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce.
`items[].routingConfig.routingMode`	`enum` The network-wide routing mode to use. If set to`REGIONAL`, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to`GLOBAL`, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.
`items[].routingConfig.bgpBestPathSelectionMode`	`enum` The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be`LEGACY` (default) or`STANDARD`.
`items[].routingConfig.bgpAlwaysCompareMed`	`boolean` Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.
`items[].routingConfig.bgpInterRegionCost`	`enum` Allows to define a preferred approach for handling inter-region cost in the selection process when using the`STANDARD` BGP best path selection algorithm. Can be`DEFAULT` or`ADD_COST_TO_MED`.
`items[].routingConfig.effectiveBgpAlwaysCompareMed`	`boolean` [Output Only] Effective value of the`bgpAlwaysCompareMed` field.
`items[].routingConfig.effectiveBgpInterRegionCost`	`enum` [Output Only] Effective value of the`bgpInterRegionCost` field.
`items[].mtu`	`integer` Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460.
`items[].firewallPolicy`	`string` [Output Only] URL of the firewall policy the network is associated with.
`items[].networkFirewallPolicyEnforcementOrder`	`enum` The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified.
`items[].enableUlaInternalIpv6`	`boolean` Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. .
`items[].internalIpv6Range`	`string` When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. .
`items[].networkProfile`	`string` A full or partial URL of the network profile to apply to this network. This field can be set only at resource creation time. For example, the following are valid URLs: `https://www.googleapis.com/compute/{apiVersion}/projects/{projectId}/global/networkProfiles/{network_profile_name}` `projects/{projectId}/global/networkProfiles/{network_profile_name}`
`items[].params`	`object` Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
`items[].params.resourceManagerTags`	`map (key: string, value: string)` Tag keys/values directly bound to this resource. Tag keys and values have the same definition asresource manager tags. The field is allowed for INSERT only. The keys/values to set on the resource should be specified in either ID { :} or Namespaced format { :}. For example the following are valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"} Note: * Invalid combinations of ID & namespaced format is not supported. For instance: {"123/environment" : "tagValues/444"} is invalid.
`nextPageToken`	`string` [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than`maxResults`, use the`nextPageToken` as a value for the query parameter`pageToken` in the next list request. Subsequent list requests will have their own`nextPageToken` to continue paging through the results.
`selfLink`	`string` [Output Only] Server-defined URL for this resource.
`warning`	`object` [Output Only] Informational warning message.
`warning.code`	`enum` [Output Only] A warning code, if applicable. For example, Compute Engine returns`NO_RESULTS_ON_PAGE` if there are no results in the response.
`warning.message`	`string` [Output Only] A human-readable description of the warning code.
`warning.data[]`	`object` [Output Only] Metadata about this warning in`key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warning.data[].key`	`string` [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be`scope` and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
`warning.data[].value`	`string` [Output Only] A warning data value corresponding to the key.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the followingIAM permissions:

compute.networks.list

To find predefined roles that contain those permissions, seeCompute Engine IAM Roles.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-18 UTC.

Movatterモバイル変換

Method: networks.list Stay organized with collections Save and categorize content based on your preferences.