VPC API

Private networking (VPCs and peers)

REST API endpoints for VPC. 8 operations.

List VPCs

GET /v1/vpc

Returns all VPCs belonging to the caller's project.

Auth: Bearer API key

Responses

operationId: listVpcs

Create a VPC

POST /v1/vpc

Provisions a VPC for the caller's project. Currently returns 501 — enforcement and durable storage are a planned capability.

Auth: Bearer API key

Request body

application/json (required) — schema CreateVpcBody.

Responses

operationId: createVpc

Delete a VPC

DELETE /v1/vpc/{id}

Removes a VPC and its peers by id.

Auth: Bearer API key

Parameters

Responses

operationId: deleteVpc

Get a VPC

GET /v1/vpc/{id}

Returns a single VPC by id.

Auth: Bearer API key

Parameters

Responses

operationId: getVpc

Get a VPC's config

GET /v1/vpc/{id}/config

Returns the rendered VPN client configuration file for the VPC.

Auth: Bearer API key

Parameters

Responses

operationId: getVpcConfig

List a VPC's peers

GET /v1/vpc/{id}/peers

Returns all peers registered in the VPC.

Auth: Bearer API key

Parameters

Responses

operationId: listVpcPeers

Add a peer to a VPC

POST /v1/vpc/{id}/peers

Registers a peer in the VPC. Currently returns 501 — peer enforcement and durable storage are a planned capability.

Auth: Bearer API key

Parameters

Request body

application/json (required) — schema AddPeerBody.

Responses

operationId: addVpcPeer

Remove a peer from a VPC

DELETE /v1/vpc/{id}/peers/{peer_id}

Deletes a peer from the VPC by id.

Auth: Bearer API key

Parameters

Responses

operationId: removeVpcPeer