Load Balancer API Quick Reference
Quick description of the different API functions used to manage the Load Balancer
List of API functions
This section briefly describes the main functions of the API for the OVH Load Balancer under /ipLoadbalancing
Attention, for compatibility reasons the entry point of the old OVH Load Balancer system is still present in the /ip/loadBalancing API, not to be confused with the new /ipLoadbalancing.
For a complete reference to the API functions of the OVH Load Balancer service, it's here
The Frontend, Farm and Server are specific to the protocol (among HTTP, TCP or UDP) in which they are defined. Although they can be "combined" with each other, this is only possible within the same protocol. of the same protocol. Thus, it is not possible to use a Frontend UDP with an HTTP Farm. But it is possible (in the absence of other limitation) to use an HTTP Frontend with an HTTP Farm.
Frontend
As you can see, each category consists of 3 API functions. It is necessary to properly execute the API function that corresponds to the type of service you want.
Return the list of IDs of existing frontends
Create a frontend
Return the parameters applied to a frontend
Edit parameters related to a particular frontend
Delete a frontend
Server farm
As for the frontend, each category is composed of 3 API functions. It is necessary to execute the API function that corresponds to the type of service desired.
Return the list of IDs of existing farms
Create a Farm
Return the parameters applied to a farm
Edit parameters related to a particular farm
Delete a Farm
Server
As for the frontend and farm, each category is composed of 3 API functions. It is necessary to properly execute the API function that corresponds to the type of the desired service.
Return the list of server IDs linked to a particular farm
Creates a server for a particular farm
Return the parameters of a particular server
Edit settings for a particular server
Delete a server
SSL certificats
Return the list of SSL certificates
Create an SSL certificate
Return the settings for a particular SSL Certificate
Delete a SSL certificate
Tasks
Applies the changes to the Load Balancer configuration
Return the list of task IDs
Return the status of a particular task
Did you find this guide useful?
Please feel free to give any suggestions in order to improve this documentation.
Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.
Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.
Thank you. Your feedback has been received.