The update command updates a Load Balancer Rule.

JSON Input Data Format
{
    "id": string,
    "name": string,
    "type": string,
    "balance": string,
    "sourceurl": string,
    "sourceport": integer,
    "destinations": string
}
id * Specifies the ID of the Rule that will be updated.
name * Specifies the name for the Rule, which can be any name.
type * Specifies the type of the rule, which includes:
  • http-http
    Is specified for a domain reverse proxy that listens on port 80 and forwards it using the HTTP protocol.
  • http-https
    Is specified for a domain reverse proxy that listens on port 80 and forwards it using the HTTPS protocol.
  • https-http
    Is specified for a domain reverse proxy that listens on port 443 and forwards it using the HTTP protocol.
  • https-https
    Is specified for a domain reverse proxy that listens on port 443 and forwards it using the HTTPS protocol.
  • tcp
    Is specified for port forwarding, which listens on the given port and forwards traffic using the TCP protocol.
  • udp
    Is specified for port forwarding, which listens on the given port and forwards traffic using the UDP protocol.
balance * Specifies the balancer type of the rule, which includes:
  • single
    Is specified if your rule is forwarding to only one destination.
  • round
    Is specified if your rule is forwarding to multiple destinations using the Round-Robin algorithm.
  • leastconn
    Is specified if your rule is forwarding to multiple destinations using the Least-Connections algorithm.
sourceurl * Specifies the domain URL for which the rule will be set up. If the type is set to TCP or UDP, this property will be ignored.
sourceport * Specifies the port number that will be allocated on the Sky Node for the rule. If the type is set to http*, this property will be ignored.
destinations * Specifies a list of comma-separated server destinations in the format "IP:PORT" to which the rule will forward (balance) traffic. For example: "10.1.0.200:8080,10.1.0.201:8080".
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "The process was successfully completed"
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}