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)
    }
  ],
  "checkerType": enum (CheckerType),
  "disabled": boolean,
  "selectedRegions": [
    enum (UptimeCheckRegion)
  ],
  "logCheckFailures": boolean,
  "isInternal": boolean,
  "internalCheckers": [
    {
      object (InternalChecker)
    }
  ],
  "userLabels": {
    string: string,
    ...
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "monitoredResource": {
    object (MonitoredResource)
  },
  "resourceGroup": {
    object (ResourceGroup)
  },
  "syntheticMonitor": {
    object (SyntheticMonitorTarget)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "httpCheck": {
    object (HttpCheck)
  },
  "tcpCheck": {
    object (TcpCheck)
  }
  // End of mutually exclusive fields.
}
Fields
name

string

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

 projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

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 Cloud Monitoring 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.
checkerType

enum (CheckerType)

The type of checkers to use to execute the Uptime check.
disabled

boolean

Whether the check is disabled or not.
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.
logCheckFailures

boolean

To specify whether to log the results of failed probes to Cloud Logging.
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.