Skip to navigation

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.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# VPC_ID: VPC ID
# NAT_GATEWAY_ID: NAT gateway ID
curl -X POST "https://api.ibee.ai/v1/networking/vpcs/$VPC_ID/nat-gateways/$NAT_GATEWAY_ID/port-forwarding-rules?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name": "<name>", "external_port": 1, "internal_ip": "<internal_ip>", "internal_port": 1}'

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.
nat_gateway_idstringRequired
NAT gateway ID.

Headers

X-Idempotency-KeystringOptionalformat: "^[!-~]{1,256}$"1-256 characters

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_progress with Retry-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

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.
namestringRequired1-80 characters
Display name of the rule.
external_portintegerRequired1-65535

Port on the gateway’s public address (1-65535).

internal_ipstringRequired
Private IPv4 address of the VM inside the VPC that receives the traffic.
internal_portintegerRequired1-65535

Port on the VM that receives the traffic (1-65535).

protocolenumOptionalDefaults to tcp
  • tcp (default)
  • udp
Allowed values:
target_typeenumOptionalDefaults to vm

vm: forward to one VM’s private IP. vip: forward to a Virtual IP announced by the VMs in target_vm_ids.

Allowed values:
target_vm_idslist of stringsOptional

VMs that announce the Virtual IP. Required with vip, must be empty with vm.

notestringOptional<=500 charactersDefaults to

Free-text note stored with the rule. Default empty.

enabledbooleanOptionalDefaults to true
Whether the rule is applied. Default true.

Response

Port-forwarding rule created successfully.

namestring1-80 characters
Display name of the rule.
external_portinteger1-65535

Port on the gateway’s public address (1-65535).

internal_ipstring
Private IPv4 address of the VM inside the VPC that receives the traffic.
internal_portinteger1-65535

Port on the VM that receives the traffic (1-65535).

port_forward_rule_idstring
Unique ID of the rule.
vpc_idstring
VPC the rule belongs to.
nat_gateway_idstring
NAT gateway the rule is configured on.
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:
created_atdatetime

When the rule was created (ISO 8601).

updated_atdatetime

When the rule was last changed (ISO 8601).

protocolenumOptionalDefaults to tcp
  • tcp (default)
  • udp
Allowed values:
target_typeenumOptionalDefaults to vm

vm: forward to one VM’s private IP. vip: forward to a Virtual IP announced by the VMs in target_vm_ids.

Allowed values:
target_vm_idslist of stringsOptional

VMs that announce the Virtual IP. Required with vip, must be empty with vm.

notestringOptional<=500 charactersDefaults to

Free-text note stored with the rule. Default empty.

enabledbooleanOptionalDefaults to true
Whether the rule is applied. Default true.
organization_idstringOptional
ID of the owning organization.
workspace_idstringOptional
ID of the owning workspace.
site_idstringOptional
Site the gateway lives at.
error_messagestring or nullOptional

Error detail when status is error.

Errors

400
Bad Request Error
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