--- title: "PUT /projects/{project}/regions/{region}/healthChecks/{healthCheck}" method: PUT path: "/projects/{project}/regions/{region}/healthChecks/{healthCheck}" tags: ["regionHealthChecks"] --- # PUT /projects/{project}/regions/{region}/healthChecks/{healthCheck} `PUT /projects/{project}/regions/{region}/healthChecks/{healthCheck}` ## Request - Base URL: `https://compute.googleapis.com/compute/v1` - URL: `https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/healthChecks/{healthCheck}` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/compute` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/compute` Updates a HealthCheck resource in the specified project using the data included in the request. ## Path parameters - `project` string, required - `region` string, required - `healthCheck` string, required ## Query parameters - `requestId` string ## Request body - HealthCheck: Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) * [Global](/compute/docs/reference/rest/v1/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** Health check requirements vary depending on the type of load balancer. For details about the type of health check supported for each load balancer and corresponding backend type, see Health checks overview: Load balancer guide. **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, seeHealth checks overview. - `checkIntervalSec` integer: How often (in seconds) to send a health check. The default value is 5 seconds. - `creationTimestamp` string: Output only. [Output Only] Creation timestamp in3339 text format. - `description` string: An optional description of this resource. Provide this property when you create the resource. - `grpcHealthCheck` GRPCHealthCheck - `grpcServiceName` string: The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. - `port` integer: The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `grpcTlsHealthCheck` GRPCTLSHealthCheck - `grpcServiceName` string: The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII. - `port` integer: The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `healthyThreshold` integer: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. - `http2HealthCheck` HTTP2HealthCheck - `host` string: The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest - `port` integer: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `proxyHeader` 'NONE' | 'PROXY_V1': Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - `requestPath` string: The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986. - `response` string: Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http - `httpHealthCheck` HTTPHealthCheck - `host` string: The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest - `port` integer: The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `proxyHeader` 'NONE' | 'PROXY_V1': Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - `requestPath` string: The request path of the HTTP health check request. The default value is/. Must comply withRFC3986. - `response` string: Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http - `httpsHealthCheck` HTTPSHealthCheck - `host` string: The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest - `port` integer: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `proxyHeader` 'NONE' | 'PROXY_V1': Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - `requestPath` string: The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986. - `response` string: Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http - `id` string, uint64: [Output Only] The unique identifier for the resource. This identifier is defined by the server. - `kind` string: Output only. Type of the resource. - `logConfig` HealthCheckLogConfig: Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. - `enable` boolean: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. - `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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. - `region` string: Output only. [Output Only] Region where the health check resides. Not applicable to global health checks. - `selfLink` string: [Output Only] Server-defined URL for the resource. - `sourceRegions` string[]: The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, GRPC, and GRPC_WITH_TLS protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. - `sslHealthCheck` SSLHealthCheck - `port` integer: The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `proxyHeader` 'NONE' | 'PROXY_V1': Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - `request` string: Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake. - `response` string: Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp - `tcpHealthCheck` TCPHealthCheck - `port` integer: The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through65535. - `portName` string: Not supported. - `portSpecification` 'USE_FIXED_PORT' | 'USE_NAMED_PORT' | 'USE_SERVING_PORT': Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using theport field in the health check. Supported by backend services for passthrough load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for passthrough load balancers. Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service's named port in the instance group's list of named ports. - `proxyHeader` 'NONE' | 'PROXY_V1': Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. - `request` string: Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection. - `response` string: Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp - `timeoutSec` integer: How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. - `type` 'GRPC' | 'GRPC_WITH_TLS' | 'HTTP' | 'HTTP2' | 'HTTPS' | 'INVALID' | 'SSL' | 'TCP': Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2, GRPC or GRPC_WITH_TLS. Exactly one of the protocol-specific health check fields must be specified, which must match type field. - `unhealthyThreshold` integer: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. ## Response `200` Successful response - Operation: Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, readHandling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. - `clientOperationId` string: [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. - `creationTimestamp` string: [Deprecated] This field is deprecated. - `description` string: [Output Only] A textual description of the operation, which is set when the operation is created. - `endTime` string: [Output Only] The time that this operation was completed. This value is inRFC3339 text format. - `error` object: [Output Only] If errors are generated during processing of the operation, this field will be populated. - `errors` object[]: [Output Only] The array of errors encountered while processing this operation. - `code` string: [Output Only] The error type identifier for this error. - `errorDetails` object[]: [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - `errorInfo` ErrorInfo: Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } - `domain` string: The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". - `metadatas` object: Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. - `reason` string: The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. - `help` Help: Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. - `links` HelpLink[]: URL(s) pointing to additional information on handling the current error. - `description` string: Describes what the link offers. - `url` string: The URL of the link. - `localizedMessage` LocalizedMessage: Provides a localized error message that is safe to return to the user which can be attached to an RPC error. - `locale` string: The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" - `message` string: The localized error message in the above locale. - `quotaInfo` QuotaExceededInfo: Additional details for quota exceeded error for resource quota. - `dimensions` object: The map holding related quota dimensions. - `futureLimit` number, double: Future quota limit being rolled out. The limit's unit depends on the quota type or metric. - `limit` number, double: Current effective quota limit. The limit's unit depends on the quota type or metric. - `limitName` string: The name of the quota limit. - `metricName` string: The Compute Engine quota metric name. - `rolloutStatus` 'IN_PROGRESS' | 'ROLLOUT_STATUS_UNSPECIFIED': Rollout status of the future quota limit. - `location` string: [Output Only] Indicates the field in the request that caused the error. This property is optional. - `message` string: [Output Only] An optional, human-readable error message. - `getHealthOperationMetadata` GetHealthOperationMetadata: Metadata for GetHealth operations. - `healthInfo` GetHealthOperationMetadataHealthInfo: Health information. - `availabilitySloStatus` 'AVAILABILITY_SLO_STATUS_IN_SLO' | 'AVAILABILITY_SLO_STATUS_OUT_OF_SLO' | 'AVAILABILITY_SLO_STATUS_SLO_UNKNOWN' | 'AVAILABILITY_SLO_STATUS_UNSPECIFIED': Output only. The availability SLO status. - `healthStatus` 'HEALTH_STATUS_HEALTHY' | 'HEALTH_STATUS_UNHEALTHY' | 'HEALTH_STATUS_UNSPECIFIED': Output only. The health status. - `repairCategory` 'REPAIR_CATEGORY_CRITICAL_FAILURE' | 'REPAIR_CATEGORY_EMERGENT_MAINTENANCE' | 'REPAIR_CATEGORY_PLANNED_MAINTENANCE' | 'REPAIR_CATEGORY_UNSPECIFIED' | 'REPAIR_CATEGORY_USER_REPORTED_FAULT': Output only. The repair category. - `unhealthyReason` 'UNHEALTHY_REASON_PENDING_USER_APPROVAL' | 'UNHEALTHY_REASON_REPAIRING' | 'UNHEALTHY_REASON_UNSCHEDULABLE' | 'UNHEALTHY_REASON_UNSPECIFIED': Output only. The reason for unhealthy status. - `updateTime` string, google-datetime: Output only. The time when health info was updated. - `getVersionOperationMetadata` GetVersionOperationMetadata - `inlineSbomInfo` GetVersionOperationMetadataSbomInfo - `currentComponentVersions` object: A mapping of components to their currently-applied versions or other appropriate identifiers. - `targetComponentVersions` object: A mapping of components to their target versions or other appropriate identifiers. - `httpErrorMessage` string: [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. - `httpErrorStatusCode` integer: [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. - `id` string, uint64: [Output Only] The unique identifier for the operation. This identifier is defined by the server. - `insertTime` string: [Output Only] The time that this operation was requested. This value is inRFC3339 text format. - `instancesBulkInsertOperationMetadata` InstancesBulkInsertOperationMetadata - `perLocationStatus` object: Status information per location (location name is key). Example key: zones/us-central1-a - `kind` string: Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - `name` string: [Output Only] Name of the operation. - `operationGroupId` string: Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. - `operationType` string: [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. - `progress` integer: [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. - `region` string: [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. - `selfLink` string: [Output Only] Server-defined URL for the resource. - `setCommonInstanceMetadataOperationMetadata` SetCommonInstanceMetadataOperationMetadata - `clientOperationId` string: [Output Only] The client operation id. - `perLocationOperations` object: [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a - `startTime` string: [Output Only] The time that this operation was started by the server. This value is inRFC3339 text format. - `status` 'DONE' | 'PENDING' | 'RUNNING': [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. - `statusMessage` string: [Output Only] An optional textual description of the current status of the operation. - `targetId` string, uint64: [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. - `targetLink` string: [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from. - `user` string: [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. - `warnings` object[]: [Output Only] If warning messages are generated during processing of the operation, this field will be populated. - `code` 'CLEANUP_FAILED' | 'DEPRECATED_RESOURCE_USED' | 'DEPRECATED_TYPE_USED' | 'DISK_SIZE_LARGER_THAN_IMAGE_SIZE' | 'EXPERIMENTAL_TYPE_USED' | 'EXTERNAL_API_WARNING' | 'FIELD_VALUE_OVERRIDEN' | 'INJECTED_KERNELS_DEPRECATED' | 'INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB' | 'LARGE_DEPLOYMENT_WARNING' | 'LIST_OVERHEAD_QUOTA_EXCEED' | 'MISSING_TYPE_DEPENDENCY' | 'NEXT_HOP_ADDRESS_NOT_ASSIGNED' | 'NEXT_HOP_CANNOT_IP_FORWARD' | 'NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE' | 'NEXT_HOP_INSTANCE_NOT_FOUND' | 'NEXT_HOP_INSTANCE_NOT_ON_NETWORK' | 'NEXT_HOP_NOT_RUNNING' | 'NOT_CRITICAL_ERROR' | 'NO_RESULTS_ON_PAGE' | 'PARTIAL_SUCCESS' | 'QUOTA_INFO_UNAVAILABLE' | 'REQUIRED_TOS_AGREEMENT' | 'RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING' | 'RESOURCE_NOT_DELETED' | 'SCHEMA_VALIDATION_IGNORED' | 'SINGLE_INSTANCE_PROPERTY_TEMPLATE' | 'UNDECLARED_PROPERTIES' | 'UNREACHABLE': [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. - `data` object[]: [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }] - `key` string: [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). - `value` string: [Output Only] A warning data value corresponding to the key. - `message` string: [Output Only] A human-readable description of the warning code. - `zone` string: [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. ## Changes - **2026-10-30** `8b85e897d3dc`: 4 info - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c` - **2026-10-23** `48929bf89eeb`: 4 info - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c` - **2026-10-10** `aca8b5925289`: 2 breaking, 4 info - removed the request body - removed the media type `*/*` for the response with the status `200` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c` - …2 more - …earlier changes not shown [Operation history](https://skmtc.dev/google/apis/compute/changes/projects/:project/regions/:region/healthChecks/:healthCheck/put.md) --- [API](https://skmtc.dev/google/apis/compute.md) - [All operations](https://skmtc.dev/google/apis/compute/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/compute/revisions/8b85e897d3dc?raw)