Create a VPC
Creates an isolated virtual network. Requires scope: network.write.
Authentication
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.
Headers
Retry key for this create. Send the same key and the same body on every retry. The key is scoped to organization, workspace and path.
- Create completed: you get the original answer for 24 hours, even if the plan limit has since been reached.
- Refused or never sent: nothing was created, so the key is free to use again, including with a corrected body.
- Unknown outcome (timeout, server error, lost connection): 409
idempotency_in_progresswithRetry-After. This usually lasts 30 seconds and at most 3 minutes. Keep retrying with the same key and body. The next retry returns the Reserved IP, subnet or NAT gateway. For a VPC, firewall group or port forward, it either creates the resource or answers 409 “already exists”. - Changed body, while the outcome is unresolved or after the create completed: 409
idempotency_conflict. - New key at the plan limit: 402.
Query parameters
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
Required network placement site. Copy site_id from GET /networking/sites and choose an entry where available is true. Do not use a region name.
RFC1918 IPv4 CIDR with a prefix between /22 and /28.
Let the service choose a free CIDR when cidr is omitted. Default true.
CIDR for that first subnet; chosen automatically when omitted.
The VPC’s internet model; the server uses public when this is omitted. public keeps dedicated public IPs available to its VMs. private has no shared public edge, but a VM can still be given a Reserved IP. nat_gateway is a private VPC with managed outbound NAT and refuses dedicated public IPs.
Response
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.
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.
When the resource was created (ISO 8601).
When the resource was last changed (ISO 8601).
Legacy alias of organization_id.
Error detail when status is error.
