Network API

Network API

Create isolated regional routing domains and negotiate approved peering connections.

The Network API manages project routing domains. Subnets, interfaces, routes, and firewall policies remain separate resources with their own revisions.

POST/organizations/{organization_id}/projects/{project_id}/networks
Scope
networks:write
Auth
Bearer API key
Repeat calls
Reuse the request key after a lost creation response.

Creates an isolated regional network without user subnets or external routes.

Network request
namestringrequired
Display name after trimming surrounding whitespace.
rule1–128 characters
region_idstringrequired
Permitted region; immutable after creation.
dnsobjectoptional
Optional resolver_addresses and search_domains. An empty resolver list is invalid.
defaultRegional resolver configuration
labelsobjectoptional
String-pair selectors and ownership labels.
default{}

Returns 202 with the network ID and realization operation. A created network has no user subnet until one is explicitly added. It has no external default route merely because it exists.

Read and edit

GET/organizations/{organization_id}/projects/{project_id}/networks/{network_id}
Scope
networks:read
Auth
Bearer API key

Returns configuration, subnet IDs, dependency counts, applied revision, health, and its ETag. Requires networks:read.

GET/organizations/{organization_id}/projects/{project_id}/networks
Scope
networks:read
Auth
Bearer API key

Lists networks using the selected region and label filters.

The list supports region_id and label filters.

PATCH/organizations/{organization_id}/projects/{project_id}/networks/{network_id}
Scope
networks:write
Auth
Bearer API key

Updates mutable network configuration.

Requires networks:write and If-Match. Name, DNS settings, and labels are writable. Omitted fields remain unchanged; supplied arrays replace their whole value. Region changes and inline mutation of child resources are rejected.

Peering request

POST/organizations/{organization_id}/projects/{project_id}/networks/{network_id}/peerings
Scope
networks:write
Auth
Bearer API key

Creates a peering request awaiting the remote project's approval.

Accepts remote_network_id and export_subnet_ids. It returns 201 with a pending connection, the proposed export set, and the remote project approval requirement.

POST/organizations/{organization_id}/projects/{project_id}/networks/{network_id}/peerings/{peering_id}/accept
Scope
networks:write
Auth
Bearer API key

Accepts the proposed peering and requests route realization.

Requires the current peering ETag in If-Match and the accepting side's export_subnet_ids. The caller must have peer administration permission on that side. Successful acceptance returns 202 and a route-realization operation.

Overlapping exported ranges return 422 overlapping_prefix. A rejected or pending request installs no forwarding path. A permitted peer route remains subject to both projects' firewall policies.

Withdraw and remove

DELETE/organizations/{organization_id}/projects/{project_id}/networks/{network_id}/peerings/{peering_id}
Scope
networks:write
Auth
Bearer API key

Withdraws that connection and returns 202. Either authorized side can request withdrawal. The operation reports applied state separately on both sides; existing sessions can break.

DELETE/organizations/{organization_id}/projects/{project_id}/networks/{network_id}
Scope
networks:write
Auth
Bearer API key

Deletes a network after its dependencies are removed.

Deleting a network requires its current ETag and no remaining interfaces, subnets, services, gateways, or connections. Dependencies return 409 network_in_use with blocking IDs. Accepted network removal returns 202.

See network peering for non-transitive routing, Subnet API for ranges, and Interface API for guest attachments.

VPC and hybrid attachment resources

POST/organizations/{organization_id}/projects/{project_id}/vpcs
Scope
networks:write
Auth
Bearer API key

Creates VPC policy membership for permitted regional networks.

Accepts a name and permitted regional network_ids. It records policy membership without creating inter-segment forwarding. Connection policies are explicit child resources and require the VPC ETag for changes.

POST/organizations/{organization_id}/projects/{project_id}/private-connections
Scope
networks:write
Auth
Bearer API key

Requests a private connection with an approved routing definition.

Accepts the regional network, circuit or gateway reference, approved prefix set, and supported static or BGP routing definition. Accepted provisioning returns 202; physical handoff and route activation have separate observed states.

These resources require networks:write plus regional connectivity permission. Overlapping exported ranges and unsupported transit return 422 without a new forwarding path. See VPC segments and private connectivity.