List VPCs
Lists VPCs in the selected workspace. Requires scope: network.read.
Authentication
AuthorizationBearer
IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
site_id
Optional exact site filter. Copy site_id from GET /networking/sites.
Response
VPCs returned successfully.
vpc_id
Unique ID of the VPC.
organization_id
ID of the owning organization.
workspace_id
ID of the owning workspace.
site_id
Site the VPC lives at.
name
Display name of the VPC.
cidr
IPv4 CIDR of the VPC.
status
Lifecycle status of a VPC, subnet, NAT gateway or port-forwarding rule.
provisioning: being created.available: ready for use.error: the last change failed; seeerror_message.deleting: being removed.
Allowed values:
connectivity_type
The VPC’s internet model.
public: instances may have dedicated public IPs.nat_gateway: private VPC with managed outbound NAT; dedicated public IPs are not allowed.private: no managed internet path.
Allowed values:
created_at
When the resource was created (ISO 8601).
updated_at
When the resource was last changed (ISO 8601).
account_id
Legacy alias of organization_id.
description
Description of the VPC.
region
Region label stored with the VPC, when set.
is_default
Whether this is the workspace's default VPC.
error_message
Error detail when status is error.
node_count
Number of VMs attached to the VPC.
nat_pricing
Price of a NAT gateway as recorded when it was created.
Errors
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
