Service Networking API
Provides automatic management of network configurations necessary for certain services.
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
Provides automatic management of network configurations necessary for certain services.
Endpoints 25
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…
services.projects.global.networks.dnsZones
- GETService producers can use this method to retrieve a DNS zone in the shared producer host project and the matching…
/v1/:nameService producers can use this method to retrieve a DNS zone in the shared producer host project and the matching peering zones in consumer project - GET* Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project…
/v1/:parent/dnsZones:list* Service producers can use this method to retrieve a list of available DNS zones in the shared producer host project and the matching peering zones in the…
services.connections
- POSTDeletes a private service access connection.
/v1/:nameDeletes a private service access connection. - PATCHUpdates the allocated ranges that are assigned to a connection.
/v1/:name?force=true&updateMask=stringUpdates the allocated ranges that are assigned to a connection. - GETList the private connections that are configured in a service consumer's VPC network.
/v1/:parent/connections?network=stringList the private connections that are configured in a service consumer's VPC network. - POSTCreates a private connection that establishes a VPC Network Peering connection to a VPC network in the service…
/v1/:parent/connectionsCreates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization. The administrator of…
services.projects.global.networks.peeredDnsDomains
- DELETEDeletes a peered DNS domain.
/v1/:nameDeletes a peered DNS domain. - GETLists peered DNS domains for a connection.
/v1/:parent/peeredDnsDomainsLists peered DNS domains for a connection. - POSTCreates a peered DNS domain which sends requests for records in given namespace originating in the service producer…
/v1/:parent/peeredDnsDomainsCreates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to…
services
- POSTFor service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and…
/v1/:parent:addSubnetworkFor service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed… - PATCHDisables VPC service controls for a connection.
/v1/:parent:disableVpcServiceControlsDisables VPC service controls for a connection. - PATCHEnables VPC service controls for a connection.
/v1/:parent:enableVpcServiceControlsEnables VPC service controls for a connection. - POSTService producers can use this method to find a currently unused range within consumer allocated ranges
/v1/:parent:searchRangeService producers can use this method to find a currently unused range within consumer allocated ranges. This returned range is not reserved, and not… - POSTService producers use this method to validate if the consumer provided network, project and requested range are valid
/v1/:parent:validateService producers use this method to validate if the consumer provided network, project and requested range are valid. This allows them to use a fail-fast…
services.dnsRecordSets
- POSTService producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.
/v1/:parent/dnsRecordSets:addService producers can use this method to add DNS record sets to private DNS zones in the shared producer host project. - GETProducers can use this method to retrieve information about the DNS record set added to the private zone inside the…
/v1/:parent/dnsRecordSets:get?consumerNetwork=string&domain=string&type=string&zone=stringProducers can use this method to retrieve information about the DNS record set added to the private zone inside the shared tenant host project associated with… - GETProducers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the…
/v1/:parent/dnsRecordSets:list?consumerNetwork=string&zone=stringProducers can use this method to retrieve a list of available DNS RecordSets available inside the private zone on the tenant host project accessible from… - POSTService producers can use this method to remove DNS record sets from private DNS zones in the shared producer host…
/v1/:parent/dnsRecordSets:removeService producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project. - POSTService producers can use this method to update DNS record sets from private DNS zones in the shared producer host…
/v1/:parent/dnsRecordSets:updateService producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.
services.dnsZones
- POSTService producers can use this method to add private DNS zones in the shared producer host project and matching…
/v1/:parent/dnsZones:addService producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project. - POSTService producers can use this method to remove private DNS zones in the shared producer host project and matching…
/v1/:parent/dnsZones:removeService producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.
services.projects.global.networks
- GETConsumers use this method to find out the state of VPC Service Controls
/v1/:name/vpcServiceControlsConsumers use this method to find out the state of VPC Service Controls. The controls could be enabled or disabled for a connection. - PATCHService producers use this method to update the configuration of their connection including the import/export of…
/v1/:parent:updateConsumerConfigService producers use this method to update the configuration of their connection including the import/export of custom routes and subnetwork routes with…
services.roles
- POSTService producers can use this method to add roles in the shared VPC host project
/v1/:parent/roles:addService producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from…
API details
- Base URL
https://servicenetworking.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 25 operations on 20 pathsPOST 13GET 7PATCH 4DELETE 1
- Main resources
- services 5services.dnsRecordSets 5services.connections 4services.projects.global.networks.peeredDnsDomains 3services.dnsZones 2services.projects.global.networks 2services.projects.global.networks.dnsZones 2operations 1services.roles 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 Service Networking 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 Service Networking API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Starts asynchronous cancellation on a long-running operation” (POST /v1/:name:cancel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Service Networking API?
Provides automatic management of network configurations necessary for certain services. It is listed under Developer tools and has 25 endpoints.
Who publishes the Service Networking 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 Service Networking API?
Requests go to https://servicenetworking.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Service Networking API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Service Networking API have?
25 operations on 20 paths (13 POST, 7 GET, 4 PATCH, 1 DELETE). The largest groups are services, services.dnsRecordSets, services.connections, services.projects.global.networks.peeredDnsDomains.
Is forking the Service Networking API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.