Load Balancer API Quick Reference

Knowledge Base

KB0044235

Load Balancer API Quick Reference


Icons/System/eye-open Created with Sketch. 247 Views 29.09.2025 Cloud / OVHcloud Load Balancer

List of API functions

This section briefly describes the main functions of the API for the OVHcloud Load Balancer under /ipLoadbalancing.

For a comprehensive reference to the API functions of the OVHcloud Load Balancer service, please consult this detailed guide.

The Frontends, Farms and Servers are specific to the protocol (HTTP, TCP or UDP) in which they are defined. Compatibility between these components is only possible within the same protocol. For example, an HTTP Frontend can only be paired with an HTTP Farm, and cannot be used with a UDP Farm.

Each category that falls under Frontend, Farm and Server management consists of 3 API functions, one for each protocol (HTTP, TCP or UDP). You must execute the API function that corresponds to the specific protocol of the desired service.

Frontend

Return the list of IDs of existing frontends

GET /ipLoadbalancing/{serviceName}/http/frontend

GET /ipLoadbalancing/{serviceName}/tcp/frontend

GET /ipLoadbalancing/{serviceName}/udp/frontend

Create a frontend

POST /ipLoadbalancing/{serviceName}/http/frontend

POST /ipLoadbalancing/{serviceName}/tcp/frontend

POST /ipLoadbalancing/{serviceName}/udp/frontend

Return the parameters applied to a frontend

GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}

GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}

GET /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}

PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}

PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}

PUT /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}

Delete a frontend

DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}

DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frntendId}

DELETE /ipLoadbalancing/{serviceName}/udp/frontend/{frontendId}

Server farm

Return the list of IDs of existing farms

GET /ipLoadbalancing/{serviceName}/http/farm

GET /ipLoadbalancing/{serviceName}/tcp/farm

GET /ipLoadbalancing/{serviceName}/udp/farm

Create a Farm

POST /ipLoadbalancing/{serviceName}/http/farm

POST /ipLoadbalancing/{serviceName}/tcp/farm

POST /ipLoadbalancing/{serviceName}/udp/farm

Return the parameters applied to a farm

GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}

GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}

GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}

PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}

PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}

PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}

Delete a Farm

DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}

DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}

DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}

Server

Return the list of server IDs linked to a particular farm

GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server

GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server

GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server

Creates a server for a particular farm

POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server

POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server

POST /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server

Return the parameters of a particular server

GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}

GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}

GET /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}

Edit settings for a particular server

PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}

PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}

PUT /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}

Delete a server

DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}

DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}

DELETE /ipLoadbalancing/{serviceName}/udp/farm/{farmId}/server/{serverId}

SSL certificates

Return the list of SSL certificates

GET /ipLoadbalancing/{serviceName}/ssl

Create an SSL certificate

POST /ipLoadbalancing/{serviceName}/ssl

Return the settings for a particular SSL Certificate

GET /ipLoadbalancing/{serviceName}/ssl/{id}

Delete an SSL certificate

DELETE /ipLoadbalancing/{serviceName}/ssl/{id}

Tasks

Applies the changes to the Load Balancer configuration

POST /ipLoadbalancing/{serviceName}/refresh

Return the list of task IDs

GET /ipLoadbalancing/{serviceName}/task

Return the status of a particular task

GET /ipLoadbalancing/{serviceName}/task/{id}

Related articles