Google

Cloud Monitoring API

Manages your Cloud Monitoring data and configurations.

Developer tools#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manages your Cloud Monitoring data and configurations.

Endpoints 33

projects.timeSeries

  • GETLists time series that match a filter./v3/:name/timeSeries?aggregation.alignmentPeriod=string&aggregation.crossSeriesReducer=REDUCE_NONE&aggregation.groupByFields=string&aggregation.perSeriesAligner=ALIGN_NONE&filter=string&interval.endTime=string&interval.startTime=string&orderBy=string&pageSize=0&pageToken=string&secondaryAggregation.alignmentPeriod=string&secondaryAggregation.crossSeriesReducer=REDUCE_NONE&secondaryAggregation.groupByFields=string&secondaryAggregation.perSeriesAligner=ALIGN_NONE&view=FULLLists time series that match a filter.
  • POSTCreates or adds data to one or more time series/v3/:name/timeSeriesCreates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be…
  • POSTCreates or adds data to one or more service time series/v3/:name/timeSeries:createServiceCreates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is…
  • POSTQueries time series by using Monitoring Query Language (MQL)/v3/:name/timeSeries:queryQueries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the…

projects.alertPolicies

  • GETLists the existing alerting policies for the workspace./v3/:name/alertPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the existing alerting policies for the workspace.
  • POSTCreates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting…/v3/:name/alertPoliciesCreates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes…

services.serviceLevelObjectives

  • GETGet a ServiceLevelObjective by name./v3/:name?view=VIEW_UNSPECIFIEDGet a ServiceLevelObjective by name.
  • DELETEDelete the given ServiceLevelObjective./v3/:nameDelete the given ServiceLevelObjective.
  • PATCHUpdate the given ServiceLevelObjective./v3/:name?updateMask=stringUpdate the given ServiceLevelObjective.
  • GETList the ServiceLevelObjectives for the given Service./v3/:parent/serviceLevelObjectives?filter=string&pageSize=0&pageToken=string&view=VIEW_UNSPECIFIEDList the ServiceLevelObjectives for the given Service.
  • POSTCreate a ServiceLevelObjective for the given Service./v3/:parent/serviceLevelObjectives?serviceLevelObjectiveId=stringCreate a ServiceLevelObjective for the given Service.

projects.groups

  • PUTUpdates an existing group/v3/:name?validateOnly=trueUpdates an existing group. You can change any group attributes except name.
  • GETLists the existing groups./v3/:name/groups?ancestorsOfGroup=string&childrenOfGroup=string&descendantsOfGroup=string&pageSize=0&pageToken=stringLists the existing groups.
  • POSTCreates a new group./v3/:name/groups?validateOnly=trueCreates a new group.

projects.alerts

  • GETLists the existing alerts for the metrics scope of the project./v3/:parent/alerts?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the existing alerts for the metrics scope of the project.

projects.collectdTimeSeries

  • POSTCloud Monitoring Agent only: Creates a new time series.This method is only for use by the Cloud Monitoring Agent/v3/:name/collectdTimeSeriesCloud Monitoring Agent only: Creates a new time series.This method is only for use by the Cloud Monitoring Agent. Use projects.timeSeries.create instead.

projects.groups.members

  • GETLists the monitored resources that are members of a group./v3/:name/members?filter=string&interval.endTime=string&interval.startTime=string&pageSize=0&pageToken=stringLists the monitored resources that are members of a group.

projects.metricDescriptors

  • GETLists metric descriptors that match a filter./v3/:name/metricDescriptors?activeOnly=true&filter=string&pageSize=0&pageToken=stringLists metric descriptors that match a filter.
  • POSTCreates a new metric descriptor/v3/:name/metricDescriptorsCreates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics…

projects.monitoredResourceDescriptors

  • GETLists monitored resource descriptors that match a filter./v3/:name/monitoredResourceDescriptors?filter=string&pageSize=0&pageToken=stringLists monitored resource descriptors that match a filter.

projects.notificationChannelDescriptors

  • GETLists the descriptors for supported channel types/v3/:name/notificationChannelDescriptors?pageSize=0&pageToken=stringLists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

projects.notificationChannels

  • GETLists the notification channels that have been created for the project/v3/:name/notificationChannels?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the…
  • POSTCreates a new notification channel, representing a single notification endpoint such as an email address, SMS number,…/v3/:name/notificationChannelsCreates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your…
  • POSTRequests a verification code for an already verified channel that can then be used in a call to…/v3/:name:getVerificationCodeRequests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an…
  • POSTCauses a verification code to be delivered to the channel/v3/:name:sendVerificationCodeCauses a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.
  • POSTVerifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling…/v3/:name:verifyVerifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

projects.snoozes

  • GETLists the Snoozes associated with a project/v3/:parent/snoozes?filter=string&pageSize=0&pageToken=stringLists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.
  • POSTCreates a Snooze that will prevent alerts, which match the provided criteria, from being opened/v3/:parent/snoozesCreates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

projects.uptimeCheckConfigs

  • GETLists the existing valid Uptime check configurations for the project (leaving out any invalid configurations)./v3/:parent/uptimeCheckConfigs?filter=string&pageSize=0&pageToken=stringLists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).
  • POSTCreates a new Uptime check configuration./v3/:parent/uptimeCheckConfigsCreates a new Uptime check configuration.

services

  • GETList Services for this Metrics Scope./v3/:parent/services?filter=string&pageSize=0&pageToken=stringList Services for this Metrics Scope.
  • POSTCreate a Service./v3/:parent/services?serviceId=stringCreate a Service.

uptimeCheckIps

  • GETReturns the list of IP addresses that checkers run from./v3/uptimeCheckIps?pageSize=0&pageToken=stringReturns the list of IP addresses that checkers run from.

API details

Base URL
https://monitoring.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 4 scopes
An API key in the key query parameter
Operations
33 operations on 21 pathsGET 15POST 15PUT 1PATCH 1DELETE 1
Main resources
projects.notificationChannels 5services.serviceLevelObjectives 5projects.timeSeries 4projects.groups 3projects.alertPolicies 2projects.metricDescriptors 2projects.snoozes 2projects.uptimeCheckConfigs 2services 2projects.alerts 1
Response formats
application/json
Description format
Google API Discovery, API version v3

How to test the Cloud Monitoring API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Monitoring API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Lists time series that match a filter.” (GET /v3/:name/timeSeries?aggregation.alignmentPeriod=string&aggregation.crossSeriesReducer=REDUCE_NONE&aggregation.groupByFields=string&aggregation.perSeriesAligner=ALIGN_NONE&filter=string&interval.endTime=string&interval.startTime=string&orderBy=string&pageSize=0&pageToken=string&secondaryAggregation.alignmentPeriod=string&secondaryAggregation.crossSeriesReducer=REDUCE_NONE&secondaryAggregation.groupByFields=string&secondaryAggregation.perSeriesAligner=ALIGN_NONE&view=FULL), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Monitoring API?

Manages your Cloud Monitoring data and configurations. It is listed under Developer tools and has 33 endpoints.

Who publishes the Cloud Monitoring API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Monitoring API?

Requests go to https://monitoring.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Monitoring API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 4 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Monitoring API have?

33 operations on 21 paths (15 GET, 15 POST, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are projects.notificationChannels, services.serviceLevelObjectives, projects.timeSeries, projects.groups.

Is forking the Cloud Monitoring API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.