.TH "GCLOUD_BETA_MONITORING_UPTIME_UPDATE" 1



.SH "NAME"
.HP
gcloud beta monitoring uptime update \- update an existing uptime check or synthetic monitor



.SH "SYNOPSIS"
.HP
\f5gcloud beta monitoring uptime update\fR \fICHECK_ID\fR [\fB\-\-body\fR=\fIBODY\fR\ \fB\-\-content\-type\fR=\fICONTENT_TYPE\fR\ \fB\-\-custom\-content\-type\fR=\fICUSTOM_CONTENT_TYPE\fR\ \fB\-\-mask\-headers\fR=\fIMASK_HEADERS\fR\ \fB\-\-password\fR=\fIPASSWORD\fR\ \fB\-\-path\fR=\fIPATH\fR\ \fB\-\-pings\-count\fR=\fIPINGS_COUNT\fR\ \fB\-\-port\fR=\fIPORT\fR\ \fB\-\-request\-method\fR=\fIREQUEST_METHOD\fR\ \fB\-\-service\-agent\-auth\fR=\fISERVICE_AGENT_AUTH\fR\ \fB\-\-username\fR=\fIUSERNAME\fR\ \fB\-\-validate\-ssl\fR=\fIVALIDATE_SSL\fR\ \fB\-\-add\-status\-classes\fR=[\fIstatus\-class\fR,...]\ |\ \fB\-\-clear\-status\-classes\fR=\fICLEAR_STATUS_CLASSES\fR\ |\ \fB\-\-remove\-status\-classes\fR=[\fIstatus\-class\fR,...]\ |\ \fB\-\-set\-status\-classes\fR=[\fIstatus\-class\fR,...]\ |\ \fB\-\-add\-status\-codes\fR=[\fIstatus\-code\fR,...]\ |\ \fB\-\-clear\-status\-codes\fR=\fICLEAR_STATUS_CODES\fR\ |\ \fB\-\-remove\-status\-codes\fR=[\fIstatus\-code\fR,...]\ |\ \fB\-\-set\-status\-codes\fR=[\fIstatus\-code\fR,...]\ \fB\-\-update\-headers\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-headers\fR=\fICLEAR_HEADERS\fR\ |\ \fB\-\-remove\-headers\fR=[\fIKEY\fR,...]] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR\ \fB\-\-period\fR=\fIPERIOD\fR\ \fB\-\-timeout\fR=\fITIMEOUT\fR\ \fB\-\-add\-regions\fR=[\fIregion\fR,...]\ |\ \fB\-\-clear\-regions\fR=\fICLEAR_REGIONS\fR\ |\ \fB\-\-remove\-regions\fR=[\fIregion\fR,...]\ |\ \fB\-\-set\-regions\fR=[\fIregion\fR,...]\ \fB\-\-update\-user\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-user\-labels\fR\ |\ \fB\-\-remove\-user\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-matcher\-content\fR=\fIMATCHER_CONTENT\fR\ :\ \fB\-\-matcher\-type\fR=\fIMATCHER_TYPE\fR\ [\fB\-\-json\-path\fR=\fIJSON_PATH\fR\ :\ \fB\-\-json\-path\-matcher\-type\fR=\fIJSON_PATH_MATCHER_TYPE\fR]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Updates an existing uptime check or synthetic monitor.

Flags only apply to uptime checks unless noted that they apply to synthetic
monitors.

For information about the JSON/YAML format of an uptime check:
https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.uptimeCheckConfigs



.SH "EXAMPLES"

To update an uptime check or synthetic monitor, run:

.RS 2m
$ gcloud beta monitoring uptime update CHECK_ID \-\-period=5 \e
    \-\-timeout=30
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Uptime check or synthetic monitor resource \- Name of the uptime check or
synthetic monitor to be updated. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5check_id\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fICHECK_ID\fR

ID of the uptime check or synthetic monitor or fully qualified identifier for
the uptime check or synthetic monitor.

To set the \f5check_id\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5check_id\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m

Uptime check protocol settings.


.RS 2m
.TP 2m
\fB\-\-body\fR=\fIBODY\fR

The request body associated with the HTTP POST request. Can only be set if
\f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-content\-type\fR=\fICONTENT_TYPE\fR

The content type header to use for the check, defaults to \f5unspecified\fR. Can
only be set if \f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

\fICONTENT_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBunspecified\fR
Not specified
.TP 2m
\fBurl\-encoded\fR
URL encoded
.TP 2m
\fBuser\-provided\fR
User provided
.RE
.sp


.TP 2m
\fB\-\-custom\-content\-type\fR=\fICUSTOM_CONTENT_TYPE\fR

A user\-provided content type header to use for the check. Can only be set if
\f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-mask\-headers\fR=\fIMASK_HEADERS\fR

Whether to encrypt the header information, defaults to \f5false\fR. Can only be
set if \f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-password\fR=\fIPASSWORD\fR

The password to use when authenticating with the HTTP server. Can only be set if
\f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-path\fR=\fIPATH\fR

The path to the page against which to run the check, defaults to \f5/\fR. Can
only be set if \f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-pings\-count\fR=\fIPINGS_COUNT\fR

Number of ICMP pings to send alongside the request.

.TP 2m
\fB\-\-port\fR=\fIPORT\fR

The port on the server against which to run the check. Defaults to \f580\fR when
\f5\-\-protocol\fR is \f5http\fR. Defaults to \f5443\fR when \f5\-\-protocol\fR
is \f5https\fR. Required if \f5\-\-protocol\fR is \f5tcp\fR.

.TP 2m
\fB\-\-request\-method\fR=\fIREQUEST_METHOD\fR

The HTTP request method to use, defaults to \f5get\fR. Can only be set if
\f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

\fIREQUEST_METHOD\fR must be one of:

.RS 2m
.TP 2m
\fBget\fR
HTTP GET method
.TP 2m
\fBpost\fR
HTTP POST method
.RE
.sp


.TP 2m

Uptime check service agent authorization.


.RS 2m
.TP 2m
\fB\-\-service\-agent\-auth\fR=\fISERVICE_AGENT_AUTH\fR

The type of authentication to use for the HTTP request. Can only be set if
\f5\-\-protocol\fR is \f5https\fR.

\fISERVICE_AGENT_AUTH\fR must be (only one value is supported):

.RS 2m
.TP 2m
\fBoidc\-token\fR
OIDC Token authentication
.RE
.sp


.RE
.sp
.TP 2m
\fB\-\-username\fR=\fIUSERNAME\fR

The username to use when authenticating with the HTTP server. Can only be set if
\f5\-\-protocol\fR is \f5http\fR or \f5https\fR.

.TP 2m
\fB\-\-validate\-ssl\fR=\fIVALIDATE_SSL\fR

Whether to include SSL certificate validation as a part of the uptime check,
defaults to \f5false\fR. Can only be set if \f5\-\-protocol\fR is \f5http\fR or
\f5https\fR.

.TP 2m

Uptime check status.

At most one of these can be specified:


.RS 2m
.TP 2m

Uptime check status classes.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-status\-classes\fR=[\fIstatus\-class\fR,...]

The list of HTTP status classes to add to the uptime check. \fIstatus\-class\fR
must be one of:

.RS 2m
.TP 2m
\fB1xx\fR
Any response code from 100\-199 inclusive
.TP 2m
\fB2xx\fR
Any response code from 200\-299 inclusive
.TP 2m
\fB3xx\fR
Any response code from 300\-399 inclusive
.TP 2m
\fB4xx\fR
Any response code from 400\-499 inclusive
.TP 2m
\fB5xx\fR
Any response code from 500\-599 inclusive
.TP 2m
\fBany\fR
Any response code
.RE
.sp


.TP 2m
\fB\-\-clear\-status\-classes\fR=\fICLEAR_STATUS_CLASSES\fR

Clear all HTTP status classes on the uptime check. Setting this flag is the same
as selecting only the \f52xx\fR status class.

.TP 2m
\fB\-\-remove\-status\-classes\fR=[\fIstatus\-class\fR,...]

The list of HTTP status classes to remove from the uptime check.
\fIstatus\-class\fR must be one of:

.RS 2m
.TP 2m
\fB1xx\fR
Any response code from 100\-199 inclusive
.TP 2m
\fB2xx\fR
Any response code from 200\-299 inclusive
.TP 2m
\fB3xx\fR
Any response code from 300\-399 inclusive
.TP 2m
\fB4xx\fR
Any response code from 400\-499 inclusive
.TP 2m
\fB5xx\fR
Any response code from 500\-599 inclusive
.TP 2m
\fBany\fR
Any response code
.RE
.sp


.TP 2m
\fB\-\-set\-status\-classes\fR=[\fIstatus\-class\fR,...]

List of HTTP status classes. The uptime check will only pass if the response
code is contained in this list.

\fIstatus\-class\fR must be one of:

.RS 2m
.TP 2m
\fB1xx\fR
Any response code from 100\-199 inclusive
.TP 2m
\fB2xx\fR
Any response code from 200\-299 inclusive
.TP 2m
\fB3xx\fR
Any response code from 300\-399 inclusive
.TP 2m
\fB4xx\fR
Any response code from 400\-499 inclusive
.TP 2m
\fB5xx\fR
Any response code from 500\-599 inclusive
.TP 2m
\fBany\fR
Any response code
.RE
.sp


.RE
.sp
.TP 2m

Uptime check status codes.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-status\-codes\fR=[\fIstatus\-code\fR,...]

The list of HTTP status codes to add to the uptime check.

.TP 2m
\fB\-\-clear\-status\-codes\fR=\fICLEAR_STATUS_CODES\fR

Clear all HTTP status codes on the uptime check. Setting this flag is the same
as selecting only the \f52xx\fR status class.

.TP 2m
\fB\-\-remove\-status\-codes\fR=[\fIstatus\-code\fR,...]

The list of HTTP status codes to remove from the uptime check.

.TP 2m
\fB\-\-set\-status\-codes\fR=[\fIstatus\-code\fR,...]

List of HTTP status codes. The uptime check will only pass if the response code
is present in this list.

.RE
.RE
.sp
.TP 2m

Uptime check headers.


.RS 2m
.TP 2m
\fB\-\-update\-headers\fR=[\fIKEY\fR=\fIVALUE\fR,...]

The list of headers to add to the uptime check. Any existing headers with
matching "key" are overridden by the provided values.

.TP 2m

Uptime check remove headers.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-headers\fR=\fICLEAR_HEADERS\fR

Clear all headers on the uptime check.

.TP 2m
\fB\-\-remove\-headers\fR=[\fIKEY\fR,...]

The list of header keys to remove from the uptime check.

.RE
.RE
.RE
.sp
.TP 2m

Settings.


.RS 2m
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

The display name for the uptime check or synthetic monitor.

.TP 2m
\fB\-\-period\fR=\fIPERIOD\fR

The time between uptime check or synthetic monitor executions in minutes,
defaults to \f51\fR. Can be set for synthetic monitors.

\fIPERIOD\fR must be one of:

.RS 2m
.TP 2m
\fB1\fR
One minute
.TP 2m
\fB10\fR
Ten minutes
.TP 2m
\fB15\fR
Fifteen minutes
.TP 2m
\fB5\fR
Five minutes
.RE
.sp


.TP 2m
\fB\-\-timeout\fR=\fITIMEOUT\fR

The maximum amount of time in seconds to wait for the request to complete,
defaults to \f560\fR. Can be set for synthetic monitors.

.TP 2m

Uptime check selected regions.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-regions\fR=[\fIregion\fR,...]

The list of regions to add to the uptime check. \fIregion\fR must be one of:

.RS 2m
.TP 2m
\fBasia\-pacific\fR
asia\-southeast1
.TP 2m
\fBeurope\fR
europe\-west1
.TP 2m
\fBsouth\-america\fR
southamerica\-east1
.TP 2m
\fBusa\-iowa\fR
us\-central1
.TP 2m
\fBusa\-oregon\fR
us\-west1
.TP 2m
\fBusa\-virginia\fR
us\-east4
.RE
.sp


.TP 2m
\fB\-\-clear\-regions\fR=\fICLEAR_REGIONS\fR

Clear all regions on the uptime check. This setting acts the same as if all
available regions were selected.

.TP 2m
\fB\-\-remove\-regions\fR=[\fIregion\fR,...]

The list of regions to remove from the uptime check. \fIregion\fR must be one
of:

.RS 2m
.TP 2m
\fBasia\-pacific\fR
asia\-southeast1
.TP 2m
\fBeurope\fR
europe\-west1
.TP 2m
\fBsouth\-america\fR
southamerica\-east1
.TP 2m
\fBusa\-iowa\fR
us\-central1
.TP 2m
\fBusa\-oregon\fR
us\-west1
.TP 2m
\fBusa\-virginia\fR
us\-east4
.RE
.sp


.TP 2m
\fB\-\-set\-regions\fR=[\fIregion\fR,...]

The list of regions from which the check is run. At least 3 regions must be
selected.

\fIregion\fR must be one of:

.RS 2m
.TP 2m
\fBasia\-pacific\fR
asia\-southeast1
.TP 2m
\fBeurope\fR
europe\-west1
.TP 2m
\fBsouth\-america\fR
southamerica\-east1
.TP 2m
\fBusa\-iowa\fR
us\-central1
.TP 2m
\fBusa\-oregon\fR
us\-west1
.TP 2m
\fBusa\-virginia\fR
us\-east4
.RE
.sp


.RE
.sp
.TP 2m

User labels. Can be set for synthetic monitors.


.RS 2m
.TP 2m
\fB\-\-update\-user\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-user\-labels\fR

Remove all labels. If \f5\-\-update\-user\-labels\fR is also specified then
\f5\-\-clear\-user\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud beta monitoring uptime update \-\-clear\-user\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud beta monitoring uptime update \-\-clear\-user\-labels \e
  \-\-update\-user\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-user\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-user\-labels\fR is also specified then
\f5\-\-update\-user\-labels\fR is applied first.

.RE
.RE
.RE
.sp
.TP 2m

Uptime check matcher settings.


.RS 2m
.TP 2m
\fB\-\-matcher\-content\fR=\fIMATCHER_CONTENT\fR

String, regex or JSON content to match.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-matcher\-type\fR=\fIMATCHER_TYPE\fR

The type of content matcher that is applied to the server output, defaults to
\f5contains\-string\fR.

\fIMATCHER_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBcontains\-string\fR
Response contains string
.TP 2m
\fBmatches\-json\-path\fR
Response matches at JSONPath
.TP 2m
\fBmatches\-regex\fR
Response matches regex
.TP 2m
\fBnot\-contains\-string\fR
Response does not contain string
.TP 2m
\fBnot\-matches\-json\-path\fR
Response does not match at JSONPath
.TP 2m
\fBnot\-matches\-regex\fR
Response does not match regex
.RE
.sp


.TP 2m

Uptime check matcher settings for JSON responses.


.RS 2m
.TP 2m
\fB\-\-json\-path\fR=\fIJSON_PATH\fR

JSONPath within the response output pointing to the expected content to match.
Only used if \f5\-\-matcher\-type\fR is \f5matches\-json\-path\fR or
\f5not\-matches\-json\-path\fR.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-json\-path\-matcher\-type\fR=\fIJSON_PATH_MATCHER_TYPE\fR

The type of JSONPath match that is applied to the JSON output, defaults to
\f5exact\-match\fR. Only used if \f5\-\-matcher\-type\fR is
\f5matches\-json\-path\fR or \f5not\-matches\-json\-path\fR.

\fIJSON_PATH_MATCHER_TYPE\fR must be one of:

.RS 2m
.TP 2m
\fBexact\-match\fR
Response matches exact string at JSONPath
.TP 2m
\fBregex\-match\fR
Response matches regex at JSONPath
.RE
.sp



.RE
.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud monitoring uptime update
.RE

.RS 2m
$ gcloud alpha monitoring uptime update
.RE