Swap the NAT gateway public IP
Replaces the NAT gateway’s public IP with a Reserved IP, keeping the port-forwarding rules, as the portal’s NAT card does. Requires scope: network.write.
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.
nat_gateway_id
NAT gateway ID.
Query parameters
workspace_id
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
This endpoint expects an object.
reserved_public_ip_id
Reserved IP to put on the gateway. Port-forwarding rules are preserved.
Response
NAT gateway updated.
nat_gateway_id
Unique ID of the gateway.
vpc_id
VPC the gateway serves.
site_id
Site the gateway lives at.
name
Display name of the gateway.
public_ip_id
ID of the public IP the gateway uses.
public_ip
Public IPv4 address of the gateway.
status
Lifecycle status of a VPC, subnet, NAT gateway or port-forwarding rule.
provisioning: being created.available: ready for use.error: the last change failed; seeerror_message.deleting: being removed.
Allowed values:
subnet_id
Subnet the gateway is placed in.
organization_id
ID of the owning organization.
workspace_id
ID of the owning workspace.
pricing
Price of a NAT gateway as recorded when it was created.
error_message
Error detail when status is error.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
423
Locked Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error
