Legacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks.
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.
host
string
The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
requestPath
string
The request path of the HTTPS health check request. The default value is "/". Must comply withRFC3986.
port
integer
The TCP port number for the HTTPS health check request. The default value is 443.
checkIntervalSec
integer
How often (in seconds) to send a health check. The default value is 5 seconds.
timeoutSec
integer
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.
unhealthyThreshold
integer
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
healthyThreshold
integer
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
selfLink
string
[Output Only] Server-defined URL for the resource.
[[["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 a specific HttpsHealthCheck resource 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 two path parameters: \u003ccode\u003eproject\u003c/code\u003e, the project ID, and \u003ccode\u003ehttpsHealthCheck\u003c/code\u003e, the name of the desired resource, and the request body should remain empty.\u003c/p\u003e\n"],["\u003cp\u003eThe response body will include data in a JSON format representing the HttpsHealthCheck, including fields like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003eport\u003c/code\u003e, and several timing and threshold parameters.\u003c/p\u003e\n"],["\u003cp\u003eLegacy HTTPS health checks are deprecated, and if using a target pool-based network load balancer, a legacy HTTP check must be used instead; for all other use-cases, non-legacy health checks should be used.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully retrieve the resource you need one of the following OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/compute.readonly\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/compute\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, in addition to the \u003ccode\u003ecompute.httpsHealthChecks.get\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: httpsHealthChecks.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.HttpsHealthCheck.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nReturns the specified HttpsHealthCheck resource.\n\n### HTTP request\n\n`GET https://compute.googleapis.com/compute/beta/projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}`\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 legacy HTTPS Health Check resource.\n\nLegacy HTTPS health checks have been deprecated. If you are using a target pool-based network load balancer, you must use a legacy HTTP (not HTTPS) health check. For all other load balancers, including backend service-based network load balancers, and for managed instance group auto-healing, you must use modern (non-legacy) health checks.\n\nFor more information, see [Health checks overview](/load-balancing/docs/health-check-concepts).\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.httpsHealthChecks.get`\n\nTo find predefined roles that contain those permissions, see [Compute Engine IAM Roles](/compute/docs/access/iam)."]]
