Cosmic User API Reference
updatePortForwardingRule
Updates a port forwarding rule. Only the private port and the virtual machine can be updated.
Request parameters
| Parameter Name | Description | Required |
| id | the ID of the port forwarding rule | true |
| customid | an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only | false |
| fordisplay | an optional field, whether to the display the rule to the end user or not | false |
| privateport | the private port of the port forwarding rule | false |
| virtualmachineid | the ID of the virtual machine for the port forwarding rule | false |
| vmguestip | VM guest nic Secondary ip address for the port forwarding rule | false |
Response Tags
| Response Name | Description |
| id | the ID of the port forwarding rule |
| cidrlist | the cidr list to forward traffic from |
| fordisplay | is firewall for display to the regular user |
| ipaddress | the public ip address for the port forwarding rule |
| ipaddressid | the public ip address id for the port forwarding rule |
| networkid | the id of the guest network the port forwarding rule belongs to |
| privateendport | the ending port of port forwarding rule's private port range |
| privateport | the starting port of port forwarding rule's private port range |
| protocol | the protocol of the port forwarding rule |
| publicendport | the ending port of port forwarding rule's private port range |
| publicport | the starting port of port forwarding rule's public port range |
| state | the state of the rule |
| virtualmachinedisplayname | the VM display name for the port forwarding rule |
| virtualmachineid | the VM ID for the port forwarding rule |
| virtualmachinename | the VM name for the port forwarding rule |
| vmguestip | the vm ip address for the port forwarding rule |
| tags(*) | the list of resource tags associated with the rule |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| key | tag key name |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |