Skip to navigation
API Referenceport-forwarding

Create a port forwarding rule for a public IP address

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

ipIdstringRequired
ID of the public IP address

Request

This endpoint expects an object.
privatePortstringRequired

Port on the VM that traffic is forwarded to. Must be 1-65535.

publicPortstringRequired

Port on the public IP that receives the inbound traffic. Must be 1-65535.

protocolenumRequired
Protocol the forwarding rule applies to.
Allowed values:
vmIdstringRequiredformat: "uuid"
Identifier of the VM the forwarded traffic is delivered to.
openFirewallstringOptional

When true, automatically creates a matching firewall rule alongside the port forwarding rule.

tierIdstringOptionalformat: "uuid"

For a public IP reserved in a VPC, the VPC tier the rule applies to. A VPC IP is not bound to any single tier, so the rule must target one. You only need to set this when the VM has interfaces in more than one tier of the VPC — otherwise the tier is determined automatically from the VM. Ignored for IPs reserved in an isolated network.

Response

The port forwarding rule has been created
idstringformat: "uuid"
Unique identifier for the port forwarding rule.
privatePortinteger
Port on the VM that traffic is forwarded to.
publicPortinteger
Port on the public IP that receives the inbound traffic.
protocolstring

Protocol the forwarding rule applies to. TCP or UDP.

vmIdstringformat: "uuid"
Identifier of the VM the forwarded traffic is delivered to.
vmNamestring
Name of the VM the forwarded traffic is delivered to.
ipAddressIdstringformat: "uuid"
Identifier of the public IP the rule is attached to.
ipAddressstringformat: "ipv4"
Public IP address the rule is attached to.
statestring
Current lifecycle state of the rule.
createdAtdatetimeOptional
When the rule was created.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error