Network Management API
The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.
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
The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.
Endpoints 26
projects.locations.vpcFlowLogsConfigs
- GETGets the details of a specific `VpcFlowLogsConfig`.
/v1/:nameGets the details of a specific VpcFlowLogsConfig. - DELETEDeletes a specific `VpcFlowLogsConfig`.
/v1/:nameDeletes a specific VpcFlowLogsConfig. - PATCHUpdates an existing `VpcFlowLogsConfig`
/v1/:name?updateMask=stringUpdates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails.… - GETLists all `VpcFlowLogsConfigs` in a given project.
/v1/:parent/vpcFlowLogsConfigs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all VpcFlowLogsConfigs in a given project. - POSTCreates a new `VpcFlowLogsConfig`
/v1/:parent/vpcFlowLogsConfigs?vpcFlowLogsConfigId=stringCreates a new VpcFlowLogsConfig. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1.… - GETQueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the…
/v1/:parent/vpcFlowLogsConfigs:queryOrgVpcFlowLogsConfigs?filter=string&pageSize=0&pageToken=stringQueryOrgVpcFlowLogsConfigs returns a list of all organization-level VPC Flow Logs configurations applicable to the specified project. - GETShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.
/v1/:parent/vpcFlowLogsConfigs:showEffectiveFlowLogsConfigs?filter=string&pageSize=0&pageToken=string&resource=stringShowEffectiveFlowLogsConfigs returns a list of all VPC Flow Logs configurations applicable to a specified resource.
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.global.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.global.connectivityTests
- GETLists all Connectivity Tests owned by a project.
/v1/:parent/connectivityTests?filter=string&orderBy=string&pageSize=0&pageToken=stringLists all Connectivity Tests owned by a project. - POSTCreates a new Connectivity Test
/v1/:parent/connectivityTests?testId=stringCreates a new Connectivity Test. After you create a test, the reachability analysis is performed as part of the long running operation, which completes when… - GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTRerun an existing `ConnectivityTest`
/v1/:name:rerunRerun an existing ConnectivityTest. After the user triggers the rerun, the reachability analysis is performed as part of the long running operation, which… - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND…
projects.locations.networkMonitoringProviders
- GETLists NetworkMonitoringProviders for a given project and location.
/v1/:parent/networkMonitoringProviders?pageSize=0&pageToken=stringLists NetworkMonitoringProviders for a given project and location. - POSTCreates a NetworkMonitoringProvider resource.
/v1/:parent/networkMonitoringProviders?networkMonitoringProviderId=stringCreates a NetworkMonitoringProvider resource. - GETGenerates Monitoring Point configuration of a NetworkMonitoringProvider resource.
/v1/:name:generateMonitoringPointConfig?privateConnectivityEnabled=trueGenerates Monitoring Point configuration of a NetworkMonitoringProvider resource. - GETGenerates a provider access token for a given Google access token
/v1/:name:generateProviderAccessToken?gcpAccessToken=stringGenerates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the…
projects.locations.networkMonitoringProviders.monitoringPoints
- GETDownloads an install script for MonitoringPoints for a given network monitoring provider.
/v1/:parent/monitoringPoints:downloadInstallScript?_password=string&cloudDeploymentType=CLOUD_DEPLOYMENT_TYPE_UNSPECIFIED&hostname=string&monitoringPointType=MONITORING_POINT_TYPE_UNSPECIFIED&ntpServerAddress=string&ntpServerSecondaryAddress=string&privateConnectivityEnabled=true&staticIpAddress.dnsServerAddress=string&staticIpAddress.dnsServerSecondaryAddress=string&staticIpAddress.domain=string&staticIpAddress.gatewayAddress=string&staticIpAddress.ipAddress=string&staticIpAddress.netmask=string&timeZone.id=string&timeZone.version=string&useDhcp=trueDownloads an install script for MonitoringPoints for a given network monitoring provider. - GETDownloads an install script for a specific Container MonitoringPoint.
/v1/:name:downloadRecreateInstallScript?hostname=stringDownloads an install script for a specific Container MonitoringPoint. - GETDownloads the server connect configuration for a given network monitoring provider.
/v1/:parent/monitoringPoints:downloadServerConnectConfigDownloads the server connect configuration for a given network monitoring provider. - GETLists MonitoringPoints for a given network monitoring provider.
/v1/:parent/monitoringPoints?pageSize=0&pageToken=stringLists MonitoringPoints for a given network monitoring provider.
projects.locations.networkMonitoringProviders.networkPaths
- GETLists NetworkPaths for a given network monitoring provider.
/v1/:parent/networkPaths?pageSize=0&pageToken=stringLists NetworkPaths for a given network monitoring provider.
projects.locations.networkMonitoringProviders.webPaths
- GETLists WebPaths for a given network monitoring provider.
/v1/:parent/webPaths?pageSize=0&pageToken=stringLists WebPaths for a given network monitoring provider.
API details
- Base URL
https://networkmanagement.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 26 operations on 21 pathsGET 17POST 7PATCH 1DELETE 1
- Main resources
- projects.locations.vpcFlowLogsConfigs 7projects.locations.global.connectivityTests 6projects.locations.networkMonitoringProviders 4projects.locations.networkMonitoringProviders.monitoringPoi… 4projects.locations.global.operations 2projects.locations 1projects.locations.networkMonitoringProviders.networkPaths 1projects.locations.networkMonitoringProviders.webPaths 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Network Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Network Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the details of a specific `VpcFlowLogsConfig`.” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Network Management API?
The Network Management API provides a collection of network performance monitoring and diagnostic capabilities. It is listed under Developer tools and has 26 endpoints.
Who publishes the Network Management 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 Network Management API?
Requests go to https://networkmanagement.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Network Management API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Network Management API have?
26 operations on 21 paths (17 GET, 7 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.vpcFlowLogsConfigs, projects.locations.global.connectivityTests, projects.locations.networkMonitoringProviders, projects.locations.networkMonitoringProviders.monitoringPoi….
Is forking the Network Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.