> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.ibee.co.in/docs/api-reference/vpcs/get-vpc/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ibee.co.in/_mcp/server. # Get a VPC GET https://api.ibee.co.in/v1/networking/vpcs/{vpc_id} Returns a VPC and its subnets, NAT gateways, and attached nodes. Requires scope: network.read. Reference: https://docs.ibee.co.in/docs/api-reference/vpcs/get-vpc ## Authentication - `Authorization` header (bearer token, required) — 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. ## Servers - `https://api.ibee.co.in/v1` (Production, default) - `https://api.ibee.co.in/v1` (Development) ## Request ### Path parameters - `vpc_id` (string, required) — VPC ID. ### Query parameters - `workspace_id` (string, required) — The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected. ## Response ### 200 VPC returned successfully. - `vpc_id` (string, required) - `organization_id` (string, required) - `workspace_id` (string, required) - `site_id` (string, required) - `name` (string, required) - `cidr` (string, required) - `status` (enum, required) - Allowed values: `provisioning`, `available`, `error`, `deleting` - `connectivity_type` (enum, required) - Allowed values: `public`, `nat_gateway` - `created_at` (datetime, required) - `updated_at` (datetime, required) - `account_id` (string, optional) - `description` (string, optional) - `region` (string, optional, nullable) - `is_default` (boolean, optional) - `error_message` (string, optional, nullable) - `node_count` (integer, optional) - `nat_pricing` (NatPricing, optional) - `subnets` (list of Subnet, optional) - `nat_gateways` (list of NatGateway, optional) - `attached_nodes` (list of VpcAttachedNode, optional) ## Errors ### 401 Unauthorized Error The API token is missing or invalid. - `detail` (ErrorDetail, optional) ### 403 Forbidden Error The token is not allowed to access the workspace or does not have the required scope. - `detail` (ErrorDetail, optional) ### 404 Not Found Error The requested resource was not found. - `detail` (ErrorDetail, optional) ## Types ### NatPricing - `currency` (string, optional, default: USD) - `price_per_hour` (double, optional, default: 0) - `data_price_per_gb` (double, optional, default: 0) - `billing_enforced` (boolean, optional, default: false) ### Subnet - `subnet_id` (string, required) - `vpc_id` (string, required) - `site_id` (string, required) - `name` (string, required) - `cidr` (string, required) - `gateway` (string, required) - `dns` (list of string, required) - `status` (enum, required) - Allowed values: `provisioning`, `available`, `error`, `deleting` - `created_at` (datetime, required) - `updated_at` (datetime, required) - `organization_id` (string, optional) - `workspace_id` (string, optional) - `error_message` (string, optional, nullable) ### NatGateway - `nat_gateway_id` (string, required) - `vpc_id` (string, required) - `site_id` (string, required) - `name` (string, required) - `public_ip_id` (string, required) - `public_ip` (string, required) - `status` (enum, required) - Allowed values: `provisioning`, `available`, `error`, `deleting` - `subnet_id` (string, optional, nullable) - `organization_id` (string, optional) - `workspace_id` (string, optional) - `pricing` (NatPricing, optional) - `error_message` (string, optional, nullable) ### VpcAttachedNode - `allocation_id` (string, optional) - `vm_id` (string, optional) - `subnet_id` (string, optional) - `private_ip` (string, optional) - `connectivity` (enum, optional) - Allowed values: `private`, `public_ip`, `nat` - `public_ip` (string, optional, nullable) - `nat_public_ip` (string, optional, nullable) - `status` (string, optional) - `attached_at` (datetime, optional) ### ErrorDetail ## Examples **Response** ```json { "vpc_id": "string", "organization_id": "string", "workspace_id": "string", "site_id": "string", "name": "string", "cidr": "string", "status": "provisioning", "connectivity_type": "public", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "account_id": "string", "description": "string", "region": "string", "is_default": true, "error_message": "string", "node_count": 1, "nat_pricing": { "currency": "USD", "price_per_hour": 0, "data_price_per_gb": 0, "billing_enforced": false }, "subnets": [ { "subnet_id": "string", "vpc_id": "string", "site_id": "string", "name": "string", "cidr": "string", "gateway": "string", "dns": [ "string" ], "status": "provisioning", "created_at": "2024-01-15T09:30:00Z", "updated_at": "2024-01-15T09:30:00Z", "organization_id": "string", "workspace_id": "string", "error_message": "string" } ], "nat_gateways": [ { "nat_gateway_id": "string", "vpc_id": "string", "site_id": "string", "name": "string", "public_ip_id": "string", "public_ip": "string", "status": "provisioning", "subnet_id": "string", "organization_id": "string", "workspace_id": "string", "pricing": { "currency": "USD", "price_per_hour": 0, "data_price_per_gb": 0, "billing_enforced": false }, "error_message": "string" } ], "attached_nodes": [ { "allocation_id": "string", "vm_id": "string", "subnet_id": "string", "private_ip": "string", "connectivity": "private", "public_ip": "string", "nat_public_ip": "string", "status": "string", "attached_at": "2024-01-15T09:30:00Z" } ] } ``` **SDK Code** ```python import requests url = "https://api.ibee.co.in/v1/networking/vpcs/vpc_id" querystring = {"workspace_id":"710995"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.ibee.co.in/v1/networking/vpcs/vpc_id?workspace_id=710995")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```