REST Resource: targetTcpProxies

Resource: TargetTcpProxy

Represents a Target TCP Proxy resource.

A target TCP proxy is a component of a Proxy Network Load Balancer. The forwarding rule references the target TCP proxy, and the target proxy then references a backend service. For more information, readProxy Network Load Balancer overview.

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"selfLink":string,"service":string,"proxyHeader":enum,"proxyBind":boolean,"region":string}
Fields
kind

string

[Output Only] Type of the resource. Alwayscompute#targetTcpProxy for target TCP proxies.

id

string (uint64 format)

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

creationTimestamp

string

[Output Only] Creation timestamp inRFC3339 text format.

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])? 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.

description

string

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

selfLink

string

[Output Only] Server-defined URL for the resource.

service

string

URL to the BackendService resource.

proxyHeader

enum

Specifies the type of proxy header to append before sending data to the backend, eitherNONE orPROXY_V1. The default isNONE.

proxyBind

boolean

This field only applies when the forwarding rule that references this target proxy has aloadBalancingScheme set toINTERNAL_SELF_MANAGED.

When this field is set totrue, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.

The default isfalse.

region

string

[Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.

Methods

aggregatedList

 Retrieves the list of all TargetTcpProxy resources, regional and global, available to the specified project.

delete

 Deletes the specified TargetTcpProxy resource.

get

 Returns the specified TargetTcpProxy resource.

insert

 Creates a TargetTcpProxy resource in the specified project using the data included in the request.

list

 Retrieves the list ofTargetTcpProxy resources available to the specified project.

setBackendService

 Changes the BackendService for TargetTcpProxy.

setProxyHeader

 Changes the ProxyHeaderType for TargetTcpProxy.

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-07-28 UTC.