Method: uptimeCheckIps.list

Returns the list of IPs that checkers run from

HTTP request

GET https://monitoring.googleapis.com/v3/uptimeCheckIps

Query parameters

Parameters
pageSize

number

The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the pageSize is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented

pageToken

string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The protocol for the uptimeCheckIps.list response.

JSON representation
{
  "uptimeCheckIps": [
    {
      object(UptimeCheckIp)
    }
  ],
  "nextPageToken": string,
}
Fields
uptimeCheckIps[]

object(UptimeCheckIp)

The returned list of IP addresses (including region and location) that the checkers run from.

nextPageToken

string

This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the nextPageToken is passed to the subsequent List method call (in the request message's pageToken field). NOTE: this field is not yet implemented

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/monitoring
  • https://www.googleapis.com/auth/monitoring.read

For more information, see the Auth Guide.

UptimeCheckIp

Contains the region, location, and list of IP addresses where checkers in the location run from.

JSON representation
{
  "region": enum(UptimeCheckRegion),
  "location": string,
  "ipAddress": string,
}
Fields
region

enum(UptimeCheckRegion)

A broad region category in which the IP address is located.

location

string

A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.

ipAddress

string

The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.

Send feedback about...

Stackdriver Monitoring