Class HttpCheck (2.14.2)

HttpCheck(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information involved in an HTTP/HTTPS Uptime check request.


The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
use_ssl bool
If true, use HTTPS instead of HTTP to run the check.
path str
Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
port int
Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
The authentication information. Optional when creating an HTTP check; defaults to empty.
mask_headers bool
Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with ******.
headers MutableMapping[str, str]
The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
validate_ssl bool
Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is false, setting validate_ssl to true has no effect.
body bytes
The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".



BasicAuthentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication <>__ is supported in Uptime checks.



Header options corresponding to the content type of a HTTP request body.

Values: TYPE_UNSPECIFIED (0): No content type specified. URL_ENCODED (1): body is in URL-encoded form. Equivalent to setting the Content-Type to application/x-www-form-urlencoded in the HTTP request.


HeadersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.



The HTTP request method options.

Values: METHOD_UNSPECIFIED (0): No request method specified. GET (1): GET request. POST (2): POST request.