Skip to main content

OVHcloud Load Balancer API Quick Reference

Stephanie R.
Updated

Learn about the main API functions for the OVHcloud Load Balancer.

 

List of API functions

For a complete reference to the API functions of the OVHcloud Load Balancer service, click here.

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

NOTE: Each category that falls under Front-end, Server cluster (Farm), and Server management consists of two API functions, one for each protocol (HTTP and TCP). You must execute the API function that corresponds to the specific protocol of the desired service.

 

Front-end

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}

 

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

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}

 

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

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