REST Resource: projects.uptimeCheckConfigs

Resource: UptimeCheckConfig

This message configures which resources and services to monitor for availability.

JSON representation 
{
  "name": string,
  "displayName": string,
  "period": string,
  "timeout": string,
  "contentMatchers": [
    {
      object (ContentMatcher)
    }
  ],
  "selectedRegions": [
    enum (UptimeCheckRegion)
  ],
  "isInternal": boolean,
  "internalCheckers": [
    {
      object (InternalChecker)
    }
  ],

  // Union field resource can be only one of the following:
  "monitoredResource": {
    object (MonitoredResource)
  },
  "resourceGroup": {
    object (ResourceGroup)
  }
  // End of list of possible types for union field resource.

  // Union field check_request_type can be only one of the following:
  "httpCheck": {
    object (HttpCheck)
  },
  "tcpCheck": {
    object (TcpCheck)
  }
  // End of list of possible types for union field check_request_type.
}
Fields
name

string

A unique resource name for this Uptime check configuration. The format is:

projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.
displayName

string

A human-friendly name for the Uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.
period

string (Duration format)

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.
timeout

string (Duration format)

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
contentMatchers[]

object (ContentMatcher)

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the contentMatchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
selectedRegions[]

enum (UptimeCheckRegion)

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.
isInternal
(deprecated)

boolean

If this is true, then checks are made only from the 'internalCheckers'. If it is false, then checks are made only from the 'selectedRegions'. It is an error to provide 'selectedRegions' when isInternal is true, or to provide 'internalCheckers' when isInternal is false.
internalCheckers[]
(deprecated)

object (InternalChecker)

The internal checkers that this check will egress from. If isInternal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
Union field resource. The resource the check is checking. Required. resource can be only one of the following:
monitoredResource

object (MonitoredResource)

The monitored resource associated with the configuration. The following monitored resource types are supported for Uptime checks: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer
resourceGroup

object (ResourceGroup)

The group resource associated with the configuration.
Union field check_request_type. The type of Uptime check request. check_request_type can be only one of the following:
httpCheck

object (HttpCheck)

Contains information needed to make an HTTP or HTTPS check.
tcpCheck

object (TcpCheck)

Contains information needed to make a TCP check.

MonitoredResource

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone":

{ "type": "gce_instance",
  "labels": { "instance_id": "12345678901234",
              "zone": "us-central1-a" }}
JSON representation 
{
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
type

string

Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types and Logging resource types.
labels

map (key: string, value: string)

Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ResourceGroup

The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.

JSON representation 
{
  "groupId": string,
  "resourceType": enum (GroupResourceType)
}
Fields
groupId

string

The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID]/groups/[GROUP_ID].
resourceType

enum (GroupResourceType)

The resource type of the group members.

GroupResourceType

The supported resource types that can be used as values of group_resource.resource_type. INSTANCE includes gce_instance and aws_ec2_instance resource types. The resource types gae_app and uptime_url are not valid here because group checks on App Engine modules and URLs are not allowed.

Enums
RESOURCE_TYPE_UNSPECIFIED Default value (not valid).
INSTANCE A group of instances from Google Cloud Platform (GCP) or Amazon Web Services (AWS).
AWS_ELB_LOAD_BALANCER A group of Amazon ELB load balancers.

HttpCheck

Information involved in an HTTP/HTTPS Uptime check request.

JSON representation 
{
  "useSsl": boolean,
  "path": string,
  "port": integer,
  "authInfo": {
    object (BasicAuthentication)
  },
  "maskHeaders": boolean,
  "headers": {
    string: string,
    ...
  },
  "validateSsl": boolean
}
Fields
useSsl

boolean

If true, use HTTPS instead of HTTP to run the check.
path

string

Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitoredResource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
port

integer

Optional (defaults to 80 when useSsl is false, and 443 when useSsl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitoredResource) and path to construct the full URL.
authInfo

object (BasicAuthentication)

The authentication information. Optional when creating an HTTP check; defaults to empty.
maskHeaders

boolean

Boolean specifiying 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 maskHeaders is set to true then the headers will be obscured with ******.
headers

map (key: string, value: string)

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 https://www.w3.org/Protocols/rfc2616/rfc2616.txt (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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
validateSsl

boolean

Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitoredResource is set to uptime_url. If useSsl is false, setting validateSsl to true has no effect.

BasicAuthentication

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.

JSON representation 
{
  "username": string,
  "password": string
}
Fields
username

string

The username to use when authenticating with the HTTP server.
password

string

The password to use when authenticating with the HTTP server.

TcpCheck

Information required for a TCP Uptime check request.

JSON representation 
{
  "port": integer
}
Fields
port

integer

The TCP port on the server against which to run the check. Will be combined with host (specified within the monitoredResource) to construct the full URL. Required.

ContentMatcher

Optional. Used to perform content matching. This allows matching based on substrings and regular expressions, together with their negations. Only the first 4 MB of an HTTP or HTTPS check's response (and the first 1 MB of a TCP check's response) are examined for purposes of content matching.

JSON representation 
{
  "content": string,
  "matcher": enum (ContentMatcherOption)
}
Fields
content

string

String or regex content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed.
matcher

enum (ContentMatcherOption)

The type of content matcher that will be applied to the server output, compared to the content string when the check is run.

ContentMatcherOption

Options to perform content matching.

Enums
CONTENT_MATCHER_OPTION_UNSPECIFIED No content matcher type specified (maintained for backward compatibility, but deprecated for future use). Treated as CONTAINS_STRING.
CONTAINS_STRING Selects substring matching. The match succeeds if the output contains the content string. This is the default value for checks without a matcher option, or where the value of matcher is CONTENT_MATCHER_OPTION_UNSPECIFIED.
NOT_CONTAINS_STRING Selects negation of substring matching. The match succeeds if the output does NOT contain the content string.
MATCHES_REGEX Selects regular-expression matching. The match succeeds of the output matches the regular expression specified in the content string.
NOT_MATCHES_REGEX Selects negation of regular-expression matching. The match succeeds if the output does NOT match the regular expression specified in the content string.

UptimeCheckRegion

The regions from which an Uptime check can be run.

Enums
REGION_UNSPECIFIED Default value if no region is specified. Will result in Uptime checks running from all regions.
USA Allows checks to run from locations within the United States of America.
EUROPE Allows checks to run from locations within the continent of Europe.
SOUTH_AMERICA Allows checks to run from locations within the continent of South America.
ASIA_PACIFIC Allows checks to run from locations within the Asia Pacific area (ex: Singapore).

InternalChecker

An internal checker allows Uptime checks to run on private/internal GCP resources.

JSON representation 
{
  "name": string,
  "displayName": string,
  "network": string,
  "gcpZone": string,
  "peerProjectId": string,
  "state": enum (State)
}
Fields
name

string

A unique resource name for this InternalChecker. The format is:

projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].

[PROJECT_ID] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker.
displayName

string

The checker's human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
network

string

The GCP VPC network where the internal resource lives (ex: "default").
gcpZone

string

The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified.
peerProjectId

string

The GCP project ID where the internal checker lives. Not necessary the same as the Workspace project.
state

enum (State)

The current operational state of the internal checker.

State

Operational states for an internal checker.

Enums
UNSPECIFIED An internal checker should never be in the unspecified state.
CREATING The checker is being created, provisioned, and configured. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker, as well as by examining the long running Operation that created it.
RUNNING The checker is running and available for use. A checker in this state can be returned by ListInternalCheckers or GetInternalChecker as well as by examining the long running Operation that created it. If a checker is being torn down, it is neither visible nor usable, so there is no "deleting" or "down" state.

Methods

create

 Creates a new Uptime check configuration.

delete

 Deletes an Uptime check configuration.

get

 Gets a single Uptime check configuration.

list

 Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

patch

 Updates an Uptime check configuration.