Network Connectivity API
This API enables connectivity with and between Google Cloud resources.
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
This API enables connectivity with and between Google Cloud resources.
Endpoints 50
projects.locations
- POSTCheckConsumerConfig validates the consumer network and project for potential PSC connection creation
/v1/:location:checkConsumerConfigCheckConsumerConfig validates the consumer network and project for potential PSC connection creation. This method performs several checks, including: -… - 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.transports
- GETGets details of a single Transport.
/v1/:nameGets details of a single Transport. - DELETEDeletes a single Transport.
/v1/:name?requestId=stringDeletes a single Transport. - PATCHUpdates the parameters of a single Transport.
/v1/:name?requestId=string&updateMask=stringUpdates the parameters of a single Transport. - GETLists Transports in a given project and location.
/v1/:parent/transports?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Transports in a given project and location. - POSTCreates a new Transport in a given project and location.
/v1/:parent/transports?requestId=string&transportId=stringCreates a new Transport in a given project and location.
projects.locations.automatedDnsRecords
- GETLists AutomatedDnsRecords in a given project and location.
/v1/:parent/automatedDnsRecords?filter=string&orderBy=string&pageSize=0&pageToken=stringLists AutomatedDnsRecords in a given project and location. - POSTCreates a new AutomatedDnsRecord in a given project and location.
/v1/:parent/automatedDnsRecords?automatedDnsRecordId=string&insertMode=INSERT_MODE_UNSPECIFIED&requestId=stringCreates a new AutomatedDnsRecord in a given project and location.
projects.locations.global.hubs
- POSTAccepts a proposal to attach a Network Connectivity Center spoke to a hub.
/v1/:name:acceptSpokeAccepts a proposal to attach a Network Connectivity Center spoke to a hub. - POSTAccepts a proposal to update a Network Connectivity Center spoke in a hub.
/v1/:name:acceptSpokeUpdateAccepts a proposal to update a Network Connectivity Center spoke in a hub. - GETLists the Network Connectivity Center hubs associated with a given project.
/v1/:parent/hubs?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the Network Connectivity Center hubs associated with a given project. - POSTCreates a new Network Connectivity Center hub in the specified project.
/v1/:parent/hubs?hubId=string&requestId=stringCreates a new Network Connectivity Center hub in the specified project. - GETLists the Network Connectivity Center spokes associated with a specified hub and location
/v1/:name:listSpokes?filter=string&orderBy=string&pageSize=0&pageToken=string&spokeLocations=string&view=SPOKE_VIEW_UNSPECIFIEDLists the Network Connectivity Center spokes associated with a specified hub and location. The list includes both spokes that are attached to the hub and… - GETQuery the Private Service Connect propagation status of a Network Connectivity Center hub.
/v1/:name:queryStatus?filter=string&groupBy=string&orderBy=string&pageSize=0&pageToken=stringQuery the Private Service Connect propagation status of a Network Connectivity Center hub. - POSTRejects a Network Connectivity Center spoke from being attached to a hub
/v1/:name:rejectSpokeRejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the ACTIVE state, it transitions to the INACTIVE… - POSTRejects a proposal to update a Network Connectivity Center spoke in a hub.
/v1/:name:rejectSpokeUpdateRejects a proposal to update a Network Connectivity Center spoke in a hub.
projects.locations.spokes
- 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. - 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… - GETLists the Network Connectivity Center spokes in a specified project and location.
/v1/:parent/spokes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists the Network Connectivity Center spokes in a specified project and location. - POSTCreates a Network Connectivity Center spoke.
/v1/:parent/spokes?requestId=string&spokeId=stringCreates a Network Connectivity Center spoke.
projects.locations.global.hubs.groups
- GETLists groups in a given hub.
/v1/:parent/groups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists groups in a given hub.
projects.locations.global.hubs.routeTables
- GETLists route tables in a given hub.
/v1/:parent/routeTables?filter=string&orderBy=string&pageSize=0&pageToken=stringLists route tables in a given hub.
projects.locations.global.hubs.routeTables.routes
- GETLists routes in a given route table.
/v1/:parent/routes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists routes in a given route table.
projects.locations.global.policyBasedRoutes
- GETLists policy-based routes in a given project and location.
/v1/:parent/policyBasedRoutes?filter=string&orderBy=string&pageSize=0&pageToken=stringLists policy-based routes in a given project and location. - POSTCreates a new policy-based route in a given project and location.
/v1/:parent/policyBasedRoutes?policyBasedRouteId=string&requestId=stringCreates a new policy-based route in a given project and location.
projects.locations.internalRanges
- GETLists internal ranges in a given project and location.
/v1/:parent/internalRanges?filter=string&orderBy=string&pageSize=0&pageToken=stringLists internal ranges in a given project and location. - POSTCreates a new internal range in a given project and location.
/v1/:parent/internalRanges?internalRangeId=string&requestId=stringCreates a new internal range in a given project and location.
projects.locations.multicloudDataTransferConfigs
- GETLists the `MulticloudDataTransferConfig` resources in a specified project and location.
/v1/:parent/multicloudDataTransferConfigs?filter=string&orderBy=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists the MulticloudDataTransferConfig resources in a specified project and location. - POSTCreates a `MulticloudDataTransferConfig` resource in a specified project and location.
/v1/:parent/multicloudDataTransferConfigs?multicloudDataTransferConfigId=string&requestId=stringCreates a MulticloudDataTransferConfig resource in a specified project and location.
projects.locations.multicloudDataTransferConfigs.destinations
- GETLists the `Destination` resources in a specified project and location.
/v1/:parent/destinations?filter=string&orderBy=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists the Destination resources in a specified project and location. - POSTCreates a `Destination` resource in a specified project and location.
/v1/:parent/destinations?destinationId=string&requestId=stringCreates a Destination resource in a specified project and location.
projects.locations.multicloudDataTransferSupportedServices
- GETLists the services in the project for a region that are supported for Data Transfer Essentials.
/v1/:parent/multicloudDataTransferSupportedServices?pageSize=0&pageToken=stringLists the services in the project for a region that are supported for Data Transfer Essentials.
projects.locations.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.pscAuthorizationPolicies
- GETLists PscAuthorizationPolicies in a given project and location.
/v1/:parent/pscAuthorizationPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists PscAuthorizationPolicies in a given project and location. - POSTCreates a new PscAuthorizationPolicy in a given project and location.
/v1/:parent/pscAuthorizationPolicies?pscAuthorizationPolicyId=string&requestId=stringCreates a new PscAuthorizationPolicy in a given project and location.
projects.locations.regionalEndpoints
- GETLists RegionalEndpoints in a given project and location.
/v1/:parent/regionalEndpoints?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RegionalEndpoints in a given project and location. - POSTCreates a new RegionalEndpoint in a given project and location.
/v1/:parent/regionalEndpoints?regionalEndpointId=string&requestId=stringCreates a new RegionalEndpoint in a given project and location.
projects.locations.remoteTransportProfiles
- GETLists RemoteTransportProfiles in a given project and location.
/v1/:parent/remoteTransportProfiles?filter=string&orderBy=string&pageSize=0&pageToken=stringLists RemoteTransportProfiles in a given project and location.
projects.locations.serviceClasses
- GETLists ServiceClasses in a given project and location.
/v1/:parent/serviceClasses?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ServiceClasses in a given project and location.
projects.locations.serviceConnectionMaps
- GETLists ServiceConnectionMaps in a given project and location.
/v1/:parent/serviceConnectionMaps?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ServiceConnectionMaps in a given project and location. - POSTCreates a new ServiceConnectionMap in a given project and location.
/v1/:parent/serviceConnectionMaps?requestId=string&serviceConnectionMapId=stringCreates a new ServiceConnectionMap in a given project and location.
projects.locations.serviceConnectionPolicies
- GETLists ServiceConnectionPolicies in a given project and location.
/v1/:parent/serviceConnectionPolicies?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ServiceConnectionPolicies in a given project and location. - POSTCreates a new ServiceConnectionPolicy in a given project and location.
/v1/:parent/serviceConnectionPolicies?autoSubnetworkConfig.allocRangeSpace=string&autoSubnetworkConfig.ipStack=SUBNET_IP_STACK_UNSPECIFIED&autoSubnetworkConfig.prefixLength=0&requestId=string&serviceConnectionPolicyId=string&subnetworkMode=SUBNETWORK_MODE_UNSPECIFIEDCreates a new ServiceConnectionPolicy in a given project and location.
projects.locations.serviceConnectionTokens
- GETLists ServiceConnectionTokens in a given project and location.
/v1/:parent/serviceConnectionTokens?filter=string&orderBy=string&pageSize=0&pageToken=stringLists ServiceConnectionTokens in a given project and location. - POSTCreates a new ServiceConnectionToken in a given project and location.
/v1/:parent/serviceConnectionTokens?requestId=string&serviceConnectionTokenId=stringCreates a new ServiceConnectionToken in a given project and location.
projects.locations.spokes.gatewayAdvertisedRoutes
- GETList GatewayAdvertisedRoutes
/v1/:parent/gatewayAdvertisedRoutes?filter=string&orderBy=string&pageSize=0&pageToken=stringList GatewayAdvertisedRoutes - POSTCreate a GatewayAdvertisedRoute
/v1/:parent/gatewayAdvertisedRoutes?gatewayAdvertisedRouteId=string&requestId=stringCreate a GatewayAdvertisedRoute
API details
- Base URL
https://networkconnectivity.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 50 operations on 34 pathsGET 26POST 22PATCH 1DELETE 1
- Main resources
- projects.locations.global.hubs 8projects.locations.spokes 5projects.locations.transports 5projects.locations 2projects.locations.automatedDnsRecords 2projects.locations.global.policyBasedRoutes 2projects.locations.internalRanges 2projects.locations.multicloudDataTransferConfigs 2projects.locations.multicloudDataTransferConfigs.destinatio… 2projects.locations.operations 2
- 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 Connectivity 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 Connectivity 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 “CheckConsumerConfig validates the consumer network and project for potential PSC connection creation” (POST /v1/:location:checkConsumerConfig), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Network Connectivity API?
This API enables connectivity with and between Google Cloud resources. It is listed under Developer tools and has 50 endpoints.
Who publishes the Network Connectivity 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 Connectivity API?
Requests go to https://networkconnectivity.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Network Connectivity 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 Connectivity API have?
50 operations on 34 paths (26 GET, 22 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.global.hubs, projects.locations.spokes, projects.locations.transports, projects.locations.
Is forking the Network Connectivity API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.