Enable the Monitoring API

Stay organized with collections Save and categorize content based on your preferences.

This page describes how to enable and authorize use of theMonitoring API v3. You must enable this API before you can use it.

To determine whether the Monitoring API is enabled or to enable theAPI, use either the Google Cloud console or the Google Cloud CLI.

Google Cloud console

In the Google Cloud console, select the Google Cloud project forwhich you want to enable the API,and then go to the APIs & Services page:
Go to APIs & Services
Click the Enable APIs and Service button.
Search for "Monitoring".
In the search results, click through to "Stackdriver Monitoring API".
If "API enabled" is displayed, then the API is already enabled. Ifnot, then click Enable.

gcloud CLI

If you have not already installed the Google Cloud CLI on yourworkstation, seeInstalling the gcloud CLI.
To see if the Monitoring API is enabled, run the followingcommand on your workstation, after replacing PROJECT_ID with theID of the project for which you want to enable the API:
```
gcloud services list --project=PROJECT_ID
```
If monitoring.googleapis.com appears in the output, the API isenabled.
If the API is not enabled, then run the following command to enable it:
```
gcloud services enable monitoring --project=PROJECT_ID
```
For more information, seegcloud services.

Authorize use of the Monitoring API

Access to the Monitoring API is controlled byIdentity and Access Management (IAM) roles and permissions.There is a permission associated with each method, andpermissions for related methods are clustered into roles, which can thenbe granted to users. For more information, seeControl access with IAM.

After access to an API is authorized, the API can be used from anywhere.For example, you can call the timeSeries.listmethod from your local workstation. You can also use the API to sendmetrics against any entity that can be represented as a monitored resource.See Monitored-resource types for user-defined metricsfor the list of available types.

If you are writing an application that uses therecommended client libraries, these librariesauthorize your application by usingApplication Default Credentials.

You might also be able to use API keys in some situations, but service accountsare generally recommended. API keys are useful in clients likebrowsers and mobile applications that don't have a backend server.For more information, see Using API Keys.

You can find out more about authentication and authorizationin our Authentication guide.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-09-13 UTC.