Get a VPC

GET

/networking/vpcs/:vpc_id

GET

/v1/networking/vpcs/:vpc_id

$ curl -G https://api.ibee.ai/v1/networking/vpcs/vpc_id \
>      -H "Authorization: Bearer <token>" \
>      -d workspace_id=710995

1 {
2   "vpc_id": "string",
3   "organization_id": "string",
4   "workspace_id": "string",
5   "site_id": "string",
6   "name": "string",
7   "cidr": "string",
8   "status": "provisioning",
9   "connectivity_type": "public",
10   "created_at": "2024-01-15T09:30:00Z",
11   "updated_at": "2024-01-15T09:30:00Z",
12   "account_id": "string",
13   "description": "string",
14   "region": "string",
15   "is_default": true,
16   "error_message": "string",
17   "node_count": 1,
18   "nat_pricing": {
19     "currency": "USD",
20     "price_per_hour": 0,
21     "data_price_per_gb": 0,
22     "billing_enforced": false
23   },
24   "subnets": [
25     {
26       "subnet_id": "string",
27       "vpc_id": "string",
28       "site_id": "string",
29       "name": "string",
30       "cidr": "string",
31       "gateway": "string",
32       "dns": [
33         "string"
34       ],
35       "status": "provisioning",
36       "created_at": "2024-01-15T09:30:00Z",
37       "updated_at": "2024-01-15T09:30:00Z",
38       "organization_id": "string",
39       "workspace_id": "string",
40       "error_message": "string"
41     }
42   ],
43   "nat_gateways": [
44     {
45       "nat_gateway_id": "string",
46       "vpc_id": "string",
47       "site_id": "string",
48       "name": "string",
49       "public_ip_id": "string",
50       "public_ip": "string",
51       "status": "provisioning",
52       "subnet_id": "string",
53       "organization_id": "string",
54       "workspace_id": "string",
55       "pricing": {
56         "currency": "USD",
57         "price_per_hour": 0,
58         "data_price_per_gb": 0,
59         "billing_enforced": false
60       },
61       "error_message": "string"
62     }
63   ],
64   "attached_nodes": [
65     {
66       "allocation_id": "string",
67       "vm_id": "string",
68       "subnet_id": "string",
69       "private_ip": "string",
70       "connectivity": "private",
71       "public_ip": "string",
72       "nat_public_ip": "string",
73       "status": "string",
74       "attached_at": "2024-01-15T09:30:00Z"
75     }
76   ]
77 }

Returns a VPC and its subnets, NAT gateways, and attached nodes. 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.

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

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

subnetslist of objectsOptional

nat_gatewayslist of objectsOptional

attached_nodeslist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error