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.
region
string
[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
network
string
URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
tunnels[]
string
[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using thecompute.vpntunnels.insertmethod and associated with a VPN gateway.
status
enum
[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
selfLink
string
[Output Only] Server-defined URL for the resource.
forwardingRules[]
string
[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created usingcompute.forwardingRules.insertand associated with a VPN gateway.
labels
map (key: string, value: string)
Labels for this resource. These can only be added or modified by thesetLabelsmethod. Each label key/value pair must comply withRFC1035. Label values may be empty.
A fingerprint for the labels being applied to this TargetVpnGateway, 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 error412 conditionNotMet.
To see the latest fingerprint, make aget()request to retrieve a TargetVpnGateway.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThis page details how to retrieve information about a specific Target VPN Gateway resource using a GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL requires the \u003ccode\u003eproject\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003etargetVpnGateway\u003c/code\u003e as path parameters, which define the scope and target of the request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the successful response body will contain the Target VPN Gateway's details, structured in a JSON format that includes fields like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003estatus\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires one of several OAuth scopes, such as \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e, or the \u003ccode\u003ecompute.targetVpnGateways.get\u003c/code\u003e IAM permission.\u003c/p\u003e\n"],["\u003cp\u003eThe Target VPN Gateway resource represents a Classic Cloud VPN Gateway, and more information about them can be found in the Cloud VPN Overview.\u003c/p\u003e\n"]]],[],null,["# Method: targetVpnGateways.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.TargetVpnGateway.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the specified target VPN gateway.\n\n### HTTP request\n\n`GET https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRepresents a Target VPN Gateway resource.\n\nThe target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the [the Cloud VPN Overview](https://cloud.google.com/network-connectivity/docs/vpn/concepts/overview).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/compute.readonly`\n- `\n https://www.googleapis.com/auth/compute`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nIn addition to any permissions specified on the fields above, authorization requires one or more of the following [IAM](https://cloud.google.com/iam/docs/) permissions:\n\n- `compute.targetVpnGateways.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]
