List nodes attached to a VPC
Lists the VMs attached to a VPC. 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_id
VPC ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Response
Attached nodes returned successfully.
allocation_id
Unique ID of the attachment.
vpc_id
VPC the VM is attached to.
subnet_id
Subnet the VM is attached to.
vm_id
ID of the attached VM.
connectivity
How the VM reaches the internet from this subnet.
private: no internet path.public_ip: a Reserved IP is attached to the allocation.nat: outbound traffic goes through the VPC’s NAT gateway.
Allowed values:
private_ip
Private IPv4 address assigned to the VM.
prefix_length
Prefix length of the subnet.
subnet_mask
Subnet mask in dotted-decimal form.
gateway
Gateway IPv4 address of the subnet.
dns
DNS resolvers handed to the VM.
status
Attachment state: reserved, attaching, attached, moving, detaching or releasing.
public_ip_id
Reserved IP attached to the allocation, when connectivity is public_ip.
public_ip
Address of that Reserved IP.
nat_gateway_id
NAT gateway used, when connectivity is nat.
nat_public_ip
Public address of that NAT gateway.
Errors
401
Unauthorized Error
403
Forbidden 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
