vpnGateways.list of VPN connection for this VpnGateway.
result.vpnConnections[].peerExternalGateway
string
URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peerGcpGateway.
result.vpnConnections[].peerGcpGateway
string
URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peerGcpGateway.
result.vpnConnections[].tunnels[]
object
vpnGateways.list of VPN tunnels that are in this VPN connection.
The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or a Google Cloud VPN gateway.
result.vpnConnections[].tunnels[].tunnelUrl
string
URL reference to the VPN tunnel.
result.vpnConnections[].state
object
HighAvailabilityRequirementState for the VPN connection.
result.vpnConnections[].state.state
enum
Indicates the high availability requirement state for the VPN connection. Valid values areCONNECTION_REDUNDANCY_MET,CONNECTION_REDUNDANCY_NOT_MET.
result.vpnConnections[].state.unsatisfiedReason
enum
Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values isINCOMPLETE_TUNNELS_COVERAGE.
[[["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 webpage details how to retrieve the status of a specific VPN gateway using a \u003ccode\u003eGET\u003c/code\u003e request to the provided URL, which follows gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires three path parameters: \u003ccode\u003eproject\u003c/code\u003e, \u003ccode\u003eregion\u003c/code\u003e, and \u003ccode\u003evpnGateway\u003c/code\u003e, which specify the project, region, and the name of the VPN gateway to be queried, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty, meaning no data should be included in the request's body.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response body includes a JSON representation that provides details about the VPN connections, such as peer gateways, tunnels, and the high availability state, for the specified VPN gateway.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires specific OAuth scopes, including \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/compute\u003c/code\u003e, or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, as well as the \u003ccode\u003ecompute.vpnGateways.get\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: vpnGateways.getStatus\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.VpnGatewaysGetStatusResponse.SCHEMA_REPRESENTATION)\n - [JSON representation](#body.VpnGatewaysGetStatusResponse.SCHEMA_REPRESENTATION.resource.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the status for the specified VPN gateway.\n\n### HTTP request\n\n`GET https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus`\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\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.vpnGateways.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]
