Enabling the Network Management API

Before you can run Connectivity Tests, you must enable the Network Management API.

Enabling the API is required in order to use the API itself, the Google Cloud CLI, or the Google Cloud console.

You can check API status or enable the API by using a gcloud command or by using the Google Cloud console. You can also authorize users to access the API.

Enable the API

Use one of the following methods to enable the API.

Console

When you load Connectivity Tests in the Google Cloud console for the first time for a specific project, click the button that asks you to enable the Network Management API. You must enable the API in order to run Connectivity Tests.

gcloud

  1. If you have not already installed the Google Cloud CLI on your workstation, see the gcloud CLI documentation to do so.

  2. To check if the Network Management API is enabled, run the following command on your workstation:

    gcloud services list
    

    If networkmanagement.googleapis.com appears in the command output, the API is enabled.

  3. If the API is not enabled, run the following command to enable it. For more information, see gcloud services.

    gcloud services enable networkmanagement.googleapis.com
    

Authorize use of the API

Access to the Network Management API is controlled by Identity and Access Management roles and permissions. Permissions for related methods are clustered into roles, which you can then grant to users.

For more information, see the following documents:

Use the API Explorer

You can test Network Management API commands by using the API Explorer. In the Network Management API reference document, use the Try this API column to explore API fields and run a test.