Details of API functions
Details of API functionalities
Details of API functionalities
Description of the different input points in the API for the Load Balancer OVH.
Details of the API functionality for the Load Balancer OVH
Caution, for compatibility reasons, the entry point of the former system Load Balancer OVH is always present in the API /ip/loadBalancing, not to be confused with the new /ipLoadbalancing.
In the calls below all fields marked with an asterisk * are mandatory.
The Frontend, Farm and Server are specific to the protocol (among HTTP, TCP or UDP) in which they are defined. Although they can be "combined" with each other, this is only possible within of the same protocol. Thus, it is not possible to use a Frontend UDP with an HTTP Farm. But it is possible (in the absence of other limitation) to use an HTTP Frontend with an HTTP Farm.
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
Ip *
displayName
The name you want to give to the service (String of characters)
sslConfiguration
The SSL configuration you want to assign to the service (Value)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
vrackNetworkId
Allows filtering according to the vrack network
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
Service *
automatic
Enables automatic service renewal (Boolean))
deleteAtExpiration
Enables the deletion of the service upon expiration. (Boolean)
forced
Forces automatic renewal (Boolean)
period
Fill in the renewal term (String of characters)
serviceName *
The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
name *
The name of the requested zone
The service will be discontinued on the expiry date.
serviceName *
The identifier of your Load Balancer, for exemple : "loadbalancer-abcdef0123456789" (String of characters)
name *
The service will be discontinued on the expiry date.
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
name *
The name of the zone to be deleted
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
zone
The name of the zone (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
zone *
The name of the zone (String of characters)
displayName
The name you wish to give to your farm (String of characters)
balance
Your farm's load distribution method (Value)
port
The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
stickiness
The type of connection persistence to use for your farm (Value)
probe
The type of probe to use on your farm (Probe HTTP)
- forceSsl
SSL activation is forced for the probe (Boolean)
- interval
The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
- match
The method of correspondence used. default' uses the standard behavior of HAProxy. status' is only supported for HTTP probes (value) [contains, default, internal, matches, status]
- negate
The behavior of the 'match' operator is reversed (Boolean)
- method
The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
- pattern
The format of the server response when "UP". Empty for 'default', comma separated status list for 'status', text for 'contains', regular expression for 'matches' (String of characters)
- port
The port that the probe should use to test the servers attached to your farm. Ignored for 'oco' probes. If not defined, the farm port is used (Number)
- type
The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
- url
The address to be used by the probe for HTTP type probes. The type is ignored if this parameter is set to (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your HTTP farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your HTTP farm (Number)
BackendHttp *
displayName
The name of the farm (String of characters)
balance
The type of load distribution (Value)
port
The farm's listening port (Number, 1..65000)
probe
The type of probe to be used (HTTP probe)
stickiness
The type of connection persistence (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your HTTP farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your HTTP farm (Number)
cookie
Filter Values by Cookie (String of characters)
address
Filter Values by IPv4 address (IPv4)
status
Filter Values by server status (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
address *
The IPv4 address of your server (IPv4)
backup
If your server is configured as a backup server (Boolean)
chain
The Value of the Intermediate SSL Certificate (String of characters)
cookie
The Value of your Cookie (String of characters)
displayName
The name given to your server (String of characters)
port
The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
probe
The type of probe to be used (Value)
proxyProtocolVersion
The proxyProtocol version to use, see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
ssl *
If the requests sent to your servers need to be encrypted with SSL (Boolean)
weight *
The weight of your server for your farm. A server with high weight receives more requests (Number)
status *
If your server is activated or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server-link (Number)
farmId *
The identifier of your farm (Number)
BackendHttpServer *
backup
If your server is configured as a backup server (Boolean)
chain
The Value of the Intermediate SSL Certificate (String of characters)
cookie
The Value of your Cookie (String of characters)
displayName
The name of your server (String of characters)
port
The listening port of your server (Number, 1..65535)
probe
The type of probe to be used (Value)
proxyProtocolVersion
The proxyProtocol version to use, see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
ssl
If the requests sent to your servers need to be encrypted with SSL (Boolean)
status
If your server is activated or not (Boolean)
weight
The weight of your server for your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
defaultFarmId
The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
port
The listening port on your frontend (Number, 1..65535)
zone
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
allowedSource
The list of client IP addresses that have access to the Load Balancer (IPv4)
NB: the filtering is done at the Load Balancer level, so if the Load Balancer and the servers are not in a vRack, your servers are directly accessible from the Internet.
dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
defaultFarmId
The default HTTP farm identifier for your frontend (Number)
defaultSslId
The default SSL Certificate ID (Number)
disabled
If your HTTP frontend is disabled or enabled (Boolean)
displayName
The name of your HTTP frontend (String of characters)
hsts
If support for https strict, HTTP Strict Transport Security is enabled or disabled (Boolean)
httpHeader
The custom http header to add (String of characters)
port *
The listening port on your frontend (Number, 1..65535)
redirectLocation
The redirection URL http (String of characters)
ssl
Whether requests sent to the HTTP farm should be encrypted with SSL or not (Boolean)
zone *
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your HTTP frontend (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your HTTP frontend (Number)
FrontendHttp *
allowedSource
The list of client IP addresses that have access to the Load Balancer (IPv4[])
NB: the filtering is done at the Load Balancer level, so if the Load Balancer and the servers are not in a vRack, your servers are directly accessible from the Internet.
dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
defaultSslId
The default SSL Certificate ID (Number)
disabled
If your HTTP frontend is disabled or enabled (Boolean)
displayName
The name of your HTTP frontend (String of characters)
hsts
If support for https strict, HTTP Strict Transport Security is enabled or disabled (Boolean)
httpHeader
The custom http header to add (String of characters)
ssl
Whether requests sent to the HTTP farm should be encrypted with SSL or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend (Number)
Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route.
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId
The identifier of an HTTP frontend (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
action *
The action triggered when all the rules of your route are validated (RouteHttpAction)
- status
The expected HTTP return code (Number)
- target
The farm identifier, or the template for the URL (String of characters)
- type
The action on your route (String of characters)
displayName
The name of your route (String of characters)
frontendId
The Identifier of the HTTP frontend for which your route is applied (Number)
weight
The priority of your route. (Number) [0 - 255]
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
routeHttp *
action *
The action triggered when all the rules of your route are validated (RouteHttpAction)
- status
The expected HTTP return code (Number)
- target
The farm identifier, or the template for the URL (String of characters)
- type
The action on your route (String of characters)
displayName
The name of your route (String of characters)
frontendId
The Identifier of the HTTP frontend for which your route is applied (Number)
weight
The priority of your route. (Number) [0 - 255]
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your HTTP route (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your HTTP route (Number)
field *
The name of the field to be tested with the "match" operator (String of characters)
match *
The comparison operator (value) (contains, endsWith, exists, in, internal, is, matches, startsWith)
negate
The behavior of the operator :code:
match
is reversed (Boolean)pattern
The schema or the regular expression used by the "match" operator (Regex / String of characters)
subField
The name of the sub-field, if applicable. Can be a cookie or a header name, for example (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your HTTP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your HTTP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
RouteRule *
- field
The name of the field to be tested via the "match" operator (String of characters)
- match
The comparison operator to use (contains, endsWith, exists, in, internal, is, matches, startsWith)
- negate
If the "match" operator is inverted or not (Boolean)
- pattern
The Value or regular expression to use with the "match" operator (Regex / String of characters)
- subField
The name of the sub-field if applicable (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your HTTP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
zone
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
balance
Your farm's load sharing method (Value)
displayName
The name you wish to give to your farm (String of characters)
port
The listening port on your farm. Inherited from the frontend if not defined (Number, 1..65535)
probe
The type of probe to use on your farm (HTTP probe)
- forceSsl
Activation of the SSL is forced for the probe (Boolean)
- interval
The interval (in seconds) between each probe test. Must be greater than 30. Default is 30 (Number)
- match
The method of correspondence used. default' uses the standard HAProxy behavior. status' is only supported for HTTP probes. (Value) (contains, default, internal, matches, status)
- negate
The behavior of the :code:
match
operator is reversed. (Boolean)
- method
The HTTP method used in :code:
type
'http'. HEAD' can save bandwidth. GET' by default (Value) (HEAD, GET, OPTIONS, internal)
- pattern
server response when "UP". Empty for 'default', comma separated status list for 'status', text for 'contains', regular expression for 'matches'. (String of characters)
- port
The port that the probe should use to test the servers attached to your farm. Ignored for 'oco' probes. If not defined, the farm port is used (Number)
- type
The type of the probe; its operation (Value) (HTTP, internal, MySQL, OCO, PgSQL, SMTP ou TCP)
- url
The address to be used by the probe for HTTP type probes. The :code:
type
is ignored if this parameter is defined (String of characters)stickiness
The type of connection persistence to use for your farm (Value)
zone *
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
BackendTcp *
- balance
The type of load distribution (Value)
- displayName
The name of the farm (String of characters)
- port
The farm's listening port (Number, 1..65000)
- probe
The type of probe to be used (Sonde TCP)
- stickiness
The type of connection persistence (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
cookie
Filter Values by Cookie (String of characters)
address
Filter Values by IPv4 address (IPv4)
status
Filter Values by Server Status (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
address *
The IPv4 address of your server (IPv4)
backup
If your server is configured as a backup server (Boolean)
chain
The Value of the Intermediate SSL Certificate (String of characters)
displayName
The name given to your server (String of characters)
port
The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
probe
The type of probe to be used (Value)
proxyProtocolVersion
The proxyProtocol version to use, see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
ssl *
If the requests sent to your servers need to be encrypted with SSL (Boolean)
weight *
The weight of your server for your farm. A high weight server receives more requests (Number)
status *
If your server is activated or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server-link (Number)
farmId *
The identifier of your farm (Number)
BackendTcpServer *
- backup
If your server is configured as a backup server (Boolean)
- chain
The Value of the Intermediate SSL Certificate (String of characters)
- displayName
The name of your server (String of characters)
- port
The listening port of your server (Number, 1..65535)
- probe
The type of probe to be used (Value)
- proxyProtocolVersion
The proxyProtocol version to use, see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value >> )
- ssl
If the requests sent to your servers need to be encrypted with SSL (Boolean)
- status
If your server is activated or not (Boolean)
- weight
The weight of your server for your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
defaultFarmId
The identifier of the TCP farm to which the TCP frontend is linked (Number)
port
The listening port on your frontend (Number, 1..65535)
zone
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
allowedSource
The list of client IP addresses that have access to the Load Balancer (IPv4)
dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
defaultFarmId
The default TCP farm identifier for your frontend (Number)
defaultSslId
The default SSL Certificate ID (Number)
disabled
If your TCP frontend is disabled or enabled (Boolean)
displayName
The name of your TCP frontend (String of characters)
port *
The listening port on your frontend (Number, 1..65535)
ssl
Whether requests sent to the TCP farm should be encrypted with SSL or not (Boolean)
zone *
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend TCP (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend TCP (Number)
FrontendTcp *
- allowedSource
The list of client IP addresses that have access to the Load Balancer (IPv4[])
- dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
- defaultSslId
The default SSL Certificate ID (Number)
- disabled
If your HTTP frontend is disabled or enabled (Boolean)
- displayName
The name of your HTTP frontend (String of characters)
- ssl
Whether requests sent to the HTTP farm should be encrypted with SSL or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend (Number)
Routes are evaluated one by one, testing their routing rules. The first route validating all its rules sees its action executed, and stops the evaluation of the remaining routes. The order of execution is defined by the type and weight of the route.
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId
The identifier of a TCP frontend (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
action *
The action triggered when all the rules of your route are validated (RouteHttpAction)
- target
The farm identifier, or the template for the URL (String of characters)
- type
The action on your route (String of characters)
displayName
The name of your route (String of characters)
frontendId
The Identifier of the TCP frontend for which your route is applied (Number)
weight
The priority of your route. (Number) [0 - 255]
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
routeTcp *
- action
The action to carry out (routeTcpAction)
- target
The farm identifier, or the template for the URL (String of characters)
- type
The action on your route (String of characters)
- displayName
The name of your route (String of characters)
- frontendId
The TCP frontend for which your route is applied (Number)
- weight
The priority of your route (Number) [0 - 255]
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your route (number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your TCP route (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your TCP route (Number)
field *
The name of the field to be tested with the "match" operator (String of characters)
match *
The comparison operator (value) (contains, endsWith, exists, in, internal, is, matches, startsWith)
negate
The behavior of the :code:
match
operator is reversed. (Boolean)pattern
The schema or the regular expression used by the "match" operator (Regex / String of characters)
subField
The name of the sub-field, if applicable. Can be a cookie or a header name, for example (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your TCP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your TCP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
RouteRule *
- field
The name of the field to be tested via the "match" operator (String of characters)
- match
The comparison operator to use (contains, endsWith, exists, in, internal, is, matches, startsWith)
- negate
If the "match" operator is inverted or not (Boolean)
- pattern
The Value or regular expression to use with the "match" operator (Regex / String of characters)
- subField
The name of the sub-field if applicable (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
routeId *
The identifier of your TCP route (Number)
ruleId *
The identifier of your HTTP routing rule (Number)
Access the UDP protocol elements (Frontend, Farm, etc.).
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
zone
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
displayName
The name you wish to give to your farm (String of characters)
port
The listening port on your farm. Inherited from the frontend if not defined (Number, 1..65535)
zone *
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
BackendUdp *
- displayName
The name of the farm (String of characters)
- port
The farm's listening port (Number, 1..65000)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
address
Filter Values by IPv4 address (IPv4)
status
Filter Values by Server Status (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
farmId *
The identifier of your farm (Number)
address *
The IPv4 address of your server (IPv4)
displayName
The name given to your server (String of characters)
port
The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
status *
If your server is activated or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server (Number)
farmId *
The identifier of your farm (Number)
BackendUdpServer *
- displayName
The name of your server (String of characters)
- port
The listening port of your server (Number, 1..65535)
- status
If your server is activated or not (Boolean)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serverId *
The identifier of your server UDP (Number)
farmId *
The identifier of your farm UDP (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
defaultFarmId
The identifier of the UDP farm to which the UDP frontend is linked (Number)
port
The listening port on your frontend (Number, 1..65535)
zone
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
defaultFarmId *
The default UDP farm identifier for your frontend (Number)
disabled
If your UDP frontend is disabled or enabled (Boolean)
displayName
The name of your UDP frontend (String of characters)
port *
The listening port on your frontend (Number, 1..65535)
zone *
The name of your zone, ex: all (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend UDP (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend UDP (Number)
FrontendUdp *
- dedicatedIpfo
The list of IP addresses of the remote servers to which your Load Balancer is connected (IPv4[])
- disabled
If your UDP frontend is disabled or enabled (Boolean)
- displayName
The name of your UDP frontend (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
frontendId *
The identifier of your frontend UDP (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
fingerprint
Lists the fingerprint of the SSL certificate (String of characters)
serial
Lists the identification number of the SSL certificate (String of characters)
type
Type of SSL certificate (Value)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
certificate *
Adding the SSL certificate (String of characters)
chain
Adding the intermediate SSL certificate (String of characters)
key *
Adding the private key (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
id *
The identifier of your SSL certificate (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
id *
The identifier of your SSL certificate (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
action *
Consultation of available tasks (Values)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
id *
The identifier of your task (Number)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
contactAdmin
The OVH NIC to be configured for the Admin contact of this service (String of characters)
contactBilling
The OVH NIC to be configured for the Admin contact of this service (String of characters)
contactTech
The OVH NIC to be configured for the Admin contact of this service (String of characters)
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
subnet
Allows to filter according to the network used
vlan
Allows to filter according to the vlan used
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
displayName
The name you want to give to the network (String of characters)
farmId
Identification table of farms that you wish to attach to this private network
natIp
An IP block reserved for the load balancer to reach the servers.
subnet
The IP block of the private network
vlan
Vlan of the private network in the vRack. 0 if the private network is not in a vlan
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
vrackNetworkId *
The identifier of the private network
serviceName *
The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
vrackNetworkId *
The identifier of the private network
farmId *
Table of farm identifiers that you wish to attach to this private network. The Value "null" removes the vrack network id from all farms where it was configured.
Interact with our user community on https://community.ovh.com.
Please feel free to give any suggestions in order to improve this documentation.
Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.
Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.
Thank you. Your feedback has been received.
Access your community space. Ask questions, search for information, post content, and interact with other OVHcloud Community members.
Discuss with the OVHcloud community