Skip to navigation

List NAT gateways

Lists the managed NAT gateways in a VPC. 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
curl "https://api.ibee.ai/v1/networking/vpcs/$VPC_ID/nat-gateways?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.

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

NAT gateways returned successfully.
nat_gateway_idstring
Unique ID of the gateway.
vpc_idstring
VPC the gateway serves.
site_idstring
Site the gateway lives at.
namestring
Display name of the gateway.
public_ip_idstring
ID of the public IP the gateway uses.
public_ipstring
Public IPv4 address of the gateway.
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:
subnet_idstring or nullOptional
Subnet the gateway is placed in.
organization_idstringOptional
ID of the owning organization.
workspace_idstringOptional
ID of the owning workspace.
pricingobjectOptional
Price of a NAT gateway as recorded when it was created.
error_messagestring or nullOptional

Error detail when status is error.

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