Update a NAT port-forwarding rule
Changes a NAT port-forwarding rule’s ports, target, protocol, or enabled state. 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
NAT port-forwarding rule ID.
Query parameters
The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.
Request
tcpudp
Port on the gateway’s public address (1-65535).
Port on the VM that receives the traffic (1-65535).
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.
Response
Port-forwarding rule updated 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.
