Skip to navigation

Get a VPC subnet

Returns one subnet in a VPC, including its CIDR range, gateway, and DNS settings. Requires scope: network.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VPC_ID: VPC ID
# SUBNET_ID: Subnet ID
curl "https://api.ibee.ai/v1/networking/vpcs/$VPC_ID/subnets/$SUBNET_ID?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

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.
subnet_idstringRequired
Subnet 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

Subnet returned successfully.
subnet_idstring
Unique ID of the subnet.
vpc_idstring
VPC the subnet belongs to.
site_idstring
Site the subnet lives at.
namestring
Display name of the subnet.
cidrstring
IPv4 CIDR of the subnet.
gatewaystring
Gateway IPv4 address of the subnet.
dnslist of strings
DNS resolvers handed to instances in the subnet.
statusenum

Lifecycle status of a VPC, subnet, NAT gateway or port-forwarding rule.

  • provisioning: being created.
  • available: ready for use.
  • error: the last change failed; see error_message.
  • deleting: being removed.
Allowed values:
created_atdatetime

When the resource was created (ISO 8601).

updated_atdatetime

When the resource was last changed (ISO 8601).

organization_idstringOptional
ID of the owning organization.
workspace_idstringOptional
ID of the owning workspace.
error_messagestring or nullOptional

Error detail when status is error.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found 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