+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objective
This guide provides a detailed description of all API functions for the OVHcloud Load Balancer.
@@ -39,367 +54,331 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### List the zones available for the OVHcloud Load Balancer
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Return details of a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objective
This guide provides a detailed description of all API functions for the OVHcloud Load Balancer.
@@ -39,367 +54,331 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### List the zones available for the OVHcloud Load Balancer
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Return details of a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objective
This guide provides a detailed description of all API functions for the OVHcloud Load Balancer.
@@ -39,367 +54,331 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### List the zones available for the OVHcloud Load Balancer
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Return details of a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objective
This guide provides a detailed description of all API functions for the OVHcloud Load Balancer.
@@ -39,367 +54,331 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### List the zones available for the OVHcloud Load Balancer
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Return details of a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objective
This guide provides a detailed description of all API functions for the OVHcloud Load Balancer.
@@ -39,367 +54,331 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### List the zones available for the OVHcloud Load Balancer
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Return details of a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify a OVHcloud Load Balancer service
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Parameters:
+
+**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)
+
+///
+
#### List the services attached to the OVHcloud Load Balancer
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List existing farms and their type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
->> >
->> > **vrackNetworkId**
->> >
->> >> Allows filtering according to the vrack network
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+**vrackNetworkId**
+
+Allows filtering according to the vrack network
+
+///
+
#### List the areas that can be attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different probes that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of farms that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of frontends that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing actions that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### List the different types of routing rules that can be used
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
### Service
#### Get service information
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
+
+///
+
#### Modify service information
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Parameters :
->
->> > **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)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Parameters:
+
+**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)
+
+///
+
### Zones
#### List active zones for a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
+
+///
+
#### Get the details of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the requested zone
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the requested zone
+
+///
+
#### Delete a zone
The service will be discontinued on the expiry date.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The service will be discontinued on the expiry date.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The service will be discontinued on the expiry date.
+
+///
+
#### Undo the deletion of a zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **name** *
->> >
->> >> The name of the zone to be deleted
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**name** ^*^
+
+The name of the zone to be deleted
+
+///
+
## HTTP Protocol
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
@@ -407,2770 +386,2549 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
#### List HTTP farms attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **zone**
->> >
->> >> The name of the zone (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Adding a new HTTP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Getting the details of an HTTP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
->
+**zone**
-#### Modify the properties of an HTTP farm
+The name of the zone (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete an HTTP farm
+#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your HTTP farm (Number)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### HTTP Servers
+
Parameters:
-#### List the servers linked to the HTTP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Adding a server to an HTTP farm
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name of the zone (String of characters)
-#### Get the details of a server linked to an HTTP farm
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The name you wish to give to your farm (String of characters)
-#### Modify the properties of an HTTP server
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Your farm's load distribution method (Value)
-#### Removing a server from an HTTP farm
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your farm. Inherited from the frontend if undefined (Number, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### List HTTP frontends attached to a OVHcloud Load Balancer service
+The type of connection persistence to use for your farm (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**probe**
-#### Add an HTTP frontend to a OVHcloud Load Balancer service
+The type of probe to use on your farm (Probe HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **forceSsl**
+SSL activation is forced for the probe (Boolean)
-### Get the details of an HTTP frontend
+- **interval**
+The interval in seconds between each probe test. Must be greater than 30. Default is 30. (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your HTTP frontend (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]
-#### Modify the properties of an HTTP frontend
+- **negate**
+The behavior of the 'match' operator is reversed (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **method**
+The HTTP method used in type 'http'. HEAD' can save bandwidth. GET' by default (Value) [HEAD, GET, OPTIONS, internal]
-#### Delete an HTTP frontend
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+- **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)
-### Routes HTTP
-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.
+- **type**
+The type of the probe; its operation (Value) [HTTP, internal, MySQL, OCO, PgSQL, SMTP, TCP]
-#### List the HTTP routes attached to a Load Balancer service
+- **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)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
+///
+
+#### Getting the details of an HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of an HTTP frontend (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new HTTP route to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of an HTTP route
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+**farmId** ^*^
-#### Modify the properties of an HTTP route
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+///
-#### Delete an HTTP route
+#### Modify the properties of an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Routing rules
+
Parameters:
-#### List the routing rules attached to an HTTP route
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your HTTP route (Number)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add routing rules attached to an HTTP route
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a routing rule
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **displayName**
+The name of the farm (String of characters)
-#### Modify the properties of a routing rule
+- **balance**
+The type of load distribution (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The farm's listening port (Number, 1..65000)
-#### Delete a routing rule
+- **probe**
+The type of probe to be used (HTTP probe)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **stickiness**
+The type of connection persistence (Value)
-## Protocol TCP
-Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+///
-### TCP Farms
+#### Delete an HTTP farm
-#### List TCP farms attached to a OVHcloud Load Balancer service
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Add a new TCP farm to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**farmId** ^*^
-#### Modify the properties of a TCP farm
+The identifier of your HTTP farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a TCP farm
+### HTTP Servers
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Parameters :
+#### List the servers linked to the HTTP farm
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### TCP Servers
+
Parameters:
-#### List the servers linked to the TCP farm
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-#### Add a server to a TCP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your HTTP farm (Number)
-#### Get the details of a server linked to a TCP farm
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
-> >
+Filter Values by Cookie (String of characters)
-#### Modify the properties of a TCP server
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by IPv4 address (IPv4)
-#### Delete a server from a TCP farm
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+Filter Values by server status (Value)
-### Frontends TCP
+///
-#### List TCP frontends attached to a OVHcloud Load Balancer service
+#### Adding a server to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Add a TCP frontend to a OVHcloud Load Balancer service
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Get the details of a TCP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >>
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >>
->> >> The identifier of your frontend TCP (Number)
->>
+**farmId** ^*^
-#### Modify the properties of a TCP frontend
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**address** ^*^
-#### Delete a TCP frontend
+The IPv4 address of your server (IPv4)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend (Number)
->
+**backup**
-### Routes TCP
-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.
+If your server is configured as a backup server (Boolean)
-#### List TCP routes attached to a OVHcloud Load Balancer service
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId**
->> >
->> >> The identifier of a TCP frontend (Number)
->
+The Value of the Intermediate SSL Certificate (String of characters)
-#### Add a new TCP route to a OVHcloud Load Balancer service
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The Value of your Cookie (String of characters)
-#### Get the details of a TCP route
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The name given to your server (String of characters)
-#### Modify the properties of a TCP route
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **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]
->
+The listening port of your server. Inherited from your farm if not defined (Number, 1..65535)
-#### Delete a TCP route
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your route (number)
->
+The type of probe to be used (Value)
-### Routing rules
+**proxyProtocolVersion**
-#### List the routing rules attached to a TCP route
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **routeId** *
->> >
->> >> The identifier of your TCP route (Number)
->
+**ssl** ^*^
-#### Add routing rules attached to a TCP route
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**weight** ^*^
-#### Get the details of a routing rule
+The weight of your server for your farm. A server with high weight receives more requests (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**status** ^*^
-#### Modify the properties of a routing rule
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+///
-#### Delete a routing rule
+#### Get the details of a server linked to an HTTP farm
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-## UDP Protocol
-Access the UDP protocol elements (Frontend, Farm, etc.).
+
Parameters:
-### UDP Farms
+**serviceName** ^*^
-#### List UDP trusses attached to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**serverId** ^*^
-#### Add a new UDP farm to a OVHcloud Load Balancer service
+The identifier of your server (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+**farmId** ^*^
-#### Get the details of a UDP farm
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
+///
+
+#### Modify the properties of an HTTP server
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP farm
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP farm
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **farmId** *
->> >
->> >> The identifier of your farm (Number)
->
+**serverId** ^*^
-### UDP Servers
+The identifier of your server-link (Number)
-#### List the servers linked to the UDP farm
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The identifier of your farm (Number)
-#### Adding a server to a UDP farm
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **backup**
+If your server is configured as a backup server (Boolean)
-#### Get the details of a server linked to a UDP farm
+- **chain**
+The Value of the Intermediate SSL Certificate (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **cookie**
+The Value of your Cookie (String of characters)
-#### Modify the properties of a UDP server
+- **displayName**
+The name of your server (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **port**
+The listening port of your server (Number, 1..65535)
-#### Removing a server from a UDP farm
+- **probe**
+The type of probe to be used (Value)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **proxyProtocolVersion**
+The proxyProtocol version to use,
+see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Value)
-### Frontends UDP
+- **ssl**
+If the requests sent to your servers need to be encrypted with SSL (Boolean)
-#### List UDP frontends attached to a OVHcloud Load Balancer service
+- **status**
+If your server is activated or not (Boolean)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+- **weight**
+The weight of your server for your farm (Number)
-#### Add a UDP frontend to a OVHcloud Load Balancer service
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+#### Removing a server from an HTTP farm
-#### Get the details of a UDP frontend
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modify the properties of a UDP frontend
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **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** ^*^
-#### Delete a UDP frontend
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **frontendId** *
->> >
->> >> The identifier of your frontend UDP (Number)
->
+**serverId** ^*^
-## Other features
+The identifier of your server (Number)
-### Additional IP
+**farmId** ^*^
-#### List Additional IPs routed on a OVHcloud Load Balancer service
+The identifier of your farm (Number)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+///
-### Service Status
+### Frontends HTTP
-#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+#### List HTTP frontends attached to a OVHcloud Load Balancer service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-#### List the output IPs used by OVH for NAT
+
Parameters:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**serviceName** ^*^
-#### Apply changes to a OVHcloud Load Balancer service
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->
+**defaultFarmId**
-### SSL Certificates
+The identifier of the HTTP farm to which the HTTP frontend is linked (Number)
-#### List SSL certificates of a OVHcloud Load Balancer service
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Parameters :
->
->> > **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)
->
+The listening port on your frontend (Number, 1..65535)
-#### Add a new SSL object
+**zone**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+The name of your zone, ex: all (String of characters)
+
+///
+
+#### Add an HTTP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Get the details of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your HTTP frontend (Number)
+
+///
+
+#### Modify the properties of an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete an HTTP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes HTTP
+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.
+
+#### List the HTTP routes attached to a Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of an HTTP frontend (Number)
+
+///
+
+#### Add a new HTTP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your HTTP route (Number)
+
+///
+
+#### Add routing rules attached to an HTTP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## Protocol TCP
+Access the elements related to the TCP protocol (Frontend, Farm, etc.).
+
+### TCP Farms
+
+#### List TCP farms attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new TCP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### TCP Servers
+
+#### List the servers linked to the TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a server to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a TCP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a server from a TCP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends TCP
+
+#### List TCP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a TCP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend TCP (Number)
+
+///
+
+#### Modify the properties of a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a TCP frontend
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend (Number)
+
+///
+
+### Routes TCP
+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.
+
+#### List TCP routes attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId**
+
+The identifier of a TCP frontend (Number)
+
+///
+
+#### Add a new TCP route to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Get the details of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+#### Modify the properties of a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**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]
+///
+
+#### Delete a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your route (number)
+
+///
+
+### Routing rules
+
+#### List the routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**routeId** ^*^
+
+The identifier of your TCP route (Number)
+
+///
+
+#### Add routing rules attached to a TCP route
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a routing rule
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+## UDP Protocol
+Access the UDP protocol elements (Frontend, Farm, etc.).
+
+### UDP Farms
+
+#### List UDP trusses attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new UDP farm to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+#### Modify the properties of a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**farmId** ^*^
+
+The identifier of your farm (Number)
+
+///
+
+### UDP Servers
+
+#### List the servers linked to the UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Adding a server to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a server linked to a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Modify the properties of a UDP server
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Removing a server from a UDP farm
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+### Frontends UDP
+
+#### List UDP frontends attached to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a UDP frontend to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Parameters :
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Get the details of an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+#### Modify the properties of a UDP frontend
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Delete a UDP frontend
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**frontendId** ^*^
+
+The identifier of your frontend UDP (Number)
+
+///
+
+## Other features
+
+### Additional IP
+
+#### List Additional IPs routed on a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Delete an SSL object
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### Service Status
+
+#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### List the output IPs used by OVH for NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+#### Apply changes to a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your SSL certificate (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tasks
+
Parameters:
-#### List current tasks for a OVHcloud Load Balancer service
+**serviceName** ^*^
-> [!faq]
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+///
+
+### SSL Certificates
+
+#### List SSL certificates of a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Parameters:
+
+**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)
+
+///
+
+#### Add a new SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Parameters :
+
+
Parameters:
+
+**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)
+
+///
+
+#### Get the details of an SSL object
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **action** *
->> >
->> >> Consultation of available tasks (Values)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Get the details of a task
+
Parameters:
-> [!faq]
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+#### Delete an SSL object
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your SSL certificate (Number)
+
+///
+
+### Tasks
+
+#### List current tasks for a OVHcloud Load Balancer service
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**action** ^*^
+
+Consultation of available tasks (Values)
+
+///
+
+#### Get the details of a task
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **id** *
->> >
->> >> The identifier of your task (Number)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**id** ^*^
+
+The identifier of your task (Number)
+
+///
+
### Contact
#### Initiate a contact change
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Parameters :
+/// details |
+
+> [!api]
>
->> > **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)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Parameters:
+
+**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)
+
+///
+
### vRack
#### Description of the private networks attached to the load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Parameters :
+
+
Parameters:
+
+**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
+
+///
+
+#### Add a private network in the vRack
+
+/// details |
+
+> [!api]
>
->> > **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
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Add a private network in the vRack
+
Parameters:
+
+**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.
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Parameters :
->
->> > **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
->
-
-#### Retrieve, modify or delete a private network
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Parameters :
->
->> > **serviceName** *
->> >
->> >> The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
->> >
->> > **vrackNetworkId** *
->> >
->> >> The identifier of the private network
+**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
+
+///
+
+#### Retrieve a private network
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modify the list of farms attached to a private network
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify a private network
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Delete a private network
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Parameters :
+
+
Parameters:
+
+**serviceName** ^*^
+
+The identifier of your Load Balancer, for example : "loadbalancer-abcdef0123456789" (String of characters)
+
+**vrackNetworkId** ^*^
+
+The identifier of the private network
+
+///
+
+#### Modify the list of farms attached to a private network
+
+/// details |
+
+> [!api]
>
->> > **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.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Parameters:
+
+**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.
+
+///
+
## Go further
-Interact with our user community on .
+Interact with our user community on
+
+
## Objectif
Ce guide fournit une description détaillée de toutes les fonctions de l'API pour le Load Balancer OVHcloud.
@@ -39,367 +54,331 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### Lister les zones disponibles pour le Load Balancer OVHcloud
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Retourner les détails d'un service Load Balancer OVHcloud
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Modifier un service Load Balancer OVHcloud
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **Ip** *
->> >
->> >> **displayName**
->> >> >
->> >> > Le nom que vous souhaitez attribuer au service (chaîne de caractères)
->> >
->> >> **sslConfiguration**
->> >>
->> >> > La configuration SSL que vous souhaitez attribuer au service (valeur)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**Ip** ^*^
+
+- **displayName**
+Le nom que vous souhaitez attribuer au service (chaîne de caractères)
+
+- **sslConfiguration**
+La configuration SSL que vous souhaitez attribuer au service (valeur)
+
+///
+
#### Lister les services attachés au Load Balancer OVHcloud
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les fermes existantes et leur type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **vrackNetworkId**
->> >
->> >> Permet de filtrer selon le réseau vrack
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**vrackNetworkId**
+
+Permet de filtrer selon le réseau vrack
+
+///
+
#### Lister les zones pouvant être attachées à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de fermes pouvant être utilisées
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de frontends pouvant être utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types d'actions de routage pouvant etre utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de règles de routage pouvant être utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
### Service
#### Obtenir les informations du service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Modifier les informations du service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **Service** *
->> >
->> >> - **automatic**
->> >> >
->> >> > Active le renouvellement automatique du service (booléen))
->> >>
->> >> - **deleteAtExpiration**
->> >> >
->> >> > Active la suppression du service lors de l'expiration (booléen)
->> >>
->> >> - **forced**
->> >> >
->> >> > Force le renouvellement automatique (booléen)
->> >>
->> >> - **period**
->> >> >
->> >> > Renseigne la durée de renouvellement (chaîne de caractères)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**Service** ^*^
+
+- **automatic**
+Active le renouvellement automatique du service (booléen))
+
+- **deleteAtExpiration**
+Active la suppression du service lors de l'expiration (booléen)
+
+- **forced**
+Force le renouvellement automatique (booléen)
+
+- **period**
+Renseigne la durée de renouvellement (chaîne de caractères)
+
+///
+
### Zones
#### Lister les zones actives pour un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Obtenir les détails d'une zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone demandée
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone demandée
+
+///
+
#### Supprimer une zone
Le service sera supprimé à la date d'expiration.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone à supprimer
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone à supprimer
+
+///
+
#### Annuler la suppression d'une zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone a supprimer
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone a supprimer
+
+///
+
## Protocole HTTP
Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
@@ -408,2654 +387,2401 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
#### Lister les fermes HTTP attachées à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de la zone (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone** *
->> >
->> >> Le nom de la zone (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> le nom que vous souhaitez attribuer à votre ferme (chaîne de caractères)
->> >
->> > **balance**
->> >>
->> >> La méthode de répartition de charge de votre ferme (valeur)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **stickiness**
->> >
->> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP)
->> >> >
->> >> > - **forceSsl**
->> >> >
->> >> >> L'activation du SSL est forcée pour la sonde (booléen)
->> >> >
->> >> > - **interval**
->> >> >
->> >> >> L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
->> >> >
->> >> > - **match**
->> >> >
->> >> >> La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (value) [contains, default, internal, matches, status]
->> >> >
->> >> > - **negate**
->> >> >
->> >> >> Le comportement de l'opérateur 'match' est inversé (booléen)
->> >> >
->> >> > - **method**
->> >> >
->> >> >> La méthode HTTP utilisée en type 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) [HEAD, GET, OPTIONS, internal]
->> >> >
->> >> > - **pattern**
->> >> >
->> >> >> Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
->> >> >
->> >> > - **port**
->> >> >
->> >> >> Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> Le type de la sonde ; son fonctionnement (valeur) [HTTP, interne, MySQL, OCO, PgSQL, SMTP, TCP]
->> >> >
->> >> > - **url**
->> >> >
->> >> >> L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est défini (chaîne de caractères)
->
+**serviceName** ^*^
-#### Obtenir les détails d'une ferme HTTP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->
+**zone**
-#### Modifier les propriétés d'une ferme HTTP
+Le nom de la zone (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->> >
->> > **BackendHttp** *
->> >
->> >> - **displayName**
->> >> >
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **balance**
->> >> >
->> >> > Le type de répartition de charge (valeur)
->> >>
->> >> - **port**
->> >> >
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->> >>
->> >> - **probe**
->> >> >
->> >> > Le type de sonde à utiliser (sonde HTTP)
->> >>
->> >> - **stickiness**
->> >> >
->> >> > Le type de persistence de connexion (valeur)
->
+///
-#### Supprimer une ferme HTTP
+#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### Serveurs HTTP
+
Paramètres:
-#### Lister les serveurs liés à la ferme HTTP
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->> >
->> > **cookie**
->> >
->> >> Filtrer les valeurs par cookie (chaîne de caractères)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter un serveur à une ferme HTTP
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **backup**
->> >
->> >> Si votre serveur est configuré comme serveur de secours (booléen)
->> >
->> > **chain**
->> >
->> >> La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **cookie**
->> >
->> >> La valeur de votre cookie (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser (valeur)
->> >
->> > **proxyProtocolVersion**
->> >
->> >> La version de proxyProtocol à utiliser,
->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >
->> > **ssl** *
->> >
->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >
->> > **weight** *
->> >
->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+Le nom de la zone (chaîne de caractères)
-#### Obtenir les détails d'un serveur lié à une ferme HTTP
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+le nom que vous souhaitez attribuer à votre ferme (chaîne de caractères)
-#### Modifier les propriétés d'un serveur HTTP
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre server-link (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendHttpServer** *
->> >
->> >> - **backup**
->> >> >
->> >> > Si votre serveur est configuré comme serveur de secours (booléen)
->> >>
->> >> - **chain**
->> >> >
->> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >>
->> >> - **cookie**
->> >> >
->> >> > La valeur de votre cookie (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >> >
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >> >
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **probe**
->> >> >
->> >> > Le type de sonde à utiliser (valeur)
->> >>
->> >> - **proxyProtocolVersion**
->> >> >
->> >> > La version de proxyProtocol à utiliser,
->> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >>
->> >> - **ssl**
->> >> >
->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >>
->> >> - **status**
->> >> >
->> >> > Si votre serveur est activé ou non (booléen)
->> >>
->> >> - **weight**
->> >> >
->> >> > Le poids de votre serveur pour votre ferme (nombre)
->
+La méthode de répartition de charge de votre ferme (valeur)
-#### Supprimer un serveur d'une ferme HTTP
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
+Le type de persistence de connexion à utiliser pour votre ferme (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, par exemple: all (chaîne de caractères)
->
+**probe**
-#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
+Le type de sonde à utiliser sur votre ferme (sonde HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **allowedSource**
->> >
->> >> La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
->> >>
->> >> NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme HTTP par défaut pour votre frontend (nombre)
->> >
->> > **defaultSslId**
->> >
->> >> L'identifiant du certificat SSL par défaut (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend HTTP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend HTTP (chaîne de caractères)
->> >
->> > **hsts**
->> >
->> >> Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
->> >
->> > **httpHeader**
->> >
->> >> L'entête *http* personnalisé à ajouter (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **redirectLocation**
->> >
->> >> L'URL de redirection *http* (chaîne de caractères)
->> >
->> > **ssl**
->> >
->> >> Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+- **forceSsl**
+L'activation du SSL est forcée pour la sonde (booléen)
-### Obtenir les détails d'un frontend HTTP
+- **interval**
+L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend HTTP (nombre)
->
+- **match**
+La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (value) [contains, default, internal, matches, status]
-#### Modifier les propriétés d'un frontend HTTP
+- **negate**
+Le comportement de l'opérateur 'match' est inversé (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend HTTP (nombre)
->> >
->> > **FrontendHttp** *
->> >
->> >> - **allowedSource**
->> >> >
->> >> > La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4[])
->> >> >
->> >> > NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
->> >>
->> >> - **dedicatedIpfo**
->> >> >
->> >> > La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **defaultSslId**
->> >> >
->> >> > L'identifiant du certificat SSL par défaut (nombre)
->> >>
->> >> - **disabled**
->> >> >
->> >> > Si votre frontend HTTP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >> >
->> >> > Le nom de votre frontend HTTP (chaîne de caractères)
->> >>
->> >> - **hsts**
->> >> >
->> >> > Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
->> >>
->> >> - **httpHeader**
->> >> >
->> >> > L'en-tête *http* personnalisé à ajouter (chaîne de caractères)
->> >>
->> >> - **ssl**
->> >> >
->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->
+- **method**
+La méthode HTTP utilisée en type 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) [HEAD, GET, OPTIONS, internal]
-#### Supprimer un frontend HTTP
+- **pattern**
+Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend (nombre)
->
+- **port**
+Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
-### Routes HTTP
+- **type**
+Le type de la sonde ; son fonctionnement (valeur) [HTTP, interne, MySQL, OCO, PgSQL, SMTP, TCP]
-Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+- **url**
+L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est défini (chaîne de caractères)
-#### Lister les routes HTTP attachées à un service Load Balancer
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Paramètres :
+#### Obtenir les détails d'une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant d'un frontend HTTP (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >>
->> >> - **status**
->> >>
->> >> > Le code de retour HTTP attendu (nombre)
->> >>
->> >> - **target**
->> >>
->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >>
->> >> - **type**
->> >>
->> >> > L'action de votre route (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre route (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
->> >
->> > **weight**
->> >
->> >> La priorité de votre route. (nombre) [0 - 255]
->
+**serviceName** ^*^
-#### Obtenir les détails d'une route HTTP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+**farmId** ^*^
-#### Modifier les propriétés d'une route HTTP
+L'identifiant de votre ferme HTTP (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->> >
->> > **routeHttp** *
->> >
->> >> **action** *
->> >>
->> >> > L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >> >
->> >> > - **status**
->> >> >
->> >> >> Le code de retour HTTP attendu (nombre)
->> >> >
->> >> > - **target**
->> >> >
->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> L'action de votre route (chaîne de caractères)
->> >>
->> >> **displayName**
->> >>
->> >> > Le nom de votre route (chaîne de caractères)
->> >>
->> >> **frontendId**
->> >>
->> >> > L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
->> >>
->> >> **weight**
->> >>
->> >> > La priorité de votre route. (nombre) [0 - 255]
->
+///
-#### Supprimer une route HTTP
+#### Modifier les propriétés d'une ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Règles de routage
+
Paramètres:
-#### Lister les règles de routages attachées à une route HTTP
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter les règles de routages attachées à une route HTTP
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **field** *
->> >
->> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
->> >
->> > **match** *
->> >
->> >> L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >
->> > **negate**
->> >
->> >> Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >
->> > **pattern**
->> >
->> >> Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
->> >
->> > **subField**
->> >
->> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
->
+L'identifiant de votre ferme HTTP (nombre)
-#### Obtenir les détails d'une règle de routage
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
-#### Modifier les propriétés d'une règle de routage
+- **balance**
+Le type de répartition de charge (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->> >
->> > **RouteRule** *
->> >
->> >> - **field**
->> >>
->> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
->> >>
->> >> - **match**
->> >>
->> >> > L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >>
->> >> - **negate**
->> >>
->> >> > Si l'opérateur "match" est inversé ou non (booléen)
->> >>
->> >> - **pattern**
->> >>
->> >> > La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
->> >>
->> >> - **subField**
->> >>
->> >> > Le nom du sous-champ si applicable (chaîne de caractères)
->
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
-#### Supprimer une règle de routage
+- **probe**
+Le type de sonde à utiliser (sonde HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
+- **stickiness**
+Le type de persistence de connexion (valeur)
+
+///
+
+#### Supprimer une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-## Protocole TCP
+
Paramètres:
-Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
+**serviceName** ^*^
-### Fermes TCP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre ferme HTTP (nombre)
-#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **balance**
->> >
->> >> La méthode de répartition de charge de votre ferme (valeur)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP)
->> >>
->> >> - **forceSsl**
->> >>
->> >> > L'activation du SSL est forcée pour la sonde (booléen)
->> >>
->> >> - **interval**
->> >>
->> >> > L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
->> >>
->> >> - **match**
->> >>
->> >> > La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (valeur) (contains, default, internal, matches, status)
->> >>
->> >> - **negate**
->> >>
->> >> > Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >>
->> >> - **method**
->> >>
->> >> > La méthode HTTP utilisée en :code:`type` 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) (HEAD, GET, OPTIONS, internal)
->> >>
->> >> - **pattern**
->> >>
->> >> > réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
->> >>
->> >> - **type**
->> >>
->> >> > Le type de la sonde ; son fonctionnement (valeur) (HTTP, interne, MySQL, OCO, PgSQL, SMTP ou TCP)
->> >>
->> >> - **url**
->> >>
->> >> > L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est défini (chaîne de caractères)
->> >>
->> > **stickiness**
->> >
->> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+### Serveurs HTTP
-#### Obtenir les détails d'une ferme TCP
+#### Lister les serveurs liés à la ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Modifier les propriétés d'une ferme TCP
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendTcp** *
->> >
->> >> - **balance**
->> >>
->> >> > Le type de répartition de charge (valeur)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->> >>
->> >> - **probe**
->> >>
->> >> > Le type de sonde à utiliser (sonde TCP)
->> >>
->> >> - **stickiness**
->> >>
->> >> > Le type de persistence de connexion (valeur)
->
+**serviceName** ^*^
-#### Supprimer une ferme TCP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**farmId** ^*^
-### Serveurs TCP
+L'identifiant de votre ferme HTTP (nombre)
-#### Lister les serveurs liés à la ferme TCP
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **cookie**
->> >
->> >> Filtrer les valeurs par cookie (chaîne de caractères)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+Filtrer les valeurs par cookie (chaîne de caractères)
-#### Ajouter un serveur à une ferme TCP
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **backup**
->> >
->> >> Si votre serveur est configuré comme serveur de secours (booléen)
->> >
->> > **chain**
->> >
->> >> La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser (valeur)
->> >
->> > **proxyProtocolVersion**
->> >
->> >> La version de proxyProtocol à utiliser,
->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >
->> > **ssl** *
->> >
->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >
->> > **weight** *
->> >
->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+Filtrer les valeurs par adresse IPv4 (IPv4)
-#### Obtenir les détails d'un serveur lié à une ferme TCP
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
-> >
+Filtrer les valeurs par statut du serveur (valeur)
-#### Modifier les propriétés d'un serveur TCP
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre server-link (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendTcpServer** *
->> >
->> >> - **backup**
->> >>
->> >> > Si votre serveur est configuré comme serveur de secours (booléen)
->> >>
->> >> - **chain**
->> >>
->> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **probe**
->> >>
->> >> > Le type de sonde à utiliser (valeur)
->> >>
->> >> - **proxyProtocolVersion**
->> >>
->> >> > La version de proxyProtocol à utiliser,
->> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur >> )
->> >>
->> >> - **ssl**
->> >>
->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >>
->> >> - **status**
->> >>
->> >> > Si votre serveur est activé ou non (booléen)
->> >>
->> >> - **weight**
->> >>
->> >> > Le poids de votre serveur pour votre ferme (nombre)
->
+#### Ajouter un serveur à une ferme HTTP
-#### Supprimer un serveur d'une ferme TCP
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### Frontends TCP
+
Paramètres:
-#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **allowedSource**
->> >
->> >> La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme TCP par défaut pour votre frontend (nombre)
->> >
->> > **defaultSslId**
->> >
->> >> L'identifiant du certificat SSL par défaut (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend TCP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend TCP (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **ssl**
->> >
->> >> Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (booléen)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre ferme (nombre)
-#### Obtenir les détails d'un frontend TCP
+**address** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >>
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >>
->> >> L'identifiant de votre frontend TCP (nombre)
->>
+L'adresse IPv4 de votre serveur (IPv4)
-#### Modifier les propriétés d'un frontend TCP
+**backup**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend TCP (nombre)
->> >
->> > **FrontendTcp** *
->> >
->> >> - **allowedSource**
->> >>
->> >> > La liste des adresses IP clientes qui ont accès au Load Balancer (IPv4[])
->> >>
->> >> - **dedicatedIpfo**
->> >>
->> >> > La liste des adresses IP des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **defaultSslId**
->> >>
->> >> > L'identifiant du certificat SSL par défaut (nombre)
->> >>
->> >> - **disabled**
->> >>
->> >> > Si votre frontend HTTP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre frontend HTTP (chaîne de caractères)
->> >>
->> >> - **ssl**
->> >>
->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->
+Si votre serveur est configuré comme serveur de secours (booléen)
-#### Supprimer un frontend TCP
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend (nombre)
->
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
-### Routes TCP
+**cookie**
-Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+La valeur de votre cookie (chaîne de caractères)
-#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant d'un frontend TCP (nombre)
->
+Le nom donné à votre serveur (chaîne de caractères)
-#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >>
->> >> - **target**
->> >>
->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >>
->> >> - **type**
->> >>
->> >> > L'action de votre route (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre route (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant du frontend TCP pour lequel votre route est appliquée (nombre)
->> >
->> > **weight**
->> >
->> >> La priorité de votre route. (nombre) [0 - 255]
->
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
-#### Obtenir les détails d'une route TCP
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+Le type de sonde à utiliser (valeur)
-#### Modifier les propriétés d'une route TCP
+**proxyProtocolVersion**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->> >
->> > **routeTcp** *
->> >
->> >> - **action**
->> >>
->> >> > L'action à réaliser (routeTcpAction)
->> >> >
->> >> > - **target**
->> >> >
->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> L'action de votre route (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre route (chaîne de caractères)
->> >>
->> >> - **frontendId**
->> >>
->> >> > Le frontend TCP pour lequel votre route est appliquée (nombre)
->> >>
->> >> - **weight**
->> >>
->> >> > La priorité de votre route (nombre) [0 - 255]
->
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
-#### Supprimer une route TCP
+**ssl** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
-### Règles de routage
+**weight** ^*^
-#### Lister les règles de routages attachées à une route TCP
+Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->
+**status** ^*^
-#### Ajouter les règles de routages attachées à une route TCP
+Si votre serveur est activé ou non (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **field** *
->> >
->> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
->> >
->> > **match** *
->> >
->> >> L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >
->> > **negate**
->> >
->> >> Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >
->> > **pattern**
->> >
->> >> Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
->> >
->> > **subField**
->> >
->> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
->
+///
-#### Obtenir les détails d'une règle de routage
+#### Obtenir les détails d'un serveur lié à une ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modifier les propriétés d'une règle de routage
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->> >
->> > **RouteRule** *
->> >
->> >> - **field**
->> >>
->> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
->> >>
->> >> - **match**
->> >>
->> >> > L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >>
->> >> - **negate**
->> >>
->> >> > Si l'opérateur "match" est inversé ou non (booléen)
->> >>
->> >> - **pattern**
->> >>
->> >> > La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
->> >>
->> >> - **subField**
->> >>
->> >> > Le nom du sous-champ si applicable (chaîne de caractères)
->
+**serviceName** ^*^
-#### Supprimer une règle de routage
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->
+**serverId** ^*^
-## Protocole UDP
+L'identifiant de votre serveur (nombre)
-Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
+**farmId** ^*^
-### Fermes UDP
+L'identifiant de votre ferme (nombre)
-#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+#### Modifier les propriétés d'un serveur HTTP
-#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, par exemple : all (chaîne de caractères)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Obtenir les détails d'une ferme UDP
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**serviceName** ^*^
-#### Modifier les propriétés d'une ferme UDP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendUdp** *
->> >
->> >> - **displayName**
->> >>
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->
+**serverId** ^*^
-#### Supprimer une ferme UDP
+L'identifiant de votre server-link (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**farmId** ^*^
-### Serveurs UDP
+L'identifiant de votre ferme (nombre)
-#### Lister les serveurs liés à la ferme UDP
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+- **backup**
+Si votre serveur est configuré comme serveur de secours (booléen)
-#### Ajouter un serveur à une ferme UDP
+- **chain**
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+- **cookie**
+La valeur de votre cookie (chaîne de caractères)
-#### Obtenir les détails d'un serveur lié à une ferme UDP
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
-#### Modifier les propriétés d'un serveur UDP
+- **probe**
+Le type de sonde à utiliser (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendUdpServer** *
->> >
->> >> - **displayName**
->> >>
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **status**
->> >>
->> >> > Si votre serveur est activé ou non (booléen)
->
+- **proxyProtocolVersion**
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
-#### Supprimer un serveur d'une ferme UDP
+- **ssl**
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur UDP (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme UDP (nombre)
->
+- **status**
+Si votre serveur est activé ou non (booléen)
-### Frontends UDP
+- **weight**
+Le poids de votre serveur pour votre ferme (nombre)
-#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Paramètres :
+#### Supprimer un serveur d'une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, par exemple : all (chaîne de caractères)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId** *
->> >
->> >> L'identifiant de la ferme UDP par défaut pour votre frontend (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend UDP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend UDP (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+**serviceName** ^*^
-#### Obtenir les détails d'un frontend UDP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->
+**serverId** ^*^
-#### Modifier les propriétés d'un frontend UDP
+L'identifiant de votre serveur (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->> >
->> > **FrontendUdp** *
->> >
->> >> - **dedicatedIpfo**
->> >>
->> >> > La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **disabled**
->> >>
->> >> > Si votre frontend UDP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre frontend UDP (chaîne de caractères)
->
+**farmId** ^*^
-#### Supprimer un frontend UDP
+L'identifiant de votre ferme (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->
+///
-## Autres fonctionnalités
+### Frontends HTTP
-### Additional IP
+#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
-#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-### État du service
+
Paramètres:
-#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
+**defaultFarmId**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (nombre)
-#### Appliquer les modifications d'un service Load Balancer OVHcloud
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+Le port d'écoute de votre frontend (nombre, 1..65535)
-### Certificats SSL
+**zone**
-#### Lister les certificats SSL d'un service Load Balancer OVHcloud
+Le nom de votre zone, par exemple: all (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **fingerprint**
->> >
->> >> Liste l'empreinte du certificat SSL (chaîne de caractères)
->> >
->> > **serial**
->> >
->> >> Liste le numéro d'identification du certificat SSL (chaîne de caractères)
->> >
->> > **type**
->> >
->> >> Type de certificat SSL (valeur)
->
+///
-#### Ajouter un nouvel objet SSL
+#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**allowedSource**
+
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
+
+NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId**
+
+L'identifiant de la ferme HTTP par défaut pour votre frontend (nombre)
+
+**defaultSslId**
+
+L'identifiant du certificat SSL par défaut (nombre)
+
+**disabled**
+
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+**hsts**
+
+Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
+
+**httpHeader**
+
+L'entête *http* personnalisé à ajouter (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**redirectLocation**
+
+L'URL de redirection *http* (chaîne de caractères)
+
+**ssl**
+
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+### Obtenir les détails d'un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend HTTP (nombre)
+
+**FrontendHttp** ^*^
+
+- **allowedSource**
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4[])
+
+NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
+
+- **dedicatedIpfo**
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **defaultSslId**
+L'identifiant du certificat SSL par défaut (nombre)
+
+- **disabled**
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+- **hsts**
+Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
+
+- **httpHeader**
+L'en-tête *http* personnalisé à ajouter (chaîne de caractères)
+
+- **ssl**
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+///
+
+#### Supprimer un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend (nombre)
+
+///
+
+### Routes HTTP
+
+Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+
+#### Lister les routes HTTP attachées à un service Load Balancer
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant d'un frontend HTTP (nombre)
+
+///
+
+#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **status**
+Le code de retour HTTP attendu (nombre)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+**displayName**
+
+Le nom de votre route (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
+
+**weight**
+
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Obtenir les détails d'une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+#### Modifier les propriétés d'une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+**routeHttp** ^*^
+
+- **action** ^*^
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **status**
+Le code de retour HTTP attendu (nombre)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+- **displayName**
+Le nom de votre route (chaîne de caractères)
+
+- **frontendId**
+L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
+
+- **weight**
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Supprimer une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+### Règles de routage
+
+#### Lister les règles de routages attachées à une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+///
+
+#### Ajouter les règles de routages attachées à une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**field** ^*^
+
+Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
+
+**match** ^*^
+
+L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+**negate**
+
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+**pattern**
+
+Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
+
+**subField**
+
+Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+**RouteRule** ^*^
+
+- **field**
+Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
+
+- **match**
+L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+- **negate**
+Si l'opérateur "match" est inversé ou non (booléen)
+
+- **pattern**
+La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
+
+- **subField**
+Le nom du sous-champ si applicable (chaîne de caractères)
+
+///
+
+#### Supprimer une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+## Protocole TCP
+
+Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
+
+### Fermes TCP
+
+#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**balance**
+
+La méthode de répartition de charge de votre ferme (valeur)
+
+**displayName**
+
+Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
+
+**probe**
+
+Le type de sonde à utiliser sur votre ferme (sonde HTTP)
+
+- **forceSsl**
+L'activation du SSL est forcée pour la sonde (booléen)
+
+- **interval**
+L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
+
+- **match**
+La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (valeur) (contains, default, internal, matches, status)
+
+- **negate**
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+- **method**
+La méthode HTTP utilisée en :code:`type` 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) (HEAD, GET, OPTIONS, internal)
+
+- **pattern**
+réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
+
+- **port**
+Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
+
+- **type**
+Le type de la sonde ; son fonctionnement (valeur) (HTTP, interne, MySQL, OCO, PgSQL, SMTP ou TCP)
+
+- **url**
+L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est défini (chaîne de caractères)
+
+**stickiness**
+
+Le type de persistence de connexion à utiliser pour votre ferme (valeur)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendTcp** ^*^
+
+- **balance**
+Le type de répartition de charge (valeur)
+
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
+
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
+
+- **probe**
+Le type de sonde à utiliser (sonde TCP)
+
+- **stickiness**
+Le type de persistence de connexion (valeur)
+
+///
+
+#### Supprimer une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Serveurs TCP
+
+#### Lister les serveurs liés à la ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**cookie**
+
+Filtrer les valeurs par cookie (chaîne de caractères)
+
+**address**
+
+Filtrer les valeurs par adresse IPv4 (IPv4)
+
+**status**
+
+Filtrer les valeurs par statut du serveur (valeur)
+
+///
+
+#### Ajouter un serveur à une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address** ^*^
+
+L'adresse IPv4 de votre serveur (IPv4)
+
+**backup**
+
+Si votre serveur est configuré comme serveur de secours (booléen)
+
+**chain**
+
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
+
+**displayName**
+
+Le nom donné à votre serveur (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
+
+**probe**
+
+Le type de sonde à utiliser (valeur)
+
+**proxyProtocolVersion**
+
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
+
+**ssl** ^*^
+
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
+
+**weight** ^*^
+
+Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
+
+**status** ^*^
+
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Obtenir les détails d'un serveur lié à une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'un serveur TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre server-link (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendTcpServer** ^*^
+
+- **backup**
+Si votre serveur est configuré comme serveur de secours (booléen)
+
+- **chain**
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
+
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
+
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
+
+- **probe**
+Le type de sonde à utiliser (valeur)
+
+- **proxyProtocolVersion**
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur )
+
+- **ssl**
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
+
+- **status**
+Si votre serveur est activé ou non (booléen)
+
+- **weight**
+Le poids de votre serveur pour votre ferme (nombre)
+
+///
+
+#### Supprimer un serveur d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Frontends TCP
+
+#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**defaultFarmId**
+
+L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (nombre)
+
+**port**
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**allowedSource**
+
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId**
+
+L'identifiant de la ferme TCP par défaut pour votre frontend (nombre)
+
+**defaultSslId**
+
+L'identifiant du certificat SSL par défaut (nombre)
+
+**disabled**
+
+Si votre frontend TCP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend TCP (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**ssl**
+
+Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (booléen)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend TCP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend TCP (nombre)
+
+**FrontendTcp** ^*^
+
+- **allowedSource**
+La liste des adresses IP clientes qui ont accès au Load Balancer (IPv4[])
+
+- **dedicatedIpfo**
+La liste des adresses IP des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **defaultSslId**
+L'identifiant du certificat SSL par défaut (nombre)
+
+- **disabled**
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+- **ssl**
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+///
+
+#### Supprimer un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend (nombre)
+
+///
+
+### Routes TCP
+
+Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+
+#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant d'un frontend TCP (nombre)
+
+///
+
+#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+**displayName**
+
+Le nom de votre route (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant du frontend TCP pour lequel votre route est appliquée (nombre)
+
+**weight**
+
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Obtenir les détails d'une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+#### Modifier les propriétés d'une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+**routeTcp** ^*^
+
+- **action**
+L'action à réaliser (routeTcpAction)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+- **displayName**
+Le nom de votre route (chaîne de caractères)
+
+- **frontendId**
+Le frontend TCP pour lequel votre route est appliquée (nombre)
+
+- **weight**
+La priorité de votre route (nombre) [0 - 255]
+///
+
+#### Supprimer une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+### Règles de routage
+
+#### Lister les règles de routages attachées à une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+///
+
+#### Ajouter les règles de routages attachées à une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**field** ^*^
+
+Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
+
+**match** ^*^
+
+L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+**negate**
+
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+**pattern**
+
+Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
+
+**subField**
+
+Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+**RouteRule** ^*^
+
+- **field**
+Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
+
+- **match**
+L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+- **negate**
+Si l'opérateur "match" est inversé ou non (booléen)
+
+- **pattern**
+La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
+
+- **subField**
+Le nom du sous-champ si applicable (chaîne de caractères)
+
+///
+
+#### Supprimer une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+## Protocole UDP
+
+Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
+
+### Fermes UDP
+
+#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**displayName**
+
+Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
+
+**zone** ^*^
+
+Le nom de votre zone, par exemple : all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendUdp** ^*^
+
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
+
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
+
+///
+
+#### Supprimer une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Serveurs UDP
+
+#### Lister les serveurs liés à la ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address**
+
+Filtrer les valeurs par adresse IPv4 (IPv4)
+
+**status**
+
+Filtrer les valeurs par statut du serveur (valeur)
+
+///
+
+#### Ajouter un serveur à une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address** ^*^
+
+L'adresse IPv4 de votre serveur (IPv4)
+
+**displayName**
+
+Le nom donné à votre serveur (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
+
+**status** ^*^
+
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Obtenir les détails d'un serveur lié à une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'un serveur UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendUdpServer** ^*^
+
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
+
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
+
+- **status**
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Supprimer un serveur d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur UDP (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme UDP (nombre)
+
+///
+
+### Frontends UDP
+
+#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**defaultFarmId**
+
+L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (nombre)
+
+**port**
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone**
+
+Le nom de votre zone, par exemple : all (chaîne de caractères)
+
+///
+
+#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId** ^*^
+
+L'identifiant de la ferme UDP par défaut pour votre frontend (nombre)
+
+**disabled**
+
+Si votre frontend UDP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend UDP (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un frontend UDP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **certificate** *
->> >
->> >> Ajout du certificat SSL (chaîne de caractères)
->> >
->> > **chain**
->> >
->> >> Ajout du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **key** *
->> >
->> >> Ajout de la clé privée (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Obtenir les détails d'un objet SSL
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend UDP
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+**FrontendUdp** ^*^
+
+- **dedicatedIpfo**
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **disabled**
+Si votre frontend UDP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend UDP (chaîne de caractères)
+
+///
+
+#### Supprimer un frontend UDP
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+///
+
+## Autres fonctionnalités
+
+### Additional IP
+
+#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre certificat SSL (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Supprimer un objet SSL
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+### État du service
+
+#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+#### Appliquer les modifications d'un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre certificat SSL (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tâches
+
Paramètres:
-#### Lister les tâches en cours pour un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+### Certificats SSL
+
+#### Lister les certificats SSL d'un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**fingerprint**
+
+Liste l'empreinte du certificat SSL (chaîne de caractères)
+
+**serial**
+
+Liste le numéro d'identification du certificat SSL (chaîne de caractères)
+
+**type**
+
+Type de certificat SSL (valeur)
+
+///
+
+#### Ajouter un nouvel objet SSL
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**certificate** ^*^
+
+Ajout du certificat SSL (chaîne de caractères)
+
+**chain**
+
+Ajout du certificat SSL intermédiaire (chaîne de caractères)
+
+**key** ^*^
+
+Ajout de la clé privée (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un objet SSL
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> Consultation des tâches disponibles (valeurs)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Obtenir les détails d'une tâche
+
Paramètres:
-> [!faq]
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre certificat SSL (nombre)
+
+///
+
+#### Supprimer un objet SSL
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre certificat SSL (nombre)
+
+///
+
+### Tâches
+
+#### Lister les tâches en cours pour un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+Consultation des tâches disponibles (valeurs)
+
+///
+
+#### Obtenir les détails d'une tâche
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre tâche (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre tâche (nombre)
+
+///
+
### Contact
#### Initier un changement de contact
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **contactAdmin**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact administrateur de ce service (chaîne de caractères)
->> >
->> > **contactBilling**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact facturation de ce service (chaîne de caractères)
->> >
->> > **contactTech**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact technique de ce service (chaîne de caractères)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**contactAdmin**
+
+L'identifiant client OVHcloud à configurer pour le contact administrateur de ce service (chaîne de caractères)
+
+**contactBilling**
+
+L'identifiant client OVHcloud à configurer pour le contact facturation de ce service (chaîne de caractères)
+
+**contactTech**
+
+L'identifiant client OVHcloud à configurer pour le contact technique de ce service (chaîne de caractères)
+
+///
+
> [!primary]
>
> Pour plus d'informations sur la gestion des contacts OVHcloud, consultez le guide « [Gérer les contacts de ses services](/pages/account_and_service_management/account_information/managing_contacts) ».
@@ -3065,122 +2791,154 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
#### Description des réseaux privés attachés au load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**subnet**
+
+Permet de filtrer selon le réseau utilisé
+
+**vlan**
+
+Permet de filtrer selon le vlan utilisé
+
+///
+
+#### Ajouter un réseau privé dans le vRack
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **subnet**
->> >
->> >> Permet de filtrer selon le réseau utilisé
->> >
->> > **vlan**
->> >
->> >> Permet de filtrer selon le vlan utilisé
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Ajouter un réseau privé dans le vRack
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**displayName**
+
+Le nom que vous souhaitez attribuer au réseau (chaîne de caractères)
+
+**farmId**
+
+Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé
+
+**natIp**
+
+Un bloc d'IP réservé au load balancer pour joindre les serveurs
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez attribuer au réseau (chaîne de caractères)
->> >
->> > **farmId**
->> >
->> >> Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé
->> >
->> > **natIp**
->> >
->> >> Un bloc d'IP réservé au load balancer pour joindre les serveurs
->> >
->> > **subnet**
->> >
->> >> Le bloc d'IP du réseau privé
->> >
->> > **vlan**
->> >
->> >> Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un vlan
->
-
-#### Récupérer, modifier ou supprimer un réseau privé
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **vrackNetworkId** *
->> >
->> >> L'identifiant du réseau privé
+**subnet**
+
+Le bloc d'IP du réseau privé
+
+**vlan**
+
+Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un vlan
+
+///
+
+#### Récupérer un réseau privé
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modifier la liste des fermes attachées à un réseau privé
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Modifier un réseau privé
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Supprimer un réseau privé
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Modifier la liste des fermes attachées à un réseau privé
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **vrackNetworkId** *
->> >
->> >> L'identifiant du réseau privé
->> >
->> > **farmId** *
->> >
->> >> Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé. La valeur "null" supprime le vrack network id de toutes les fermes où il était configuré.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+**farmId** ^*^
+
+Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé. La valeur "null" supprime le vrack network id de toutes les fermes où il était configuré.
+
+///
+
## Aller plus loin
Échangez avec notre [communauté d'utilisateurs](/links/community).
diff --git a/pages/network/load_balancer/use_api_details/guide.fr-fr.md b/pages/network/load_balancer/use_api_details/guide.fr-fr.md
index 377e8cc63b6..7f0f63875bc 100644
--- a/pages/network/load_balancer/use_api_details/guide.fr-fr.md
+++ b/pages/network/load_balancer/use_api_details/guide.fr-fr.md
@@ -4,6 +4,21 @@ excerpt: "Détails des fonctionnalités de l’API OVHcloud pour l’offre OVHcl
updated: 2025-09-29
---
+
+
+
## Objectif
Ce guide fournit une description détaillée de toutes les fonctions de l'API pour le Load Balancer OVHcloud.
@@ -39,367 +54,331 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing
->
+>
#### Lister les zones disponibles pour le Load Balancer OVHcloud
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/availableZones
->
+>
#### Retourner les détails d'un service Load Balancer OVHcloud
-> [!faq]
->
-> API:
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
->> >
->>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Modifier un service Load Balancer OVHcloud
-> [!faq]
->
-> API:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **Ip** *
->> >
->> >> **displayName**
->> >> >
->> >> > Le nom que vous souhaitez attribuer au service (chaîne de caractères)
->> >
->> >> **sslConfiguration**
->> >>
->> >> > La configuration SSL que vous souhaitez attribuer au service (valeur)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**Ip** ^*^
+
+- **displayName**
+Le nom que vous souhaitez attribuer au service (chaîne de caractères)
+
+- **sslConfiguration**
+La configuration SSL que vous souhaitez attribuer au service (valeur)
+
+///
+
#### Lister les services attachés au Load Balancer OVHcloud
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les fermes existantes et leur type
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **vrackNetworkId**
->> >
->> >> Permet de filtrer selon le réseau vrack
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**vrackNetworkId**
+
+Permet de filtrer selon le réseau vrack
+
+///
+
#### Lister les zones pouvant être attachées à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
+
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de fermes pouvant être utilisées
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de frontends pouvant être utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types d'actions de routage pouvant etre utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Lister les différents types de règles de routage pouvant être utilisés
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
### Service
#### Obtenir les informations du service
-> [!faq]
->
-> Service:
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Paramètres:
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Modifier les informations du service
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
->> >
->> > **Service** *
->> >
->> >> - **automatic**
->> >> >
->> >> > Active le renouvellement automatique du service (booléen))
->> >>
->> >> - **deleteAtExpiration**
->> >> >
->> >> > Active la suppression du service lors de l'expiration (booléen)
->> >>
->> >> - **forced**
->> >> >
->> >> > Force le renouvellement automatique (booléen)
->> >>
->> >> - **period**
->> >> >
->> >> > Renseigne la durée de renouvellement (chaîne de caractères)
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
+
+**Service** ^*^
+
+- **automatic**
+Active le renouvellement automatique du service (booléen))
+
+- **deleteAtExpiration**
+Active la suppression du service lors de l'expiration (booléen)
+
+- **forced**
+Force le renouvellement automatique (booléen)
+
+- **period**
+Renseigne la durée de renouvellement (chaîne de caractères)
+
+///
+
### Zones
#### Lister les zones actives pour un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
+
+///
+
#### Obtenir les détails d'une zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone demandée
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone demandée
+
+///
+
#### Supprimer une zone
Le service sera supprimé à la date d'expiration.
-> [!faq]
->
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone à supprimer
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone à supprimer
+
+///
+
#### Annuler la suppression d'une zone
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **name** *
->> >
->> >> Le nom de la zone a supprimer
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**name** ^*^
+
+Le nom de la zone a supprimer
+
+///
+
## Protocole HTTP
Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
@@ -408,2654 +387,2401 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
#### Lister les fermes HTTP attachées à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de la zone (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone** *
->> >
->> >> Le nom de la zone (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> le nom que vous souhaitez attribuer à votre ferme (chaîne de caractères)
->> >
->> > **balance**
->> >>
->> >> La méthode de répartition de charge de votre ferme (valeur)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **stickiness**
->> >
->> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP)
->> >> >
->> >> > - **forceSsl**
->> >> >
->> >> >> L'activation du SSL est forcée pour la sonde (booléen)
->> >> >
->> >> > - **interval**
->> >> >
->> >> >> L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
->> >> >
->> >> > - **match**
->> >> >
->> >> >> La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (value) [contains, default, internal, matches, status]
->> >> >
->> >> > - **negate**
->> >> >
->> >> >> Le comportement de l'opérateur 'match' est inversé (booléen)
->> >> >
->> >> > - **method**
->> >> >
->> >> >> La méthode HTTP utilisée en type 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) [HEAD, GET, OPTIONS, internal]
->> >> >
->> >> > - **pattern**
->> >> >
->> >> >> Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
->> >> >
->> >> > - **port**
->> >> >
->> >> >> Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> Le type de la sonde ; son fonctionnement (valeur) [HTTP, interne, MySQL, OCO, PgSQL, SMTP, TCP]
->> >> >
->> >> > - **url**
->> >> >
->> >> >> L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est défini (chaîne de caractères)
->
+**serviceName** ^*^
-#### Obtenir les détails d'une ferme HTTP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->
+**zone**
-#### Modifier les propriétés d'une ferme HTTP
+Le nom de la zone (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->> >
->> > **BackendHttp** *
->> >
->> >> - **displayName**
->> >> >
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **balance**
->> >> >
->> >> > Le type de répartition de charge (valeur)
->> >>
->> >> - **port**
->> >> >
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->> >>
->> >> - **probe**
->> >> >
->> >> > Le type de sonde à utiliser (sonde HTTP)
->> >>
->> >> - **stickiness**
->> >> >
->> >> > Le type de persistence de connexion (valeur)
->
+///
-#### Supprimer une ferme HTTP
+#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-### Serveurs HTTP
+
Paramètres:
-#### Lister les serveurs liés à la ferme HTTP
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme HTTP (nombre)
->> >
->> > **cookie**
->> >
->> >> Filtrer les valeurs par cookie (chaîne de caractères)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter un serveur à une ferme HTTP
+**zone** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **backup**
->> >
->> >> Si votre serveur est configuré comme serveur de secours (booléen)
->> >
->> > **chain**
->> >
->> >> La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **cookie**
->> >
->> >> La valeur de votre cookie (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser (valeur)
->> >
->> > **proxyProtocolVersion**
->> >
->> >> La version de proxyProtocol à utiliser,
->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >
->> > **ssl** *
->> >
->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >
->> > **weight** *
->> >
->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+Le nom de la zone (chaîne de caractères)
-#### Obtenir les détails d'un serveur lié à une ferme HTTP
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+le nom que vous souhaitez attribuer à votre ferme (chaîne de caractères)
-#### Modifier les propriétés d'un serveur HTTP
+**balance**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre server-link (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendHttpServer** *
->> >
->> >> - **backup**
->> >> >
->> >> > Si votre serveur est configuré comme serveur de secours (booléen)
->> >>
->> >> - **chain**
->> >> >
->> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >>
->> >> - **cookie**
->> >> >
->> >> > La valeur de votre cookie (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >> >
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >> >
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **probe**
->> >> >
->> >> > Le type de sonde à utiliser (valeur)
->> >>
->> >> - **proxyProtocolVersion**
->> >> >
->> >> > La version de proxyProtocol à utiliser,
->> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >>
->> >> - **ssl**
->> >> >
->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >>
->> >> - **status**
->> >> >
->> >> > Si votre serveur est activé ou non (booléen)
->> >>
->> >> - **weight**
->> >> >
->> >> > Le poids de votre serveur pour votre ferme (nombre)
->
+La méthode de répartition de charge de votre ferme (valeur)
-#### Supprimer un serveur d'une ferme HTTP
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
-### Frontends HTTP
+**stickiness**
-#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
+Le type de persistence de connexion à utiliser pour votre ferme (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, par exemple: all (chaîne de caractères)
->
+**probe**
-#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
+Le type de sonde à utiliser sur votre ferme (sonde HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **allowedSource**
->> >
->> >> La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
->> >>
->> >> NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme HTTP par défaut pour votre frontend (nombre)
->> >
->> > **defaultSslId**
->> >
->> >> L'identifiant du certificat SSL par défaut (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend HTTP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend HTTP (chaîne de caractères)
->> >
->> > **hsts**
->> >
->> >> Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
->> >
->> > **httpHeader**
->> >
->> >> L'entête *http* personnalisé à ajouter (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **redirectLocation**
->> >
->> >> L'URL de redirection *http* (chaîne de caractères)
->> >
->> > **ssl**
->> >
->> >> Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+- **forceSsl**
+L'activation du SSL est forcée pour la sonde (booléen)
-### Obtenir les détails d'un frontend HTTP
+- **interval**
+L'intervalle en secondes entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend HTTP (nombre)
->
+- **match**
+La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (value) [contains, default, internal, matches, status]
-#### Modifier les propriétés d'un frontend HTTP
+- **negate**
+Le comportement de l'opérateur 'match' est inversé (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend HTTP (nombre)
->> >
->> > **FrontendHttp** *
->> >
->> >> - **allowedSource**
->> >> >
->> >> > La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4[])
->> >> >
->> >> > NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
->> >>
->> >> - **dedicatedIpfo**
->> >> >
->> >> > La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **defaultSslId**
->> >> >
->> >> > L'identifiant du certificat SSL par défaut (nombre)
->> >>
->> >> - **disabled**
->> >> >
->> >> > Si votre frontend HTTP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >> >
->> >> > Le nom de votre frontend HTTP (chaîne de caractères)
->> >>
->> >> - **hsts**
->> >> >
->> >> > Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
->> >>
->> >> - **httpHeader**
->> >> >
->> >> > L'en-tête *http* personnalisé à ajouter (chaîne de caractères)
->> >>
->> >> - **ssl**
->> >> >
->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->
+- **method**
+La méthode HTTP utilisée en type 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) [HEAD, GET, OPTIONS, internal]
-#### Supprimer un frontend HTTP
+- **pattern**
+Le format de la réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend (nombre)
->
+- **port**
+Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
-### Routes HTTP
+- **type**
+Le type de la sonde ; son fonctionnement (valeur) [HTTP, interne, MySQL, OCO, PgSQL, SMTP, TCP]
-Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+- **url**
+L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ignoré si ce paramètre est défini (chaîne de caractères)
-#### Lister les routes HTTP attachées à un service Load Balancer
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Paramètres :
+#### Obtenir les détails d'une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant d'un frontend HTTP (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >>
->> >> - **status**
->> >>
->> >> > Le code de retour HTTP attendu (nombre)
->> >>
->> >> - **target**
->> >>
->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >>
->> >> - **type**
->> >>
->> >> > L'action de votre route (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre route (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
->> >
->> > **weight**
->> >
->> >> La priorité de votre route. (nombre) [0 - 255]
->
+**serviceName** ^*^
-#### Obtenir les détails d'une route HTTP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+**farmId** ^*^
-#### Modifier les propriétés d'une route HTTP
+L'identifiant de votre ferme HTTP (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->> >
->> > **routeHttp** *
->> >
->> >> **action** *
->> >>
->> >> > L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >> >
->> >> > - **status**
->> >> >
->> >> >> Le code de retour HTTP attendu (nombre)
->> >> >
->> >> > - **target**
->> >> >
->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> L'action de votre route (chaîne de caractères)
->> >>
->> >> **displayName**
->> >>
->> >> > Le nom de votre route (chaîne de caractères)
->> >>
->> >> **frontendId**
->> >>
->> >> > L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
->> >>
->> >> **weight**
->> >>
->> >> > La priorité de votre route. (nombre) [0 - 255]
->
+///
-#### Supprimer une route HTTP
+#### Modifier les propriétés d'une ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-### Règles de routage
+
Paramètres:
-#### Lister les règles de routages attachées à une route HTTP
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter les règles de routages attachées à une route HTTP
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **field** *
->> >
->> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
->> >
->> > **match** *
->> >
->> >> L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >
->> > **negate**
->> >
->> >> Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >
->> > **pattern**
->> >
->> >> Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
->> >
->> > **subField**
->> >
->> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
->
+L'identifiant de votre ferme HTTP (nombre)
-#### Obtenir les détails d'une règle de routage
+**BackendHttp** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
-#### Modifier les propriétés d'une règle de routage
+- **balance**
+Le type de répartition de charge (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->> >
->> > **RouteRule** *
->> >
->> >> - **field**
->> >>
->> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
->> >>
->> >> - **match**
->> >>
->> >> > L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >>
->> >> - **negate**
->> >>
->> >> > Si l'opérateur "match" est inversé ou non (booléen)
->> >>
->> >> - **pattern**
->> >>
->> >> > La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
->> >>
->> >> - **subField**
->> >>
->> >> > Le nom du sous-champ si applicable (chaîne de caractères)
->
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
-#### Supprimer une règle de routage
+- **probe**
+Le type de sonde à utiliser (sonde HTTP)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
+- **stickiness**
+Le type de persistence de connexion (valeur)
+
+///
+
+#### Supprimer une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route HTTP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-## Protocole TCP
+
Paramètres:
-Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
+**serviceName** ^*^
-### Fermes TCP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre ferme HTTP (nombre)
-#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **balance**
->> >
->> >> La méthode de répartition de charge de votre ferme (valeur)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser sur votre ferme (sonde HTTP)
->> >>
->> >> - **forceSsl**
->> >>
->> >> > L'activation du SSL est forcée pour la sonde (booléen)
->> >>
->> >> - **interval**
->> >>
->> >> > L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
->> >>
->> >> - **match**
->> >>
->> >> > La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (valeur) (contains, default, internal, matches, status)
->> >>
->> >> - **negate**
->> >>
->> >> > Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >>
->> >> - **method**
->> >>
->> >> > La méthode HTTP utilisée en :code:`type` 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) (HEAD, GET, OPTIONS, internal)
->> >>
->> >> - **pattern**
->> >>
->> >> > réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
->> >>
->> >> - **type**
->> >>
->> >> > Le type de la sonde ; son fonctionnement (valeur) (HTTP, interne, MySQL, OCO, PgSQL, SMTP ou TCP)
->> >>
->> >> - **url**
->> >>
->> >> > L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est défini (chaîne de caractères)
->> >>
->> > **stickiness**
->> >
->> >> Le type de persistence de connexion à utiliser pour votre ferme (valeur)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+### Serveurs HTTP
-#### Obtenir les détails d'une ferme TCP
+#### Lister les serveurs liés à la ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-#### Modifier les propriétés d'une ferme TCP
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendTcp** *
->> >
->> >> - **balance**
->> >>
->> >> > Le type de répartition de charge (valeur)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->> >>
->> >> - **probe**
->> >>
->> >> > Le type de sonde à utiliser (sonde TCP)
->> >>
->> >> - **stickiness**
->> >>
->> >> > Le type de persistence de connexion (valeur)
->
+**serviceName** ^*^
-#### Supprimer une ferme TCP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**farmId** ^*^
-### Serveurs TCP
+L'identifiant de votre ferme HTTP (nombre)
-#### Lister les serveurs liés à la ferme TCP
+**cookie**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **cookie**
->> >
->> >> Filtrer les valeurs par cookie (chaîne de caractères)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+Filtrer les valeurs par cookie (chaîne de caractères)
-#### Ajouter un serveur à une ferme TCP
+**address**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **backup**
->> >
->> >> Si votre serveur est configuré comme serveur de secours (booléen)
->> >
->> > **chain**
->> >
->> >> La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **probe**
->> >
->> >> Le type de sonde à utiliser (valeur)
->> >
->> > **proxyProtocolVersion**
->> >
->> >> La version de proxyProtocol à utiliser,
->> >> voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
->> >
->> > **ssl** *
->> >
->> >> Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >
->> > **weight** *
->> >
->> >> Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+Filtrer les valeurs par adresse IPv4 (IPv4)
-#### Obtenir les détails d'un serveur lié à une ferme TCP
+**status**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
-> >
+Filtrer les valeurs par statut du serveur (valeur)
-#### Modifier les propriétés d'un serveur TCP
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre server-link (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendTcpServer** *
->> >
->> >> - **backup**
->> >>
->> >> > Si votre serveur est configuré comme serveur de secours (booléen)
->> >>
->> >> - **chain**
->> >>
->> >> > La valeur du certificat SSL intermédiaire (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **probe**
->> >>
->> >> > Le type de sonde à utiliser (valeur)
->> >>
->> >> - **proxyProtocolVersion**
->> >>
->> >> > La version de proxyProtocol à utiliser,
->> >> > voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur >> )
->> >>
->> >> - **ssl**
->> >>
->> >> > Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
->> >>
->> >> - **status**
->> >>
->> >> > Si votre serveur est activé ou non (booléen)
->> >>
->> >> - **weight**
->> >>
->> >> > Le poids de votre serveur pour votre ferme (nombre)
->
+#### Ajouter un serveur à une ferme HTTP
-#### Supprimer un serveur d'une ferme TCP
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-### Frontends TCP
+
Paramètres:
-#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
+**farmId** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **allowedSource**
->> >
->> >> La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme TCP par défaut pour votre frontend (nombre)
->> >
->> > **defaultSslId**
->> >
->> >> L'identifiant du certificat SSL par défaut (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend TCP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend TCP (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **ssl**
->> >
->> >> Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (booléen)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+L'identifiant de votre ferme (nombre)
-#### Obtenir les détails d'un frontend TCP
+**address** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >>
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >>
->> >> L'identifiant de votre frontend TCP (nombre)
->>
+L'adresse IPv4 de votre serveur (IPv4)
-#### Modifier les propriétés d'un frontend TCP
+**backup**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend TCP (nombre)
->> >
->> > **FrontendTcp** *
->> >
->> >> - **allowedSource**
->> >>
->> >> > La liste des adresses IP clientes qui ont accès au Load Balancer (IPv4[])
->> >>
->> >> - **dedicatedIpfo**
->> >>
->> >> > La liste des adresses IP des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **defaultSslId**
->> >>
->> >> > L'identifiant du certificat SSL par défaut (nombre)
->> >>
->> >> - **disabled**
->> >>
->> >> > Si votre frontend HTTP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre frontend HTTP (chaîne de caractères)
->> >>
->> >> - **ssl**
->> >>
->> >> > Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
->
+Si votre serveur est configuré comme serveur de secours (booléen)
-#### Supprimer un frontend TCP
+**chain**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend (nombre)
->
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
-### Routes TCP
+**cookie**
-Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+La valeur de votre cookie (chaîne de caractères)
-#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
+**displayName**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant d'un frontend TCP (nombre)
->
+Le nom donné à votre serveur (chaîne de caractères)
-#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
->> >>
->> >> - **target**
->> >>
->> >> > L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >>
->> >> - **type**
->> >>
->> >> > L'action de votre route (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre route (chaîne de caractères)
->> >
->> > **frontendId**
->> >
->> >> L'identifiant du frontend TCP pour lequel votre route est appliquée (nombre)
->> >
->> > **weight**
->> >
->> >> La priorité de votre route. (nombre) [0 - 255]
->
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
-#### Obtenir les détails d'une route TCP
+**probe**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+Le type de sonde à utiliser (valeur)
-#### Modifier les propriétés d'une route TCP
+**proxyProtocolVersion**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->> >
->> > **routeTcp** *
->> >
->> >> - **action**
->> >>
->> >> > L'action à réaliser (routeTcpAction)
->> >> >
->> >> > - **target**
->> >> >
->> >> >> L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
->> >> >
->> >> > - **type**
->> >> >
->> >> >> L'action de votre route (chaîne de caractères)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre route (chaîne de caractères)
->> >>
->> >> - **frontendId**
->> >>
->> >> > Le frontend TCP pour lequel votre route est appliquée (nombre)
->> >>
->> >> - **weight**
->> >>
->> >> > La priorité de votre route (nombre) [0 - 255]
->
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
-#### Supprimer une route TCP
+**ssl** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route (nombre)
->
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
-### Règles de routage
+**weight** ^*^
-#### Lister les règles de routages attachées à une route TCP
+Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->
+**status** ^*^
-#### Ajouter les règles de routages attachées à une route TCP
+Si votre serveur est activé ou non (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **field** *
->> >
->> >> Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
->> >
->> > **match** *
->> >
->> >> L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >
->> > **negate**
->> >
->> >> Le comportement de l'opérateur :code:`match` est inversé (booléen)
->> >
->> > **pattern**
->> >
->> >> Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
->> >
->> > **subField**
->> >
->> >> Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
->
+///
-#### Obtenir les détails d'une règle de routage
+#### Obtenir les détails d'un serveur lié à une ferme HTTP
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Modifier les propriétés d'une règle de routage
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->> >
->> > **RouteRule** *
->> >
->> >> - **field**
->> >>
->> >> > Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
->> >>
->> >> - **match**
->> >>
->> >> > L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
->> >>
->> >> - **negate**
->> >>
->> >> > Si l'opérateur "match" est inversé ou non (booléen)
->> >>
->> >> - **pattern**
->> >>
->> >> > La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
->> >>
->> >> - **subField**
->> >>
->> >> > Le nom du sous-champ si applicable (chaîne de caractères)
->
+**serviceName** ^*^
-#### Supprimer une règle de routage
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **routeId** *
->> >
->> >> L'identifiant de votre route TCP (nombre)
->> >
->> > **ruleId** *
->> >
->> >> L'identifiant de votre règle de routage HTTP (nombre)
->
+**serverId** ^*^
-## Protocole UDP
+L'identifiant de votre serveur (nombre)
-Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
+**farmId** ^*^
-### Fermes UDP
+L'identifiant de votre ferme (nombre)
-#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+#### Modifier les propriétés d'un serveur HTTP
-#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, par exemple : all (chaîne de caractères)
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Obtenir les détails d'une ferme UDP
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**serviceName** ^*^
-#### Modifier les propriétés d'une ferme UDP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendUdp** *
->> >
->> >> - **displayName**
->> >>
->> >> > Le nom de la ferme (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de la ferme (nombre, 1..65000)
->
+**serverId** ^*^
-#### Supprimer une ferme UDP
+L'identifiant de votre server-link (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+**farmId** ^*^
-### Serveurs UDP
+L'identifiant de votre ferme (nombre)
-#### Lister les serveurs liés à la ferme UDP
+**BackendHttpServer** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address**
->> >
->> >> Filtrer les valeurs par adresse IPv4 (IPv4)
->> >
->> > **status**
->> >
->> >> Filtrer les valeurs par statut du serveur (valeur)
->
+- **backup**
+Si votre serveur est configuré comme serveur de secours (booléen)
-#### Ajouter un serveur à une ferme UDP
+- **chain**
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **address** *
->> >
->> >> L'adresse IPv4 de votre serveur (IPv4)
->> >
->> > **displayName**
->> >
->> >> Le nom donné à votre serveur (chaîne de caractères)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
->> >
->> > **status** *
->> >
->> >> Si votre serveur est activé ou non (booléen)
->
+- **cookie**
+La valeur de votre cookie (chaîne de caractères)
-#### Obtenir les détails d'un serveur lié à une ferme UDP
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
-#### Modifier les propriétés d'un serveur UDP
+- **probe**
+Le type de sonde à utiliser (valeur)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme (nombre)
->> >
->> > **BackendUdpServer** *
->> >
->> >> - **displayName**
->> >>
->> >> > Le nom de votre serveur (chaîne de caractères)
->> >>
->> >> - **port**
->> >>
->> >> > Le port d'écoute de votre serveur (nombre, 1..65535)
->> >>
->> >> - **status**
->> >>
->> >> > Si votre serveur est activé ou non (booléen)
->
+- **proxyProtocolVersion**
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
-#### Supprimer un serveur d'une ferme UDP
+- **ssl**
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **serverId** *
->> >
->> >> L'identifiant de votre serveur UDP (nombre)
->> >
->> > **farmId** *
->> >
->> >> L'identifiant de votre ferme UDP (nombre)
->
+- **status**
+Si votre serveur est activé ou non (booléen)
-### Frontends UDP
+- **weight**
+Le poids de votre serveur pour votre ferme (nombre)
-#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
+///
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Paramètres :
+#### Supprimer un serveur d'une ferme HTTP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **defaultFarmId**
->> >
->> >> L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (nombre)
->> >
->> > **port**
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone**
->> >
->> >> Le nom de votre zone, par exemple : all (chaîne de caractères)
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
+
Paramètres:
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **dedicatedIpfo**
->> >
->> >> La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >
->> > **defaultFarmId** *
->> >
->> >> L'identifiant de la ferme UDP par défaut pour votre frontend (nombre)
->> >
->> > **disabled**
->> >
->> >> Si votre frontend UDP est désactivé ou activé (booléen)
->> >
->> > **displayName**
->> >
->> >> Le nom de votre frontend UDP (chaîne de caractères)
->> >
->> > **port** *
->> >
->> >> Le port d'écoute de votre frontend (nombre, 1..65535)
->> >
->> > **zone** *
->> >
->> >> Le nom de votre zone, ex: all (chaîne de caractères)
->
+**serviceName** ^*^
-#### Obtenir les détails d'un frontend UDP
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->
+**serverId** ^*^
-#### Modifier les propriétés d'un frontend UDP
+L'identifiant de votre serveur (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->> >
->> > **FrontendUdp** *
->> >
->> >> - **dedicatedIpfo**
->> >>
->> >> > La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
->> >>
->> >> - **disabled**
->> >>
->> >> > Si votre frontend UDP est désactivé ou activé (booléen)
->> >>
->> >> - **displayName**
->> >>
->> >> > Le nom de votre frontend UDP (chaîne de caractères)
->
+**farmId** ^*^
-#### Supprimer un frontend UDP
+L'identifiant de votre ferme (nombre)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **frontendId** *
->> >
->> >> L'identifiant de votre frontend UDP (nombre)
->
+///
-## Autres fonctionnalités
+### Frontends HTTP
-### Additional IP
+#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
-#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
+/// details |
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
->> >
->>
->
-> Paramètres :
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-### État du service
+
Paramètres:
-#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
-#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
+**defaultFarmId**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+L'identifiant de la ferme HTTP à laquelle le frontend HTTP est lié (nombre)
-#### Appliquer les modifications d'un service Load Balancer OVHcloud
+**port**
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->
+Le port d'écoute de votre frontend (nombre, 1..65535)
-### Certificats SSL
+**zone**
-#### Lister les certificats SSL d'un service Load Balancer OVHcloud
+Le nom de votre zone, par exemple: all (chaîne de caractères)
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **fingerprint**
->> >
->> >> Liste l'empreinte du certificat SSL (chaîne de caractères)
->> >
->> > **serial**
->> >
->> >> Liste le numéro d'identification du certificat SSL (chaîne de caractères)
->> >
->> > **type**
->> >
->> >> Type de certificat SSL (valeur)
->
+///
-#### Ajouter un nouvel objet SSL
+#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
->> >
->>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**allowedSource**
+
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
+
+NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId**
+
+L'identifiant de la ferme HTTP par défaut pour votre frontend (nombre)
+
+**defaultSslId**
+
+L'identifiant du certificat SSL par défaut (nombre)
+
+**disabled**
+
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+**hsts**
+
+Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
+
+**httpHeader**
+
+L'entête *http* personnalisé à ajouter (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**redirectLocation**
+
+L'URL de redirection *http* (chaîne de caractères)
+
+**ssl**
+
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+### Obtenir les détails d'un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend HTTP (nombre)
+
+**FrontendHttp** ^*^
+
+- **allowedSource**
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4[])
+
+NB: le filtrage s'effectue au niveau du Load Balancer, donc si le Load Balancer ainsi que les serveurs ne sont pas dans un vRack, vos serveurs sont directement accessibles depuis Internet
+
+- **dedicatedIpfo**
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **defaultSslId**
+L'identifiant du certificat SSL par défaut (nombre)
+
+- **disabled**
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+- **hsts**
+Si le support du *https strict, HTTP Strict Transport Security* est activé ou désactivé (booléen)
+
+- **httpHeader**
+L'en-tête *http* personnalisé à ajouter (chaîne de caractères)
+
+- **ssl**
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+///
+
+#### Supprimer un frontend HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend (nombre)
+
+///
+
+### Routes HTTP
+
+Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+
+#### Lister les routes HTTP attachées à un service Load Balancer
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant d'un frontend HTTP (nombre)
+
+///
+
+#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **status**
+Le code de retour HTTP attendu (nombre)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+**displayName**
+
+Le nom de votre route (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
+
+**weight**
+
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Obtenir les détails d'une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+#### Modifier les propriétés d'une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+**routeHttp** ^*^
+
+- **action** ^*^
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **status**
+Le code de retour HTTP attendu (nombre)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+- **displayName**
+Le nom de votre route (chaîne de caractères)
+
+- **frontendId**
+L'identifiant du frontend HTTP pour lequel votre route est appliquée (nombre)
+
+- **weight**
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Supprimer une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+### Règles de routage
+
+#### Lister les règles de routages attachées à une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+///
+
+#### Ajouter les règles de routages attachées à une route HTTP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**field** ^*^
+
+Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
+
+**match** ^*^
+
+L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+**negate**
+
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+**pattern**
+
+Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
+
+**subField**
+
+Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+**RouteRule** ^*^
+
+- **field**
+Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
+
+- **match**
+L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+- **negate**
+Si l'opérateur "match" est inversé ou non (booléen)
+
+- **pattern**
+La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
+
+- **subField**
+Le nom du sous-champ si applicable (chaîne de caractères)
+
+///
+
+#### Supprimer une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route HTTP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+## Protocole TCP
+
+Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
+
+### Fermes TCP
+
+#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**balance**
+
+La méthode de répartition de charge de votre ferme (valeur)
+
+**displayName**
+
+Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
+
+**probe**
+
+Le type de sonde à utiliser sur votre ferme (sonde HTTP)
+
+- **forceSsl**
+L'activation du SSL est forcée pour la sonde (booléen)
+
+- **interval**
+L'intervalle (en secondes) entre chaque test de la sonde. Doit être supérieur à 30. 30 par défaut (nombre)
+
+- **match**
+La méthode de correspondance utilisée. 'default' utilise le comportement standard de HAProxy. 'status' n'est supporté que pour les sondes HTTP (valeur) (contains, default, internal, matches, status)
+
+- **negate**
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+- **method**
+La méthode HTTP utilisée en :code:`type` 'http'. 'HEAD' peut économiser de la bande passante. 'GET' par défaut (valeur) (HEAD, GET, OPTIONS, internal)
+
+- **pattern**
+réponse du serveur quand "UP". Vide pour 'default', liste de statuts séparés par des virgules pour 'status', texte pour 'contains', expression régulière pour 'matches' (chaîne de caractères)
+
+- **port**
+Le port que la sonde doit utiliser pour tester les serveurs attachés à votre ferme. Ignoré pour les sondes 'oco'. Si non-défini, le port de la ferme est utilisé (nombre)
+
+- **type**
+Le type de la sonde ; son fonctionnement (valeur) (HTTP, interne, MySQL, OCO, PgSQL, SMTP ou TCP)
+
+- **url**
+L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le :code:`type` est ignoré si ce paramètre est défini (chaîne de caractères)
+
+**stickiness**
+
+Le type de persistence de connexion à utiliser pour votre ferme (valeur)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendTcp** ^*^
+
+- **balance**
+Le type de répartition de charge (valeur)
+
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
+
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
+
+- **probe**
+Le type de sonde à utiliser (sonde TCP)
+
+- **stickiness**
+Le type de persistence de connexion (valeur)
+
+///
+
+#### Supprimer une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Serveurs TCP
+
+#### Lister les serveurs liés à la ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**cookie**
+
+Filtrer les valeurs par cookie (chaîne de caractères)
+
+**address**
+
+Filtrer les valeurs par adresse IPv4 (IPv4)
+
+**status**
+
+Filtrer les valeurs par statut du serveur (valeur)
+
+///
+
+#### Ajouter un serveur à une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address** ^*^
+
+L'adresse IPv4 de votre serveur (IPv4)
+
+**backup**
+
+Si votre serveur est configuré comme serveur de secours (booléen)
+
+**chain**
+
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
+
+**displayName**
+
+Le nom donné à votre serveur (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
+
+**probe**
+
+Le type de sonde à utiliser (valeur)
+
+**proxyProtocolVersion**
+
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
+
+**ssl** ^*^
+
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
+
+**weight** ^*^
+
+Le poids de votre serveur pour votre ferme. Un serveur à poids élevé reçoit plus de requêtes (nombre)
+
+**status** ^*^
+
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Obtenir les détails d'un serveur lié à une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'un serveur TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre server-link (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendTcpServer** ^*^
+
+- **backup**
+Si votre serveur est configuré comme serveur de secours (booléen)
+
+- **chain**
+La valeur du certificat SSL intermédiaire (chaîne de caractères)
+
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
+
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
+
+- **probe**
+Le type de sonde à utiliser (valeur)
+
+- **proxyProtocolVersion**
+La version de proxyProtocol à utiliser,
+voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur )
+
+- **ssl**
+Si les requêtes envoyées à vos serveurs doivent être chiffrées avec SSL (booléen)
+
+- **status**
+Si votre serveur est activé ou non (booléen)
+
+- **weight**
+Le poids de votre serveur pour votre ferme (nombre)
+
+///
+
+#### Supprimer un serveur d'une ferme TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Frontends TCP
+
+#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**defaultFarmId**
+
+L'identifiant de la ferme TCP à laquelle le frontend TCP est lié (nombre)
+
+**port**
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**allowedSource**
+
+La liste des adresses IPs clientes qui ont accès au Load Balancer (IPv4)
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId**
+
+L'identifiant de la ferme TCP par défaut pour votre frontend (nombre)
+
+**defaultSslId**
+
+L'identifiant du certificat SSL par défaut (nombre)
+
+**disabled**
+
+Si votre frontend TCP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend TCP (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**ssl**
+
+Si les requêtes envoyées à la ferme TCP doivent être chiffrées avec SSL ou non (booléen)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend TCP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend TCP (nombre)
+
+**FrontendTcp** ^*^
+
+- **allowedSource**
+La liste des adresses IP clientes qui ont accès au Load Balancer (IPv4[])
+
+- **dedicatedIpfo**
+La liste des adresses IP des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **defaultSslId**
+L'identifiant du certificat SSL par défaut (nombre)
+
+- **disabled**
+Si votre frontend HTTP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend HTTP (chaîne de caractères)
+
+- **ssl**
+Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou non (booléen)
+
+///
+
+#### Supprimer un frontend TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend (nombre)
+
+///
+
+### Routes TCP
+
+Les routes sont évaluées une par une, en testant leurs règles de routage. La première route validant toutes ses règles voit son action exécutée, et arrête l'évaluation des routes restantes. L'ordre d'exécution est défini par le type et le poids de la route.
+
+#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant d'un frontend TCP (nombre)
+
+///
+
+#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+L'action déclenchée quand toutes les règles de votre route sont validées (RouteHttpAction)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+**displayName**
+
+Le nom de votre route (chaîne de caractères)
+
+**frontendId**
+
+L'identifiant du frontend TCP pour lequel votre route est appliquée (nombre)
+
+**weight**
+
+La priorité de votre route. (nombre) [0 - 255]
+///
+
+#### Obtenir les détails d'une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+#### Modifier les propriétés d'une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+**routeTcp** ^*^
+
+- **action**
+L'action à réaliser (routeTcpAction)
+
+- **target**
+L'identifiant de la ferme, ou le modèle pour l'URL (chaîne de caractères)
+
+- **type**
+L'action de votre route (chaîne de caractères)
+
+- **displayName**
+Le nom de votre route (chaîne de caractères)
+
+- **frontendId**
+Le frontend TCP pour lequel votre route est appliquée (nombre)
+
+- **weight**
+La priorité de votre route (nombre) [0 - 255]
+///
+
+#### Supprimer une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route (nombre)
+
+///
+
+### Règles de routage
+
+#### Lister les règles de routages attachées à une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+///
+
+#### Ajouter les règles de routages attachées à une route TCP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**field** ^*^
+
+Le nom du champ à tester avec l'opérateur "match" (chaîne de caractères)
+
+**match** ^*^
+
+L'opérateur de comparaison (valeur) (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+**negate**
+
+Le comportement de l'opérateur :code:`match` est inversé (booléen)
+
+**pattern**
+
+Le schéma ou l'expression régulière utilisée par l'opérateur "match" (Regex / Chaîne de caractères)
+
+**subField**
+
+Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête, par exemple (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+#### Modifier les propriétés d'une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+**RouteRule** ^*^
+
+- **field**
+Le nom du champ à tester via l'opérateur "match" (chaîne de caractères)
+
+- **match**
+L'opérateur de comparaison à utiliser (contains, endsWith, exists, in, internal, is, matches, startsWith)
+
+- **negate**
+Si l'opérateur "match" est inversé ou non (booléen)
+
+- **pattern**
+La valeur ou l'expression régulière à utiliser avec l'opérateur "match" (Regex / Chaîne de caractères)
+
+- **subField**
+Le nom du sous-champ si applicable (chaîne de caractères)
+
+///
+
+#### Supprimer une règle de routage
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**routeId** ^*^
+
+L'identifiant de votre route TCP (nombre)
+
+**ruleId** ^*^
+
+L'identifiant de votre règle de routage HTTP (nombre)
+
+///
+
+## Protocole UDP
+
+Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
+
+### Fermes UDP
+
+#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**zone**
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**displayName**
+
+Le nom que vous souhaitez donner à votre ferme (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre ferme. Hérité du frontend si non-défini (nombre, 1..65535)
+
+**zone** ^*^
+
+Le nom de votre zone, par exemple : all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendUdp** ^*^
+
+- **displayName**
+Le nom de la ferme (chaîne de caractères)
+
+- **port**
+Le port d'écoute de la ferme (nombre, 1..65000)
+
+///
+
+#### Supprimer une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+### Serveurs UDP
+
+#### Lister les serveurs liés à la ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address**
+
+Filtrer les valeurs par adresse IPv4 (IPv4)
+
+**status**
+
+Filtrer les valeurs par statut du serveur (valeur)
+
+///
+
+#### Ajouter un serveur à une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**address** ^*^
+
+L'adresse IPv4 de votre serveur (IPv4)
+
+**displayName**
+
+Le nom donné à votre serveur (chaîne de caractères)
+
+**port**
+
+Le port d'écoute de votre serveur. Hérité de votre ferme si non-défini (nombre, 1..65535)
+
+**status** ^*^
+
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Obtenir les détails d'un serveur lié à une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+///
+
+#### Modifier les propriétés d'un serveur UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme (nombre)
+
+**BackendUdpServer** ^*^
+
+- **displayName**
+Le nom de votre serveur (chaîne de caractères)
+
+- **port**
+Le port d'écoute de votre serveur (nombre, 1..65535)
+
+- **status**
+Si votre serveur est activé ou non (booléen)
+
+///
+
+#### Supprimer un serveur d'une ferme UDP
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**serverId** ^*^
+
+L'identifiant de votre serveur UDP (nombre)
+
+**farmId** ^*^
+
+L'identifiant de votre ferme UDP (nombre)
+
+///
+
+### Frontends UDP
+
+#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**defaultFarmId**
+
+L'identifiant de la ferme UDP à laquelle le frontend UDP est lié (nombre)
+
+**port**
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone**
+
+Le nom de votre zone, par exemple : all (chaîne de caractères)
+
+///
+
+#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**dedicatedIpfo**
+
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+**defaultFarmId** ^*^
+
+L'identifiant de la ferme UDP par défaut pour votre frontend (nombre)
+
+**disabled**
+
+Si votre frontend UDP est désactivé ou activé (booléen)
+
+**displayName**
+
+Le nom de votre frontend UDP (chaîne de caractères)
+
+**port** ^*^
+
+Le port d'écoute de votre frontend (nombre, 1..65535)
+
+**zone** ^*^
+
+Le nom de votre zone, ex: all (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un frontend UDP
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **certificate** *
->> >
->> >> Ajout du certificat SSL (chaîne de caractères)
->> >
->> > **chain**
->> >
->> >> Ajout du certificat SSL intermédiaire (chaîne de caractères)
->> >
->> > **key** *
->> >
->> >> Ajout de la clé privée (chaîne de caractères)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-#### Obtenir les détails d'un objet SSL
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+///
+
+#### Modifier les propriétés d'un frontend UDP
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+**FrontendUdp** ^*^
+
+- **dedicatedIpfo**
+La liste des adresses IPs des serveurs distants auxquels votre Load Balancer est connecté (IPv4[])
+
+- **disabled**
+Si votre frontend UDP est désactivé ou activé (booléen)
+
+- **displayName**
+Le nom de votre frontend UDP (chaîne de caractères)
+
+///
+
+#### Supprimer un frontend UDP
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**frontendId** ^*^
+
+L'identifiant de votre frontend UDP (nombre)
+
+///
+
+## Autres fonctionnalités
+
+### Additional IP
+
+#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre certificat SSL (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-#### Supprimer un objet SSL
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+### État du service
+
+#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
+
+/// details |
-> [!faq]
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-> Service :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+#### Appliquer les modifications d'un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre certificat SSL (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-### Tâches
+
Paramètres:
-#### Lister les tâches en cours pour un service Load Balancer OVHcloud
+**serviceName** ^*^
-> [!faq]
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+///
+
+### Certificats SSL
+
+#### Lister les certificats SSL d'un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
->> >
->>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**fingerprint**
+
+Liste l'empreinte du certificat SSL (chaîne de caractères)
+
+**serial**
+
+Liste le numéro d'identification du certificat SSL (chaîne de caractères)
+
+**type**
+
+Type de certificat SSL (valeur)
+
+///
+
+#### Ajouter un nouvel objet SSL
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**certificate** ^*^
+
+Ajout du certificat SSL (chaîne de caractères)
+
+**chain**
+
+Ajout du certificat SSL intermédiaire (chaîne de caractères)
+
+**key** ^*^
+
+Ajout de la clé privée (chaîne de caractères)
+
+///
+
+#### Obtenir les détails d'un objet SSL
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **action** *
->> >
->> >> Consultation des tâches disponibles (valeurs)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-#### Obtenir les détails d'une tâche
+
Paramètres:
-> [!faq]
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre certificat SSL (nombre)
+
+///
+
+#### Supprimer un objet SSL
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-> Service :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre certificat SSL (nombre)
+
+///
+
+### Tâches
+
+#### Lister les tâches en cours pour un service Load Balancer OVHcloud
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**action** ^*^
+
+Consultation des tâches disponibles (valeurs)
+
+///
+
+#### Obtenir les détails d'une tâche
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **id** *
->> >
->> >> L'identifiant de votre tâche (nombre)
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**id** ^*^
+
+L'identifiant de votre tâche (nombre)
+
+///
+
### Contact
#### Initier un changement de contact
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
->> >
->>
->
-> Paramètres :
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **contactAdmin**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact administrateur de ce service (chaîne de caractères)
->> >
->> > **contactBilling**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact facturation de ce service (chaîne de caractères)
->> >
->> > **contactTech**
->> >
->> >> L'identifiant client OVHcloud à configurer pour le contact technique de ce service (chaîne de caractères)
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**contactAdmin**
+
+L'identifiant client OVHcloud à configurer pour le contact administrateur de ce service (chaîne de caractères)
+
+**contactBilling**
+
+L'identifiant client OVHcloud à configurer pour le contact facturation de ce service (chaîne de caractères)
+
+**contactTech**
+
+L'identifiant client OVHcloud à configurer pour le contact technique de ce service (chaîne de caractères)
+
+///
+
> [!primary]
>
> Pour plus d'informations sur la gestion des contacts OVHcloud, consultez le guide « [Gérer les contacts de ses services](/pages/account_and_service_management/account_information/managing_contacts) ».
@@ -3065,122 +2791,154 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
#### Description des réseaux privés attachés au load balancer
-> [!faq]
->
-> Service :
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**subnet**
+
+Permet de filtrer selon le réseau utilisé
+
+**vlan**
+
+Permet de filtrer selon le vlan utilisé
+
+///
+
+#### Ajouter un réseau privé dans le vRack
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **subnet**
->> >
->> >> Permet de filtrer selon le réseau utilisé
->> >
->> > **vlan**
->> >
->> >> Permet de filtrer selon le vlan utilisé
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-#### Ajouter un réseau privé dans le vRack
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**displayName**
+
+Le nom que vous souhaitez attribuer au réseau (chaîne de caractères)
+
+**farmId**
+
+Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé
+
+**natIp**
+
+Un bloc d'IP réservé au load balancer pour joindre les serveurs
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **displayName**
->> >
->> >> Le nom que vous souhaitez attribuer au réseau (chaîne de caractères)
->> >
->> > **farmId**
->> >
->> >> Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé
->> >
->> > **natIp**
->> >
->> >> Un bloc d'IP réservé au load balancer pour joindre les serveurs
->> >
->> > **subnet**
->> >
->> >> Le bloc d'IP du réseau privé
->> >
->> > **vlan**
->> >
->> >> Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un vlan
->
-
-#### Récupérer, modifier ou supprimer un réseau privé
-
-> [!faq]
->
-> Service :
->
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> > @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
->> >
->>
->
-> Paramètres :
->
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **vrackNetworkId** *
->> >
->> >> L'identifiant du réseau privé
+**subnet**
+
+Le bloc d'IP du réseau privé
+
+**vlan**
+
+Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un vlan
+
+///
+
+#### Récupérer un réseau privé
+
+/// details |
+
+> [!api]
+>
+> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-#### Modifier la liste des fermes attachées à un réseau privé
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Modifier un réseau privé
-> [!faq]
+/// details |
+
+> [!api]
>
-> Service :
+> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
+>
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Supprimer un réseau privé
+
+/// details |
+
+> [!api]
>
->> > [!api]
->> >
->> > @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
->> >
->>
+> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-> Paramètres :
+
+
Paramètres:
+
+**serviceName** ^*^
+
+L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
+
+**vrackNetworkId** ^*^
+
+L'identifiant du réseau privé
+
+///
+
+#### Modifier la liste des fermes attachées à un réseau privé
+
+/// details |
+
+> [!api]
>
->> > **serviceName** *
->> >
->> >> L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef0123456789" (chaîne de caractères)
->> >
->> > **vrackNetworkId** *
->> >
->> >> L'identifiant du réseau privé
->> >
->> > **farmId** *
->> >
->> >> Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé. La valeur "null" supprime le vrack network id de toutes les fermes où il était configuré.
+> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
+
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
>
## Services and zones
-
### OVHcloud Load Balancer
#### List active services
@@ -65,14 +277,14 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
#### Return details of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
>
## Services and zones
-
### OVHcloud Load Balancer
#### List active services
@@ -65,14 +277,14 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
#### Return details of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
>
## Services and zones
-
### OVHcloud Load Balancer
#### List active services
@@ -65,14 +277,14 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
#### Return details of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Parameters:
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
>
## Services and zones
-
### OVHcloud Load Balancer
#### List active services
@@ -65,14 +277,14 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
#### Return details of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
>
## Services and zones
-
### OVHcloud Load Balancer
#### List active services
@@ -65,14 +277,14 @@ All API calls that are made in the section */ipLoadbalancing* are available on [
#### Return details of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ The SSL configuration you want to assign to the service (Value)
#### List the services attached to the OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List existing farms and their type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Allows filtering according to the vrack network
#### List the areas that can be attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different probes that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of farms that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of frontends that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing actions that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### List the different types of routing rules that can be used
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Get service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
#### Modify service information
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Fill in the renewal term (String of characters)
#### List active zones for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
#### Get the details of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ The name of the requested zone
The service will be discontinued on the expiry date.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ The service will be discontinued on the expiry date.
#### Undo the deletion of a zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -380,20 +592,21 @@ The name of the zone to be deleted
///
## HTTP Protocol
+
Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
### HTTP farms
#### List HTTP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -407,14 +620,14 @@ The name of the zone (String of characters)
#### Adding a new HTTP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -475,14 +688,14 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
#### Getting the details of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -496,14 +709,14 @@ The identifier of your HTTP farm (Number)
#### Modify the properties of an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -534,14 +747,14 @@ The type of connection persistence (Value)
#### Delete an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -557,14 +770,14 @@ The identifier of your HTTP farm (Number)
#### List the servers linked to the HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -590,14 +803,14 @@ Filter Values by server status (Value)
#### Adding a server to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -638,6 +851,7 @@ 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** ^*^
@@ -656,14 +870,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -681,14 +895,14 @@ The identifier of your farm (Number)
#### Modify the properties of an HTTP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -724,6 +938,7 @@ 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**
@@ -739,14 +954,14 @@ The weight of your server for your farm (Number)
#### Removing a server from an HTTP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -766,14 +981,14 @@ The identifier of your farm (Number)
#### List HTTP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -795,14 +1010,14 @@ The name of your zone, ex: all (String of characters)
#### Add an HTTP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -862,14 +1077,14 @@ The name of your zone, ex: all (String of characters)
### Get the details of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -883,14 +1098,14 @@ The identifier of your HTTP frontend (Number)
#### Modify the properties of an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -932,14 +1147,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete an HTTP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -952,18 +1167,19 @@ The identifier of your frontend (Number)
///
### Routes HTTP
+
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.
#### List the HTTP routes attached to a Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -977,14 +1193,14 @@ The identifier of an HTTP frontend (Number)
#### Add a new HTTP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1018,14 +1234,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1039,14 +1255,14 @@ The identifier of your route (number)
#### Modify the properties of an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1082,14 +1298,14 @@ The priority of your route. (Number) [0 - 255]
#### Delete an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1105,14 +1321,14 @@ The identifier of your route (number)
#### List the routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1126,14 +1342,14 @@ The identifier of your HTTP route (Number)
#### Add routing rules attached to an HTTP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1167,14 +1383,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1192,14 +1408,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1234,14 +1450,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1258,20 +1474,21 @@ The identifier of your HTTP routing rule (Number)
///
## Protocol TCP
+
Access the elements related to the TCP protocol (Frontend, Farm, etc.).
### TCP Farms
#### List TCP farms attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1285,14 +1502,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new TCP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1353,14 +1570,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1374,14 +1591,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1412,14 +1629,14 @@ The type of connection persistence (Value)
#### Delete a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1435,14 +1652,14 @@ The identifier of your farm (Number)
#### List the servers linked to the TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1468,14 +1685,14 @@ Filter Values by Server Status (Value)
#### Add a server to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1512,6 +1729,7 @@ 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** ^*^
@@ -1530,14 +1748,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1555,14 +1773,14 @@ The identifier of your farm (Number)
#### Modify the properties of a TCP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1595,6 +1813,7 @@ 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**
@@ -1610,14 +1829,14 @@ The weight of your server for your farm (Number)
#### Delete a server from a TCP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1637,14 +1856,14 @@ The identifier of your farm (Number)
#### List TCP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1666,14 +1885,14 @@ The name of your zone, ex: all (String of characters)
#### Add a TCP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1719,14 +1938,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1740,14 +1959,14 @@ The identifier of your frontend TCP (Number)
#### Modify the properties of a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1781,14 +2000,14 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
#### Delete a TCP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1801,18 +2020,19 @@ The identifier of your frontend (Number)
///
### Routes TCP
+
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.
#### List TCP routes attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1826,14 +2046,14 @@ The identifier of a TCP frontend (Number)
#### Add a new TCP route to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1864,14 +2084,14 @@ The priority of your route. (Number) [0 - 255]
#### Get the details of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1885,14 +2105,14 @@ The identifier of your route (number)
#### Modify the properties of a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1925,14 +2145,14 @@ The priority of your route (Number) [0 - 255]
#### Delete a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1948,14 +2168,14 @@ The identifier of your route (number)
#### List the routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1969,14 +2189,14 @@ The identifier of your TCP route (Number)
#### Add routing rules attached to a TCP route
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2010,14 +2230,14 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
#### Get the details of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2035,14 +2255,14 @@ The identifier of your HTTP routing rule (Number)
#### Modify the properties of a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2077,14 +2297,14 @@ The name of the sub-field if applicable (String of characters)
#### Delete a routing rule
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2101,20 +2321,21 @@ The identifier of your HTTP routing rule (Number)
///
## UDP Protocol
+
Access the UDP protocol elements (Frontend, Farm, etc.).
### UDP Farms
#### List UDP trusses attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2128,14 +2349,14 @@ The name of your zone, ex: all (String of characters)
#### Add a new UDP farm to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2157,14 +2378,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2178,14 +2399,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
**serviceName** ^*^
@@ -2230,14 +2451,14 @@ The identifier of your farm (Number)
#### List the servers linked to the UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2259,14 +2480,14 @@ Filter Values by Server Status (Value)
#### Adding a server to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2296,14 +2517,14 @@ If your server is activated or not (Boolean)
#### Get the details of a server linked to a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2321,14 +2542,14 @@ The identifier of your farm (Number)
#### Modify the properties of a UDP server
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2357,14 +2578,14 @@ If your server is activated or not (Boolean)
#### Removing a server from a UDP farm
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2384,14 +2605,14 @@ The identifier of your farm UDP (Number)
#### List UDP frontends attached to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2413,14 +2634,14 @@ The name of your zone, ex: all (String of characters)
#### Add a UDP frontend to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2454,14 +2675,14 @@ The name of your zone, ex: all (String of characters)
#### Get the details of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2475,14 +2696,14 @@ The identifier of your frontend UDP (Number)
#### Modify the properties of a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2507,14 +2728,14 @@ The name of your UDP frontend (String of characters)
#### Delete a UDP frontend
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2532,14 +2753,14 @@ The identifier of your frontend UDP (Number)
#### List Additional IPs routed on a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2551,14 +2772,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service OVHcloud Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2568,14 +2789,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List the output IPs used by OVH for NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2585,14 +2806,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### Apply changes to a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2604,14 +2825,14 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
#### List SSL certificates of a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2633,14 +2854,14 @@ Type of SSL certificate (Value)
#### Add a new SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2662,14 +2883,14 @@ Adding the private key (String of characters)
#### Get the details of an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2683,14 +2904,14 @@ The identifier of your SSL certificate (Number)
#### Delete an SSL object
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2706,14 +2927,14 @@ The identifier of your SSL certificate (Number)
#### List current tasks for a OVHcloud Load Balancer service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2727,14 +2948,14 @@ Consultation of available tasks (Values)
#### Get the details of a task
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2750,14 +2971,14 @@ The identifier of your task (Number)
#### Initiate a contact change
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2781,14 +3002,14 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
#### Description of the private networks attached to the load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2806,14 +3027,14 @@ Allows to filter according to the vlan used
#### Add a private network in the vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2843,14 +3064,14 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
#### Retrieve a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2864,14 +3085,14 @@ The identifier of the private network
#### Modify a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2885,14 +3106,14 @@ The identifier of the private network
#### Delete a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2906,14 +3127,14 @@ The identifier of the private network
#### Modify the list of farms attached to a private network
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Parameters:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2932,3 +3153,4 @@ Table of farm identifiers that you wish to attach to this private network. The V
## Go further
Interact with our user community on
@@ -46,7 +259,6 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
>
## Services et zones
-
### Load Balancer OVHcloud
#### Lister les services actifs
@@ -65,14 +277,14 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
#### Retourner les détails d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Modifier un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ La configuration SSL que vous souhaitez attribuer au service (valeur)
#### Lister les services attachés au Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les fermes existantes et leur type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Permet de filtrer selon le réseau vrack
#### Lister les zones pouvant être attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différentes sondes pouvant être utilisées
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de fermes pouvant être utilisées
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de frontends pouvant être utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types d'actions de routage pouvant etre utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de règles de routage pouvant être utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Obtenir les informations du service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Modifier les informations du service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Renseigne la durée de renouvellement (chaîne de caractères)
#### Lister les zones actives pour un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
#### Obtenir les détails d'une zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ Le nom de la zone demandée
Le service sera supprimé à la date d'expiration.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ Le nom de la zone à supprimer
#### Annuler la suppression d'une zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -387,14 +599,14 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
#### Lister les fermes HTTP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -408,14 +620,14 @@ Le nom de la zone (chaîne de caractères)
#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -476,14 +688,14 @@ L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ign
#### Obtenir les détails d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -497,14 +709,14 @@ L'identifiant de votre ferme HTTP (nombre)
#### Modifier les propriétés d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -535,14 +747,14 @@ Le type de persistence de connexion (valeur)
#### Supprimer une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -558,14 +770,14 @@ L'identifiant de votre ferme HTTP (nombre)
#### Lister les serveurs liés à la ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -591,14 +803,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -639,6 +851,7 @@ Le type de sonde à utiliser (valeur)
**proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
**ssl** ^*^
@@ -657,14 +870,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -682,14 +895,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -725,6 +938,7 @@ Le type de sonde à utiliser (valeur)
- **proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
- **ssl**
@@ -740,14 +954,14 @@ Le poids de votre serveur pour votre ferme (nombre)
#### Supprimer un serveur d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -767,14 +981,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -796,14 +1010,14 @@ Le nom de votre zone, par exemple: all (chaîne de caractères)
#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -863,14 +1077,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
### Obtenir les détails d'un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -884,14 +1098,14 @@ L'identifiant de votre frontend HTTP (nombre)
#### Modifier les propriétés d'un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -933,14 +1147,14 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
#### Supprimer un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -958,14 +1172,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
#### Lister les routes HTTP attachées à un service Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -979,14 +1193,14 @@ L'identifiant d'un frontend HTTP (nombre)
#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1020,14 +1234,14 @@ La priorité de votre route. (nombre) [0 - 255]
#### Obtenir les détails d'une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1041,14 +1255,14 @@ L'identifiant de votre route (nombre)
#### Modifier les propriétés d'une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
**serviceName** ^*^
@@ -1107,14 +1321,14 @@ L'identifiant de votre route (nombre)
#### Lister les règles de routages attachées à une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1128,14 +1342,14 @@ L'identifiant de votre route HTTP (nombre)
#### Ajouter les règles de routages attachées à une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1169,14 +1383,14 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
#### Obtenir les détails d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1194,14 +1408,14 @@ L'identifiant de votre règle de routage HTTP (nombre)
#### Modifier les propriétés d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1236,14 +1450,14 @@ Le nom du sous-champ si applicable (chaîne de caractères)
#### Supprimer une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1267,14 +1481,14 @@ Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1288,14 +1502,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1356,14 +1570,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1377,14 +1591,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1415,14 +1629,14 @@ Le type de persistence de connexion (valeur)
#### Supprimer une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1438,14 +1652,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les serveurs liés à la ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1471,14 +1685,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1515,6 +1729,7 @@ Le type de sonde à utiliser (valeur)
**proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
**ssl** ^*^
@@ -1533,14 +1748,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1558,14 +1773,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1598,6 +1813,7 @@ Le type de sonde à utiliser (valeur)
- **proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur )
- **ssl**
@@ -1613,14 +1829,14 @@ Le poids de votre serveur pour votre ferme (nombre)
#### Supprimer un serveur d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1640,14 +1856,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1669,14 +1885,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1722,14 +1938,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1743,14 +1959,14 @@ L'identifiant de votre frontend TCP (nombre)
#### Modifier les propriétés d'un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1784,14 +2000,14 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
#### Supprimer un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1809,14 +2025,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1830,14 +2046,14 @@ L'identifiant d'un frontend TCP (nombre)
#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1868,14 +2084,14 @@ La priorité de votre route. (nombre) [0 - 255]
#### Obtenir les détails d'une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1889,14 +2105,14 @@ L'identifiant de votre route (nombre)
#### Modifier les propriétés d'une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
**serviceName** ^*^
@@ -1952,14 +2168,14 @@ L'identifiant de votre route (nombre)
#### Lister les règles de routages attachées à une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1973,14 +2189,14 @@ L'identifiant de votre route TCP (nombre)
#### Ajouter les règles de routages attachées à une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2014,14 +2230,14 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
#### Obtenir les détails d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2039,14 +2255,14 @@ L'identifiant de votre règle de routage HTTP (nombre)
#### Modifier les propriétés d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2081,14 +2297,14 @@ Le nom du sous-champ si applicable (chaîne de caractères)
#### Supprimer une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2112,14 +2328,14 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2133,14 +2349,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2162,14 +2378,14 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
#### Obtenir les détails d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2183,14 +2399,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2212,14 +2428,14 @@ Le port d'écoute de la ferme (nombre, 1..65000)
#### Supprimer une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2235,14 +2451,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les serveurs liés à la ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2264,14 +2480,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2301,14 +2517,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2326,14 +2542,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2362,14 +2578,14 @@ Si votre serveur est activé ou non (booléen)
#### Supprimer un serveur d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2389,14 +2605,14 @@ L'identifiant de votre ferme UDP (nombre)
#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2418,14 +2634,14 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2459,14 +2675,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2480,14 +2696,14 @@ L'identifiant de votre frontend UDP (nombre)
#### Modifier les propriétés d'un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2512,14 +2728,14 @@ Le nom de votre frontend UDP (chaîne de caractères)
#### Supprimer un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2537,14 +2753,14 @@ L'identifiant de votre frontend UDP (nombre)
#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2556,14 +2772,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2573,14 +2789,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2590,14 +2806,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Appliquer les modifications d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2609,14 +2825,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Lister les certificats SSL d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2638,14 +2854,14 @@ Type de certificat SSL (valeur)
#### Ajouter un nouvel objet SSL
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2667,14 +2883,14 @@ Ajout de la clé privée (chaîne de caractères)
#### Obtenir les détails d'un objet SSL
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
**serviceName** ^*^
@@ -2711,14 +2927,14 @@ L'identifiant de votre certificat SSL (nombre)
#### Lister les tâches en cours pour un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2732,14 +2948,14 @@ Consultation des tâches disponibles (valeurs)
#### Obtenir les détails d'une tâche
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2755,14 +2971,14 @@ L'identifiant de votre tâche (nombre)
#### Initier un changement de contact
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2791,14 +3007,14 @@ L'identifiant client OVHcloud à configurer pour le contact technique de ce serv
#### Description des réseaux privés attachés au load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2816,14 +3032,14 @@ Permet de filtrer selon le vlan utilisé
#### Ajouter un réseau privé dans le vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2853,14 +3069,14 @@ Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un v
#### Récupérer un réseau privé
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2874,14 +3090,14 @@ L'identifiant du réseau privé
#### Modifier un réseau privé
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
**serviceName** ^*^
@@ -2916,14 +3132,14 @@ L'identifiant du réseau privé
#### Modifier la liste des fermes attachées à un réseau privé
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2942,3 +3158,4 @@ Tableau d'identifiant de fermes que vous souhaitez attacher à ce réseau privé
## Aller plus loin
Échangez avec notre [communauté d'utilisateurs](/links/community).
+
diff --git a/pages/network/load_balancer/use_api_details/guide.fr-fr.md b/pages/network/load_balancer/use_api_details/guide.fr-fr.md
index 7f0f63875bc..c1b034bb454 100644
--- a/pages/network/load_balancer/use_api_details/guide.fr-fr.md
+++ b/pages/network/load_balancer/use_api_details/guide.fr-fr.md
@@ -4,18 +4,231 @@ excerpt: "Détails des fonctionnalités de l’API OVHcloud pour l’offre OVHcl
updated: 2025-09-29
---
-
@@ -46,7 +259,6 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
>
## Services et zones
-
### Load Balancer OVHcloud
#### Lister les services actifs
@@ -65,14 +277,14 @@ Toutes les fonctions d'API qui sont utilisées dans la section */ipLoadbalancing
#### Retourner les détails d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -82,14 +294,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Modifier un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -107,14 +319,14 @@ La configuration SSL que vous souhaitez attribuer au service (valeur)
#### Lister les services attachés au Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -124,14 +336,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les fermes existantes et leur type
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -145,14 +357,14 @@ Permet de filtrer selon le réseau vrack
#### Lister les zones pouvant être attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -162,14 +374,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différentes sondes pouvant être utilisées
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -179,14 +391,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de fermes pouvant être utilisées
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -196,14 +408,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de frontends pouvant être utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -213,14 +425,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types d'actions de routage pouvant etre utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -230,14 +442,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Lister les différents types de règles de routage pouvant être utilisés
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -249,14 +461,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Obtenir les informations du service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -266,14 +478,14 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
#### Modifier les informations du service
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -299,14 +511,14 @@ Renseigne la durée de renouvellement (chaîne de caractères)
#### Lister les zones actives pour un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -316,14 +528,14 @@ L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
#### Obtenir les détails d'une zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -339,14 +551,14 @@ Le nom de la zone demandée
Le service sera supprimé à la date d'expiration.
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -360,14 +572,14 @@ Le nom de la zone à supprimer
#### Annuler la suppression d'une zone
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -387,14 +599,14 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
#### Lister les fermes HTTP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -408,14 +620,14 @@ Le nom de la zone (chaîne de caractères)
#### Ajouter une nouvelle ferme HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -476,14 +688,14 @@ L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ign
#### Obtenir les détails d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -497,14 +709,14 @@ L'identifiant de votre ferme HTTP (nombre)
#### Modifier les propriétés d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -535,14 +747,14 @@ Le type de persistence de connexion (valeur)
#### Supprimer une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -558,14 +770,14 @@ L'identifiant de votre ferme HTTP (nombre)
#### Lister les serveurs liés à la ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -591,14 +803,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -639,6 +851,7 @@ Le type de sonde à utiliser (valeur)
**proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
**ssl** ^*^
@@ -657,14 +870,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -682,14 +895,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -725,6 +938,7 @@ Le type de sonde à utiliser (valeur)
- **proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
- **ssl**
@@ -740,14 +954,14 @@ Le poids de votre serveur pour votre ferme (nombre)
#### Supprimer un serveur d'une ferme HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -767,14 +981,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les frontends HTTP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -796,14 +1010,14 @@ Le nom de votre zone, par exemple: all (chaîne de caractères)
#### Ajouter un frontend HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -863,14 +1077,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
### Obtenir les détails d'un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -884,14 +1098,14 @@ L'identifiant de votre frontend HTTP (nombre)
#### Modifier les propriétés d'un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -933,14 +1147,14 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
#### Supprimer un frontend HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -958,14 +1172,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
#### Lister les routes HTTP attachées à un service Load Balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -979,14 +1193,14 @@ L'identifiant d'un frontend HTTP (nombre)
#### Ajouter une nouvelle route HTTP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1020,14 +1234,14 @@ La priorité de votre route. (nombre) [0 - 255]
#### Obtenir les détails d'une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1041,14 +1255,14 @@ L'identifiant de votre route (nombre)
#### Modifier les propriétés d'une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-
**serviceName** ^*^
@@ -1107,14 +1321,14 @@ L'identifiant de votre route (nombre)
#### Lister les règles de routages attachées à une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1128,14 +1342,14 @@ L'identifiant de votre route HTTP (nombre)
#### Ajouter les règles de routages attachées à une route HTTP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1169,14 +1383,14 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
#### Obtenir les détails d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1194,14 +1408,14 @@ L'identifiant de votre règle de routage HTTP (nombre)
#### Modifier les propriétés d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1236,14 +1450,14 @@ Le nom du sous-champ si applicable (chaîne de caractères)
#### Supprimer une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1267,14 +1481,14 @@ Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
#### Lister les fermes TCP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1288,14 +1502,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter une nouvelle ferme TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1356,14 +1570,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1377,14 +1591,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1415,14 +1629,14 @@ Le type de persistence de connexion (valeur)
#### Supprimer une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1438,14 +1652,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les serveurs liés à la ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1471,14 +1685,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1515,6 +1729,7 @@ Le type de sonde à utiliser (valeur)
**proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (valeur)
**ssl** ^*^
@@ -1533,14 +1748,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1558,14 +1773,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1598,6 +1813,7 @@ Le type de sonde à utiliser (valeur)
- **proxyProtocolVersion**
La version de proxyProtocol à utiliser,
+
voir http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt (Valeur )
- **ssl**
@@ -1613,14 +1829,14 @@ Le poids de votre serveur pour votre ferme (nombre)
#### Supprimer un serveur d'une ferme TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1640,14 +1856,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les frontends TCP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1669,14 +1885,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter un frontend TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1722,14 +1938,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1743,14 +1959,14 @@ L'identifiant de votre frontend TCP (nombre)
#### Modifier les propriétés d'un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1784,14 +2000,14 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
#### Supprimer un frontend TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1809,14 +2025,14 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
#### Lister les routes TCP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1830,14 +2046,14 @@ L'identifiant d'un frontend TCP (nombre)
#### Ajouter une nouvelle route TCP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1868,14 +2084,14 @@ La priorité de votre route. (nombre) [0 - 255]
#### Obtenir les détails d'une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1889,14 +2105,14 @@ L'identifiant de votre route (nombre)
#### Modifier les propriétés d'une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-
**serviceName** ^*^
@@ -1952,14 +2168,14 @@ L'identifiant de votre route (nombre)
#### Lister les règles de routages attachées à une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -1973,14 +2189,14 @@ L'identifiant de votre route TCP (nombre)
#### Ajouter les règles de routages attachées à une route TCP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2014,14 +2230,14 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
#### Obtenir les détails d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2039,14 +2255,14 @@ L'identifiant de votre règle de routage HTTP (nombre)
#### Modifier les propriétés d'une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2081,14 +2297,14 @@ Le nom du sous-champ si applicable (chaîne de caractères)
#### Supprimer une règle de routage
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2112,14 +2328,14 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
#### Lister les fermes UDP attachées à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2133,14 +2349,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Ajouter une nouvelle ferme UDP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2162,14 +2378,14 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
#### Obtenir les détails d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2183,14 +2399,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2212,14 +2428,14 @@ Le port d'écoute de la ferme (nombre, 1..65000)
#### Supprimer une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2235,14 +2451,14 @@ L'identifiant de votre ferme (nombre)
#### Lister les serveurs liés à la ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2264,14 +2480,14 @@ Filtrer les valeurs par statut du serveur (valeur)
#### Ajouter un serveur à une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2301,14 +2517,14 @@ Si votre serveur est activé ou non (booléen)
#### Obtenir les détails d'un serveur lié à une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2326,14 +2542,14 @@ L'identifiant de votre ferme (nombre)
#### Modifier les propriétés d'un serveur UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2362,14 +2578,14 @@ Si votre serveur est activé ou non (booléen)
#### Supprimer un serveur d'une ferme UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2389,14 +2605,14 @@ L'identifiant de votre ferme UDP (nombre)
#### Lister les frontends UDP attachés à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2418,14 +2634,14 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
#### Ajouter un frontend UDP à un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2459,14 +2675,14 @@ Le nom de votre zone, ex: all (chaîne de caractères)
#### Obtenir les détails d'un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2480,14 +2696,14 @@ L'identifiant de votre frontend UDP (nombre)
#### Modifier les propriétés d'un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2512,14 +2728,14 @@ Le nom de votre frontend UDP (chaîne de caractères)
#### Supprimer un frontend UDP
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2537,14 +2753,14 @@ L'identifiant de votre frontend UDP (nombre)
#### Lister les Additional IPs routées sur un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2556,14 +2772,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Obtenir l'état des instances d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2573,14 +2789,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Lister les IPs de sortie utilisées par OVHcloud pour le NAT
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2590,14 +2806,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Appliquer les modifications d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2609,14 +2825,14 @@ L'identifiant de votre Load Balancer, par exemple : "loadbalancer-abcdef01234567
#### Lister les certificats SSL d'un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2638,14 +2854,14 @@ Type de certificat SSL (valeur)
#### Ajouter un nouvel objet SSL
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2667,14 +2883,14 @@ Ajout de la clé privée (chaîne de caractères)
#### Obtenir les détails d'un objet SSL
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-
**serviceName** ^*^
@@ -2711,14 +2927,14 @@ L'identifiant de votre certificat SSL (nombre)
#### Lister les tâches en cours pour un service Load Balancer OVHcloud
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2732,14 +2948,14 @@ Consultation des tâches disponibles (valeurs)
#### Obtenir les détails d'une tâche
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2755,14 +2971,14 @@ L'identifiant de votre tâche (nombre)
#### Initier un changement de contact
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2791,14 +3007,14 @@ L'identifiant client OVHcloud à configurer pour le contact technique de ce serv
#### Description des réseaux privés attachés au load balancer
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2816,14 +3032,14 @@ Permet de filtrer selon le vlan utilisé
#### Ajouter un réseau privé dans le vRack
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2853,14 +3069,14 @@ Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un v
#### Récupérer un réseau privé
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
Paramètres:
+/// details |
+
+
Paramètres :
**serviceName** ^*^
@@ -2874,14 +3090,14 @@ L'identifiant du réseau privé
#### Modifier un réseau privé
-/// details |
-
> [!api]
>
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-
@@ -299,7 +302,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +327,7 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +344,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +365,7 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +382,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +399,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +416,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +433,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +450,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +469,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +486,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +519,7 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +536,7 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +559,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +580,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +607,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +628,7 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +696,7 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -714,7 +717,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -752,7 +755,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -775,7 +778,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -808,7 +811,7 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +878,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -900,7 +903,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -959,7 +962,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -986,7 +989,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1015,7 +1018,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1085,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1103,7 +1106,7 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1152,7 +1155,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1180,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1198,7 +1201,7 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1239,7 +1242,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1260,7 +1263,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1303,7 +1306,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1326,7 +1329,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1347,7 +1350,7 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1388,7 +1391,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1416,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1458,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1489,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1510,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1578,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1596,7 +1599,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1634,7 +1637,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1657,7 +1660,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1690,7 +1693,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1756,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1778,7 +1781,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1834,7 +1837,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1861,7 +1864,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1890,7 +1893,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1946,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1964,7 +1967,7 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2005,7 +2008,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2033,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2051,7 +2054,7 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2089,7 +2092,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2110,7 +2113,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2150,7 +2153,7 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2173,7 +2176,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2194,7 +2197,7 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2235,7 +2238,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2263,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2305,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2336,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2357,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2386,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -2404,7 +2407,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2456,7 +2459,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2485,7 +2488,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2525,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2547,7 +2550,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2583,7 +2586,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2610,7 +2613,7 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2639,7 +2642,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2683,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2701,7 +2704,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2733,7 +2736,7 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2758,7 +2761,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
Paramètres :
@@ -2777,7 +2780,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
Paramètres :
@@ -2794,7 +2797,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
Paramètres :
@@ -2811,7 +2814,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
Paramètres :
@@ -2830,7 +2833,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2859,7 +2862,7 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2888,7 +2891,7 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2909,7 +2912,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2932,7 +2935,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
Paramètres :
@@ -2953,7 +2956,7 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2976,7 +2979,7 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
Paramètres :
@@ -3007,7 +3010,7 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3032,7 +3035,7 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3069,7 +3072,7 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3090,7 +3093,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3111,7 +3114,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3132,7 +3135,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
@@ -299,7 +302,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +327,7 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +344,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +365,7 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +382,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +399,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +416,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +433,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +450,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +469,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +486,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +519,7 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +536,7 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +559,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +580,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +607,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +628,7 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +696,7 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -714,7 +717,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -752,7 +755,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -775,7 +778,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -808,7 +811,7 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +878,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -900,7 +903,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -959,7 +962,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -986,7 +989,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1015,7 +1018,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1085,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1103,7 +1106,7 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1152,7 +1155,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1180,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1198,7 +1201,7 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1239,7 +1242,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1260,7 +1263,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1303,7 +1306,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1326,7 +1329,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1347,7 +1350,7 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1388,7 +1391,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1416,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1458,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1489,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1510,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1578,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1596,7 +1599,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1634,7 +1637,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1657,7 +1660,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1690,7 +1693,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1756,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1778,7 +1781,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1834,7 +1837,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1861,7 +1864,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1890,7 +1893,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1946,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1964,7 +1967,7 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2005,7 +2008,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2033,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2051,7 +2054,7 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2089,7 +2092,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2110,7 +2113,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2150,7 +2153,7 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2173,7 +2176,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2194,7 +2197,7 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2235,7 +2238,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2263,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2305,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2336,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2357,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2386,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -2404,7 +2407,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2456,7 +2459,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2485,7 +2488,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2525,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2547,7 +2550,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2583,7 +2586,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2610,7 +2613,7 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2639,7 +2642,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2683,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2701,7 +2704,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2733,7 +2736,7 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2758,7 +2761,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
Paramètres :
@@ -2777,7 +2780,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
Paramètres :
@@ -2794,7 +2797,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
Paramètres :
@@ -2811,7 +2814,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
Paramètres :
@@ -2830,7 +2833,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2859,7 +2862,7 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2888,7 +2891,7 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2909,7 +2912,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2932,7 +2935,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
Paramètres :
@@ -2953,7 +2956,7 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2976,7 +2979,7 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
Paramètres :
@@ -3007,7 +3010,7 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3032,7 +3035,7 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3069,7 +3072,7 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3090,7 +3093,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3111,7 +3114,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3132,7 +3135,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
@@ -299,7 +302,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +327,7 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +344,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +365,7 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +382,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +399,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +416,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +433,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +450,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +469,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +486,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +519,7 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +536,7 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +559,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +580,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +607,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +628,7 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +696,7 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -714,7 +717,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -752,7 +755,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -775,7 +778,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -808,7 +811,7 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +878,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -900,7 +903,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -959,7 +962,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -986,7 +989,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1015,7 +1018,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1085,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1103,7 +1106,7 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1152,7 +1155,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1180,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1198,7 +1201,7 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1239,7 +1242,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1260,7 +1263,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1303,7 +1306,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1326,7 +1329,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1347,7 +1350,7 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1388,7 +1391,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1416,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1458,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1489,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1510,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1578,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1596,7 +1599,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1634,7 +1637,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1657,7 +1660,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1690,7 +1693,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1756,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1778,7 +1781,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1834,7 +1837,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1861,7 +1864,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1890,7 +1893,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1946,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1964,7 +1967,7 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2005,7 +2008,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2033,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2051,7 +2054,7 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2089,7 +2092,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2110,7 +2113,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2150,7 +2153,7 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2173,7 +2176,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2194,7 +2197,7 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2235,7 +2238,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2263,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2305,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2336,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2357,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2386,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -2404,7 +2407,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2456,7 +2459,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2485,7 +2488,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2525,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2547,7 +2550,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2583,7 +2586,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2610,7 +2613,7 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2639,7 +2642,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2683,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2701,7 +2704,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2733,7 +2736,7 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2758,7 +2761,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
Paramètres :
@@ -2777,7 +2780,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
Paramètres :
@@ -2794,7 +2797,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
Paramètres :
@@ -2811,7 +2814,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
Paramètres :
@@ -2830,7 +2833,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2859,7 +2862,7 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2888,7 +2891,7 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2909,7 +2912,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2932,7 +2935,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
Paramètres :
@@ -2953,7 +2956,7 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2976,7 +2979,7 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
Paramètres :
@@ -3007,7 +3010,7 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3032,7 +3035,7 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3069,7 +3072,7 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3090,7 +3093,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3111,7 +3114,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3132,7 +3135,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
**serviceName** ^*^
@@ -299,9 +302,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -324,9 +327,9 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -341,9 +344,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -362,9 +365,9 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -379,9 +382,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -396,9 +399,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -413,9 +416,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -430,9 +433,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -447,9 +450,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -466,9 +469,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -483,9 +486,9 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -516,9 +519,9 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -533,9 +536,9 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -556,9 +559,9 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -577,9 +580,9 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -604,9 +607,9 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -625,9 +628,9 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -693,9 +696,9 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -714,9 +717,9 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -752,9 +755,9 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -775,9 +778,9 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -808,9 +811,9 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -875,9 +878,9 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -900,9 +903,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -959,9 +962,9 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -986,9 +989,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1015,9 +1018,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1082,9 +1085,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1103,9 +1106,9 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1152,9 +1155,9 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1177,9 +1180,9 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1198,9 +1201,9 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1239,9 +1242,9 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1260,9 +1263,9 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1303,9 +1306,9 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1326,9 +1329,9 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1347,9 +1350,9 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1388,9 +1391,9 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1413,9 +1416,9 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1455,9 +1458,9 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1486,9 +1489,9 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1507,9 +1510,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1575,9 +1578,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1596,9 +1599,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1634,9 +1637,9 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1657,9 +1660,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1690,9 +1693,9 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1753,9 +1756,9 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1778,9 +1781,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1834,9 +1837,9 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1861,9 +1864,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1890,9 +1893,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1943,9 +1946,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -1964,9 +1967,9 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2005,9 +2008,9 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2030,9 +2033,9 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2051,9 +2054,9 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2089,9 +2092,9 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2110,9 +2113,9 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2150,9 +2153,9 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2173,9 +2176,9 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2194,9 +2197,9 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2235,9 +2238,9 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2260,9 +2263,9 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2302,9 +2305,9 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2333,9 +2336,9 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2354,9 +2357,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2383,9 +2386,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2404,9 +2407,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
-
**serviceName** ^*^
@@ -2456,9 +2459,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2485,9 +2488,9 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2522,9 +2525,9 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2547,9 +2550,9 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2583,9 +2586,9 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2610,9 +2613,9 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2639,9 +2642,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2680,9 +2683,9 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2701,9 +2704,9 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2733,9 +2736,9 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2758,9 +2761,9 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2777,9 +2780,9 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2794,9 +2797,9 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2811,9 +2814,9 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2830,9 +2833,9 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2859,9 +2862,9 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2888,9 +2891,9 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2909,9 +2912,9 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2932,9 +2935,9 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2953,9 +2956,9 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -2976,9 +2979,9 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3007,9 +3010,9 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3032,9 +3035,9 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3069,9 +3072,9 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3090,9 +3093,9 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3111,9 +3114,9 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
-
Parameters:
+
Paramètres :
**serviceName** ^*^
@@ -3132,9 +3135,9 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
-
@@ -299,7 +302,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +327,7 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +344,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +365,7 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +382,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +399,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +416,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +433,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +450,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +469,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +486,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +519,7 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +536,7 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +559,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +580,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +607,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +628,7 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +696,7 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -714,7 +717,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -752,7 +755,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -775,7 +778,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -808,7 +811,7 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +878,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -900,7 +903,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -959,7 +962,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -986,7 +989,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1015,7 +1018,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1085,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1103,7 +1106,7 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1152,7 +1155,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1180,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1198,7 +1201,7 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1239,7 +1242,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1260,7 +1263,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1303,7 +1306,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1326,7 +1329,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1347,7 +1350,7 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1388,7 +1391,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1416,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1458,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1489,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1510,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1578,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1596,7 +1599,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1634,7 +1637,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1657,7 +1660,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1690,7 +1693,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1756,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1778,7 +1781,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1834,7 +1837,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1861,7 +1864,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1890,7 +1893,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1946,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1964,7 +1967,7 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2005,7 +2008,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2033,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2051,7 +2054,7 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2089,7 +2092,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2110,7 +2113,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2150,7 +2153,7 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2173,7 +2176,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2194,7 +2197,7 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2235,7 +2238,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2263,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2305,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2336,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2357,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2386,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -2404,7 +2407,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2456,7 +2459,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2485,7 +2488,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2525,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2547,7 +2550,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2583,7 +2586,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2610,7 +2613,7 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2639,7 +2642,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2683,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2701,7 +2704,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2733,7 +2736,7 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2758,7 +2761,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
Paramètres :
@@ -2777,7 +2780,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
Paramètres :
@@ -2794,7 +2797,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
Paramètres :
@@ -2811,7 +2814,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
Paramètres :
@@ -2830,7 +2833,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2859,7 +2862,7 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2888,7 +2891,7 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2909,7 +2912,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2932,7 +2935,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
Paramètres :
@@ -2953,7 +2956,7 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2976,7 +2979,7 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
Paramètres :
@@ -3007,7 +3010,7 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3032,7 +3035,7 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3069,7 +3072,7 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3090,7 +3093,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3111,7 +3114,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3132,7 +3135,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
@@ -299,7 +302,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +327,7 @@ The SSL configuration you want to assign to the service (Value)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +344,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +365,7 @@ Allows filtering according to the vrack network
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +382,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +399,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +416,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +433,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +450,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +469,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +486,7 @@ The identifier of your Load Balancer, ex: IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +519,7 @@ Fill in the renewal term (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +536,7 @@ The identifier of your Load Balancer, ex. : IP-1.2.3.4 (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +559,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +580,7 @@ The service will be discontinued on the expiry date.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +607,7 @@ Accessing HTTP protocol related elements (Frontend, Firmware, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +628,7 @@ The name of the zone (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +696,7 @@ The address to be used by the probe for HTTP type probes. The type is ignored if
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -714,7 +717,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -752,7 +755,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -775,7 +778,7 @@ The identifier of your HTTP farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -808,7 +811,7 @@ Filter Values by server status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +878,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -900,7 +903,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -959,7 +962,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -986,7 +989,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1015,7 +1018,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1085,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1103,7 +1106,7 @@ The identifier of your HTTP frontend (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1152,7 +1155,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1180,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1198,7 +1201,7 @@ The identifier of an HTTP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
Paramètres :
@@ -1239,7 +1242,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1260,7 +1263,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1303,7 +1306,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -1326,7 +1329,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1347,7 +1350,7 @@ The identifier of your HTTP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -1388,7 +1391,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1416,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1458,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1489,7 @@ Access the elements related to the TCP protocol (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1510,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1578,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1596,7 +1599,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1634,7 +1637,7 @@ The type of connection persistence (Value)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -1657,7 +1660,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1690,7 +1693,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1756,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1778,7 +1781,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1834,7 +1837,7 @@ The weight of your server for your farm (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -1861,7 +1864,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1890,7 +1893,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1946,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1964,7 +1967,7 @@ The identifier of your frontend TCP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2005,7 +2008,7 @@ Whether requests sent to the HTTP farm should be encrypted with SSL or not (Bool
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2033,7 @@ Routes are evaluated one by one, testing their routing rules. The first route va
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2051,7 +2054,7 @@ The identifier of a TCP frontend (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
Paramètres :
@@ -2089,7 +2092,7 @@ The priority of your route. (Number) [0 - 255]
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2110,7 +2113,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2150,7 +2153,7 @@ The priority of your route (Number) [0 - 255]
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}
>
-/// details |
+/// details |
Paramètres :
@@ -2173,7 +2176,7 @@ The identifier of your route (number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2194,7 +2197,7 @@ The identifier of your TCP route (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule
>
-/// details |
+/// details |
Paramètres :
@@ -2235,7 +2238,7 @@ The name of the sub-field, if applicable. Can be a cookie or a header name, for
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2263,7 @@ The identifier of your HTTP routing rule (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2305,7 @@ The name of the sub-field if applicable (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2336,7 @@ Access the UDP protocol elements (Frontend, Farm, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2357,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2386,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
Paramètres :
@@ -2404,7 +2407,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2456,7 +2459,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2485,7 +2488,7 @@ Filter Values by Server Status (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2525,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2547,7 +2550,7 @@ The identifier of your farm (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2583,7 +2586,7 @@ If your server is activated or not (Boolean)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
Paramètres :
@@ -2610,7 +2613,7 @@ The identifier of your farm UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2639,7 +2642,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2683,7 @@ The name of your zone, ex: all (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2701,7 +2704,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2733,7 +2736,7 @@ The name of your UDP frontend (String of characters)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2758,7 +2761,7 @@ The identifier of your frontend UDP (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/failover
>
-/// details |
+/// details |
Paramètres :
@@ -2777,7 +2780,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/instancesState
>
-/// details |
+/// details |
Paramètres :
@@ -2794,7 +2797,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/natIp
>
-/// details |
+/// details |
Paramètres :
@@ -2811,7 +2814,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/refresh
>
-/// details |
+/// details |
Paramètres :
@@ -2830,7 +2833,7 @@ The identifier of your Load Balancer, for example : "loadbalancer-abcdef01234567
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2859,7 +2862,7 @@ Type of SSL certificate (Value)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/ssl
>
-/// details |
+/// details |
Paramètres :
@@ -2888,7 +2891,7 @@ Adding the private key (String of characters)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2909,7 +2912,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/ssl/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2932,7 +2935,7 @@ The identifier of your SSL certificate (Number)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task
>
-/// details |
+/// details |
Paramètres :
@@ -2953,7 +2956,7 @@ Consultation of available tasks (Values)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/task/{id}
>
-/// details |
+/// details |
Paramètres :
@@ -2976,7 +2979,7 @@ The identifier of your task (Number)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/changeContact
>
-/// details |
+/// details |
Paramètres :
@@ -3007,7 +3010,7 @@ The OVH NIC to be configured for the Admin contact of this service (String of ch
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3032,7 +3035,7 @@ Allows to filter according to the vlan used
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3069,7 +3072,7 @@ Vlan of the private network in the vRack. 0 if the private network is not in a v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3090,7 +3093,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3111,7 +3114,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
Paramètres :
@@ -3132,7 +3135,7 @@ The identifier of the private network
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}/updateFarmId
>
-/// details |
+/// details |
@@ -299,7 +304,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +329,7 @@ La configuration SSL que vous souhaitez attribuer au service (valeur)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +346,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +367,7 @@ Permet de filtrer selon le réseau vrack
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +384,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +401,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +418,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +435,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +452,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +471,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +488,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +521,7 @@ Renseigne la durée de renouvellement (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +538,7 @@ L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +561,7 @@ Le service sera supprimé à la date d'expiration.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +582,7 @@ Le nom de la zone à supprimer
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +609,7 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +630,7 @@ Le nom de la zone (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +698,7 @@ L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ign
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
@@ -808,7 +813,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +880,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -1015,7 +1020,7 @@ Le nom de votre zone, par exemple: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1087,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -1152,7 +1157,7 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1182,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
@@ -1388,7 +1393,7 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1418,7 @@ L'identifiant de votre règle de routage HTTP (nombre)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1460,7 @@ Le nom du sous-champ si applicable (chaîne de caractères)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1491,7 @@ Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1512,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1580,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
@@ -1690,7 +1695,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1758,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -1890,7 +1895,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1948,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -2005,7 +2010,7 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2035,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
@@ -2235,7 +2240,7 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2265,7 @@ L'identifiant de votre règle de routage HTTP (nombre)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2307,7 @@ Le nom du sous-champ si applicable (chaîne de caractères)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2338,7 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2359,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2388,7 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2485,7 +2490,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2527,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -2639,7 +2644,7 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2685,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -3012,7 +3017,7 @@ L'identifiant client OVHcloud à configurer pour le contact technique de ce serv
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3037,7 +3042,7 @@ Permet de filtrer selon le vlan utilisé
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3074,7 +3079,7 @@ Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |
@@ -299,7 +303,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}
>
-/// details |
+/// details |
Paramètres :
@@ -324,7 +328,7 @@ La configuration SSL que vous souhaitez attribuer au service (valeur)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/allowedServers
>
-/// details |
+/// details |
Paramètres :
@@ -341,7 +345,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/definedFarms
>
-/// details |
+/// details |
Paramètres :
@@ -362,7 +366,7 @@ Permet de filtrer selon le réseau vrack
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableServerZones
>
-/// details |
+/// details |
Paramètres :
@@ -379,7 +383,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmProbes
>
-/// details |
+/// details |
Paramètres :
@@ -396,7 +400,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFarmType
>
-/// details |
+/// details |
Paramètres :
@@ -413,7 +417,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableFrontendType
>
-/// details |
+/// details |
Paramètres :
@@ -430,7 +434,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteActions
>
-/// details |
+/// details |
Paramètres :
@@ -447,7 +451,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/availableRouteRules
>
-/// details |
+/// details |
Paramètres :
@@ -466,7 +470,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -483,7 +487,7 @@ L'identifiant de votre Load Balancer, ex: IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/serviceInfos
>
-/// details |
+/// details |
Paramètres :
@@ -516,7 +520,7 @@ Renseigne la durée de renouvellement (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone
>
-/// details |
+/// details |
Paramètres :
@@ -533,7 +537,7 @@ L'identifiant de votre Load Balancer, ex. : IP-1.2.3.4 (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/zone/{name}
>
-/// details |
+/// details |
Paramètres :
@@ -556,7 +560,7 @@ Le service sera supprimé à la date d'expiration.
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/terminate
>
-/// details |
+/// details |
Paramètres :
@@ -577,7 +581,7 @@ Le nom de la zone à supprimer
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/zone/{name}/cancelTermination
>
-/// details |
+/// details |
Paramètres :
@@ -604,7 +608,7 @@ Accéder aux éléments relatifs au protocole HTTP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -625,7 +629,7 @@ Le nom de la zone (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm
>
-/// details |
+/// details |
Paramètres :
@@ -693,7 +697,7 @@ L'adresse à utiliser par la sonde pour les sondes de type HTTP. Le type est ign
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}
>
-/// details |
+/// details |
@@ -808,7 +812,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -875,7 +879,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -1015,7 +1019,7 @@ Le nom de votre zone, par exemple: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/http/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1082,7 +1086,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -1152,7 +1156,7 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -1177,7 +1181,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route
>
-/// details |
+/// details |
@@ -1388,7 +1392,7 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1413,7 +1417,7 @@ L'identifiant de votre règle de routage HTTP (nombre)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1455,7 +1459,7 @@ Le nom du sous-champ si applicable (chaîne de caractères)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/http/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -1486,7 +1490,7 @@ Accéder aux éléments relatifs au protocole TCP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1507,7 +1511,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -1575,7 +1579,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}
>
-/// details |
+/// details |
@@ -1690,7 +1694,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -1753,7 +1757,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -1890,7 +1894,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/tcp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -1943,7 +1947,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -2005,7 +2009,7 @@ Si les requêtes envoyées à la ferme HTTP doivent être chiffrées avec SSL ou
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}
>
-/// details |
+/// details |
Paramètres :
@@ -2030,7 +2034,7 @@ Les routes sont évaluées une par une, en testant leurs règles de routage. La
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route
>
-/// details |
+/// details |
@@ -2235,7 +2239,7 @@ Le nom du sous-champ, si applicable. Peut être un cookie ou un nom d'en-tête,
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2260,7 +2264,7 @@ L'identifiant de votre règle de routage HTTP (nombre)
> @api {v1} /ipLoadbalancing PUT /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2302,7 +2306,7 @@ Le nom du sous-champ si applicable (chaîne de caractères)
> @api {v1} /ipLoadbalancing DELETE /ipLoadbalancing/{serviceName}/tcp/route/{routeId}/rule/{ruleId}
>
-/// details |
+/// details |
Paramètres :
@@ -2333,7 +2337,7 @@ Accéder aux éléments relatifs au protocole UDP (frontend, ferme, etc.).
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2354,7 +2358,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm
>
-/// details |
+/// details |
Paramètres :
@@ -2383,7 +2387,7 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}
>
-/// details |
+/// details |
@@ -2485,7 +2489,7 @@ Filtrer les valeurs par statut du serveur (valeur)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server
>
-/// details |
+/// details |
Paramètres :
@@ -2522,7 +2526,7 @@ Si votre serveur est activé ou non (booléen)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}
>
-/// details |
+/// details |
@@ -2639,7 +2643,7 @@ Le nom de votre zone, par exemple : all (chaîne de caractères)
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/udp/frontend
>
-/// details |
+/// details |
Paramètres :
@@ -2680,7 +2684,7 @@ Le nom de votre zone, ex: all (chaîne de caractères)
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}
>
-/// details |
+/// details |
@@ -3012,7 +3016,7 @@ L'identifiant client OVHcloud à configurer pour le contact technique de ce serv
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3037,7 +3041,7 @@ Permet de filtrer selon le vlan utilisé
> @api {v1} /ipLoadbalancing POST /ipLoadbalancing/{serviceName}/vrack/network
>
-/// details |
+/// details |
Paramètres :
@@ -3074,7 +3078,7 @@ Vlan du réseau privé dans le vRack. 0 si le réseau privé n'est pas dans un v
> @api {v1} /ipLoadbalancing GET /ipLoadbalancing/{serviceName}/vrack/network/{vrackNetworkId}
>
-/// details |
+/// details |