API ReferenceVpcs

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_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

site_idstringOptional

Optional exact site filter. Copy site_id from GET /networking/sites.

Response

VPCs returned successfully.
vpc_idstring
organization_idstring
workspace_idstring
site_idstring
namestring
cidrstring
statusenum
connectivity_typeenum
created_atdatetime
updated_atdatetime
account_idstringOptional
descriptionstringOptional
regionstring or nullOptional
is_defaultbooleanOptional
error_messagestring or nullOptional
node_countintegerOptional>=0
nat_pricingobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error