REST Resource: httpsHealthChecks

Resource: HttpsHealthCheck

Represents a legacy HTTPS Health Check resource.

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.

For more information, seeHealth checks overview.

JSON representation
{"kind":string,"id":string,"creationTimestamp":string,"name":string,"description":string,"host":string,"requestPath":string,"port":integer,"checkIntervalSec":integer,"timeoutSec":integer,"unhealthyThreshold":integer,"healthyThreshold":integer,"selfLink":string}
Fields
kind

string

Type of the resource.

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.

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.

Methods

delete

 Deletes the specified HttpsHealthCheck resource.

get

 Returns the specified HttpsHealthCheck resource.

insert

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

list

 Retrieves the list of HttpsHealthCheck resources available to the specified project.

patch

 Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

update

 Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

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.