API ReferenceVpcs

Create a NAT gateway

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.

Request

This endpoint expects an object.
subnet_idstring or nullOptional
reserved_public_ip_idstring or nullOptional
namestringOptional1-80 charactersDefaults to NAT Gateway

Response

NAT gateway created successfully.
nat_gateway_idstring
vpc_idstring
site_idstring
namestring
public_ip_idstring
public_ipstring
statusenum
subnet_idstring or nullOptional
organization_idstringOptional
workspace_idstringOptional
pricingobjectOptional
error_messagestring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error