Skip to navigation

Get a VPC

Returns a VPC and its subnets, NAT gateways, and attached nodes. Requires scope: network.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VPC_ID: VPC ID
curl "https://api.ibee.ai/v1/networking/vpcs/$VPC_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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.

Path parameters

vpc_idstringRequired
VPC ID.

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.

Response

VPC returned successfully.
vpc_idstring
Unique ID of the VPC.
organization_idstring
ID of the owning organization.
workspace_idstring
ID of the owning workspace.
site_idstring
Site the VPC lives at.
namestring
Display name of the VPC.
cidrstring
IPv4 CIDR of the VPC.
statusenum

Lifecycle status of a VPC, subnet, NAT gateway or port-forwarding rule.

  • provisioning: being created.
  • available: ready for use.
  • error: the last change failed; see error_message.
  • deleting: being removed.
Allowed values:
connectivity_typeenum

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_atdatetime

When the resource was created (ISO 8601).

updated_atdatetime

When the resource was last changed (ISO 8601).

account_idstringOptional

Legacy alias of organization_id.

descriptionstringOptional
Description of the VPC.
regionstring or nullOptional
Region label stored with the VPC, when set.
is_defaultbooleanOptional
Whether this is the workspace's default VPC.
error_messagestring or nullOptional

Error detail when status is error.

node_countintegerOptional>=0
Number of VMs attached to the VPC.
nat_pricingobjectOptional
Price of a NAT gateway as recorded when it was created.
subnetslist of objectsOptional
Subnets in the VPC.
nat_gatewayslist of objectsOptional
NAT gateways in the VPC.
attached_nodeslist of objectsOptional
VMs attached to the VPC.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found 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