Method: projects.uptimeCheckConfigs.list

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

HTTP request

GET https://monitoring.googleapis.com/v3/{parent}/uptimeCheckConfigs

Path parameters

Parameters
parent

string

Required. The project whose Uptime check configurations are listed. The format is:

projects/[PROJECT_ID_OR_NUMBER]

Authorization requires the following IAM permission on the specified resource parent:

  • monitoring.uptimeCheckConfigs.list

Query parameters

Parameters
filter

string

If provided, this field specifies the criteria that must be met by uptime checks to be included in the response.

For more details, see Filtering syntax.
pageSize

integer

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.
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.

Request body

The request body must be empty.

Response body

The protocol for the uptimeCheckConfigs.list response.

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

JSON representation 
{
  "uptimeCheckConfigs": [
    {
      object (UptimeCheckConfig)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
uptimeCheckConfigs[]

object (UptimeCheckConfig)

The returned Uptime check configurations.
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).
totalSize

integer

The total number of Uptime check configurations for the project, irrespective of any pagination.

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 Authentication Overview.