Get a VPC | ibee | Documentation

{
  "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"
    }
  ]
}

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

Authentication

AuthorizationBearer

IBEE platform API token, for example: ibee_live_xxx.

Path parameters

vpc_idstringRequired

VPC ID.

Query parameters

workspace_idstringRequired

The workspace ID to scope this request to.

Response

VPC returned successfully.

vpc_idstring

organization_idstring

workspace_idstring

site_idstring

namestring

cidrstring

statusenum

connectivity_typeenum

created_atdatetime

updated_atdatetime

account_idstring

descriptionstring

regionstring or null

is_defaultboolean

error_messagestring or null

node_countinteger>=0

nat_pricingobject

subnetslist of objects

nat_gatewayslist of objects

attached_nodeslist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

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