v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1333131212.7 KB
projects

Creates a new Uptime check configuration.

post/v3/{+parent}/uptimeCheckConfigs

Path parameters

parentstring required

Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER]

Request body

selectedRegionsstring[]

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.

displayNamestring

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.

checkerType'CHECKER_TYPE_UNSPECIFIED' | 'STATIC_IP_CHECKERS' | 'VPC_CHECKERS'

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

periodstring google-duration

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.

userLabelsobject

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

isInternalboolean

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

disabledboolean

Whether the check is disabled or not.

namestring

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.

timeoutstring google-duration

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

logCheckFailuresboolean

To specify whether to log the results of failed probes to Cloud Logging.

Response

Successful response