projects

Changed on

Creates a new Gateway in a given project and location.

post/v1/{+parent}/gateways

Request

  • Base URL: https://networkservices.googleapis.com
  • URL: https://networkservices.googleapis.com/v1/{+parent}/gateways
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

parentstring required

Required. The parent resource of the Gateway. Must be in the format projects/*/locations/*.

Query parameters

gatewayIdstring

Required. Short name of the Gateway resource to be created.

Request body

addressesstring[]

Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.

allPortsboolean

Optional. If true, the Gateway will listen on all ports. This is mutually exclusive with the ports field. This field only applies to gateways of type 'SECURE_WEB_GATEWAY'.

allowGlobalAccessboolean

Optional. If true, the gateway will allow traffic from clients outside of the region where the gateway is located. This field is configurable only for gateways of type SECURE_WEB_GATEWAY.

certificateUrlsstring[]

Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.

createTimestring google-datetime

Output only. The timestamp when the resource was created.

descriptionstring

Optional. A free-text description of the resource. Max length 1024 characters.

envoyHeaders'ENVOY_HEADERS_UNSPECIFIED' | 'NONE' | 'DEBUG_HEADERS'

Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.

gatewaySecurityPolicystring

Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: projects/*/locations/*/gatewaySecurityPolicies/swg-policy. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.

ipVersion'IP_VERSION_UNSPECIFIED' | 'IPV4' | 'IPV6'

Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.

labelsobject

Optional. Set of label tags associated with the Gateway resource.

namestring

Identifier. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/.

networkstring

Optional. The relative resource name identifying the VPC network that is using this configuration. For example: projects/*/global/networks/network-1. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.

portsinteger[]

Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.

routingMode'EXPLICIT_ROUTING_MODE' | 'NEXT_HOP_ROUTING_MODE'

Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.

scopestring

Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.

selfLinkstring

Output only. Server-defined URL of this resource

serverTlsPolicystring

Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.

subnetworkstring

Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: projects/*/regions/us-central1/subnetworks/network-1 Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".

type'TYPE_UNSPECIFIED' | 'OPEN_MESH' | 'SECURE_WEB_GATEWAY'

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

updateTimestring google-datetime

Output only. The timestamp when the resource was updated.

Response

Successful response

Changes

  • a5f7ebd10c85Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status