1. Articles
  2. Network
  3. Load Balancer
  4. Getting Started

Articles in this section

OVHcloud Load Balancer API Quick Reference

Avatar
Stephanie R.
  • Updated

List of API functions

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

NOTE: Attention, for compatibility reasons the entry point of the old OVHcloud 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 OVHcloud Load Balancer service, click here.

The Front-end, Server cluster, and Server are specific to the protocol (HTTP and TCP) 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 Front-end TCP with an HTTP Server cluster. But it is possible (in the absence of other limitations) to use an HTTP Front-end with an HTTP Server cluster.

 

Front-end

As you can see, each category consists of three 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 front-ends

GET /ipLoadbalancing/{serviceName}/http/frontend

GET /ipLoadbalancing/{serviceName}/tcp/frontend

 

Create a front-end

POST /ipLoadbalancing/{serviceName}/http/frontend

POST /ipLoadbalancing/{serviceName}/tcp/frontend

 

Return the parameters applied to a front-end

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

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

 

Edit parameters related to a particular front-end

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

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

 

Delete a front-end

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

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

 

Server cluster

As for the front-end, each category comprises three 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 server clusters

GET /ipLoadbalancing/{serviceName}/http/farm

GET /ipLoadbalancing/{serviceName}/tcp/farm

 

Create a server cluster

POST /ipLoadbalancing/{serviceName}/http/farm

POST /ipLoadbalancing/{serviceName}/tcp/farm

 

Return the parameters applied to a server cluster

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

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

 

Edit parameters related to a particular server cluster

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

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

 

Delete a server cluster

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

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

 

Server

As for the front-end and server cluster, each category comprises three 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 server cluster

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

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

 

Creates a server for a particular server cluster

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

POST /ipLoadbalancing/{serviceName}/tcp/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}

 

Edit settings for a particular server

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

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

 

Delete a server

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

DELETE /ipLoadbalancing/{serviceName}/tcp/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}

 

Go further

For more information and tutorials, please see our other OVHcloud Load Balancer guides or explore the guides for other OVHcloud products and services.

Related articles