REST Resource: forwardingRules

Resource: ForwardingRule

Represents a Forwarding Rule resource.

Forwarding rule resources in Google Cloud can be either regional or global in scope:

A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway).

For more information, read Forwarding rule concepts and Using protocol forwarding.

JSON representation
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "IPAddress": string,
  "IPProtocol": enum,
  "portRange": string,
  "ports": [
  "target": string,
  "selfLink": string,
  "loadBalancingScheme": enum,
  "subnetwork": string,
  "network": string,
  "backendService": string,
  "serviceDirectoryRegistrations": [
      "namespace": string,
      "service": string,
      "serviceDirectoryRegion": string
  "serviceLabel": string,
  "serviceName": string,
  "networkTier": enum,
  "labels": {
    string: string,
  "labelFingerprint": string,
  "ipVersion": enum,
  "fingerprint": string,
  "allPorts": boolean,
  "allowGlobalAccess": boolean,
  "metadataFilters": [
      "filterMatchCriteria": enum,
      "filterLabels": [
          "name": string,
          "value": string
  "isMirroringCollector": boolean,
  "sourceIpRanges": [
  "pscConnectionId": string,
  "pscConnectionStatus": enum,
  "kind": string

string (uint64 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])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.



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



[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.



IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.

If you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:

  • IPv4 dotted decimal, as in
  • Full URL, as in
  • Partial URL or by name, as in:
    • projects/projectId/regions/region/addresses/address-name
    • regions/region/addresses/address-name
    • global/addresses/address-name
    • address-name

The loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, see IP address specifications.

Must be set to when the target is targetGrpcProxy that has validateForProxyless field set to true.

For Private Service Connect forwarding rules that forward traffic to Google APIs, IP address must be provided.



The IP protocol to which this rule applies.

For protocol forwarding, valid options are TCP, UDP,