Create a NAT port-forwarding rule
Adds a port-forwarding rule that sends traffic arriving on a NAT gateway port to a private IP and port inside the VPC. Requires scope: network.write.
Authentication
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
Headers
Retry key for this create. Send the same key and the same body on every retry. The key is scoped to organization, workspace and path.
- Create completed: you get the original answer for 24 hours, even if the plan limit has since been reached.
- Refused or never sent: nothing was created, so the key is free to use again, including with a corrected body.
- Unknown outcome (timeout, server error, lost connection): 409
idempotency_in_progresswithRetry-After. This usually lasts 30 seconds and at most 3 minutes. Keep retrying with the same key and body. The next retry returns the Reserved IP, subnet or NAT gateway. For a VPC, firewall group or port forward, it either creates the resource or answers 409 “already exists”. - Changed body, while the outcome is unresolved or after the create completed: 409
idempotency_conflict. - New key at the plan limit: 402.
Query parameters
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
Port on the gateway’s public address (1-65535).
Port on the VM that receives the traffic (1-65535).
tcp(default)udp
vm: forward to one VM’s private IP. vip: forward to a Virtual IP announced by the VMs in target_vm_ids.
VMs that announce the Virtual IP. Required with vip, must be empty with vm.
Free-text note stored with the rule. Default empty.
Response
Port-forwarding rule created successfully.
Port on the gateway’s public address (1-65535).
Port on the VM that receives the traffic (1-65535).
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.
When the rule was created (ISO 8601).
When the rule was last changed (ISO 8601).
tcp(default)udp
vm: forward to one VM’s private IP. vip: forward to a Virtual IP announced by the VMs in target_vm_ids.
VMs that announce the Virtual IP. Required with vip, must be empty with vm.
Free-text note stored with the rule. Default empty.
Error detail when status is error.
