Cosmic User API Reference

updatePortForwardingRule

Updates a port forwarding rule. Only the private port and the virtual machine can be updated.

Request parameters

Parameter NameDescriptionRequired
idthe ID of the port forwarding ruletrue
customidan optional field, in case you want to set a custom id to the resource. Allowed to Root Admins onlyfalse
fordisplayan optional field, whether to the display the rule to the end user or notfalse
privateportthe private port of the port forwarding rulefalse
virtualmachineidthe ID of the virtual machine for the port forwarding rulefalse
vmguestipVM guest nic Secondary ip address for the port forwarding rulefalse

Response Tags

Response NameDescription
idthe ID of the port forwarding rule
cidrlistthe cidr list to forward traffic from
fordisplayis firewall for display to the regular user
ipaddressthe public ip address for the port forwarding rule
ipaddressidthe public ip address id for the port forwarding rule
networkidthe id of the guest network the port forwarding rule belongs to
privateendportthe ending port of port forwarding rule's private port range
privateportthe starting port of port forwarding rule's private port range
protocolthe protocol of the port forwarding rule
publicendportthe ending port of port forwarding rule's private port range
publicportthe starting port of port forwarding rule's public port range
statethe state of the rule
virtualmachinedisplaynamethe VM display name for the port forwarding rule
virtualmachineidthe VM ID for the port forwarding rule
virtualmachinenamethe VM name for the port forwarding rule
vmguestipthe vm ip address for the port forwarding rule
tags(*)the list of resource tags associated with the rule
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value