---
title: "OVHcloud Load Balancer API Quick Reference"
description: "For a complete reference to the API functions of the OVHcloud Load Balancer service, click here."
url: https://docs.us.ovhcloud.com/en/network/load-balancer/ovhcloud-api-quick-reference
lang: en
---
> For AI agents: the complete documentation index is available at https://docs.us.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.us.ovhcloud.com/en/llms-full.txt.

# OVHcloud Load Balancer API Quick Reference

## List of API functions

For a complete reference to the API functions of the OVHcloud Load Balancer service, click [here](https://docs.us.ovhcloud.com/en/network/load-balancer/use-api-details.md).

**Note:**

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).

**Warning:**

**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](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/frontend)

[GET /ipLoadbalancing/{serviceName}/tcp/frontend](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/frontend)

 

### Create a front-end

[POST /ipLoadbalancing/{serviceName}/http/frontend](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/http/frontend)

[POST /ipLoadbalancing/{serviceName}/tcp/frontend](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/tcp/frontend)

 

### Return the parameters applied to a front-end

[GET /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/frontend/-frontendId-)

[GET /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/frontend/-frontendId-)

 

### Edit parameters related to a particular front-end

[PUT /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/http/frontend/-frontendId-)

[PUT /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/tcp/frontend/-frontendId-)

 

### Delete a front-end

[DELETE /ipLoadbalancing/{serviceName}/http/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/http/frontend/-frontendId-)

[DELETE /ipLoadbalancing/{serviceName}/tcp/frontend/{frontendId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/tcp/frontend/-frontendId-)

 

## Server cluster

### Return the list of IDs of existing server clusters

[GET /ipLoadbalancing/{serviceName}/http/farm](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/farm)

[GET /ipLoadbalancing/{serviceName}/tcp/farm](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/farm)

 

### Create a server cluster

[POST /ipLoadbalancing/{serviceName}/http/farm](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/http/farm)

[POST /ipLoadbalancing/{serviceName}/tcp/farm](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/tcp/farm)

 

### Return the parameters applied to a server cluster

[GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/farm/-farmId-)

[GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-)

 

### Edit parameters related to a particular server cluster

[PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/http/farm/-farmId-)

[PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-)

 

### Delete a server cluster

[DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/http/farm/-farmId-)

[DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#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](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/farm/-farmId-/server)

[GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-/server)

 

### Creates a server for a particular server cluster

[POST /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/http/farm/-farmId-/server)

[POST /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-/server)

 

### Return the parameters of a particular server

[GET /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/http/farm/-farmId-/server/-serverId-)

[GET /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-/server/-serverId-)

 

### Edit settings for a particular server

[PUT /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/http/farm/-farmId-/server/-serverId-)

[PUT /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#put-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-/server/-serverId-)

 

### Delete a server

[DELETE /ipLoadbalancing/{serviceName}/http/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/http/farm/-farmId-/server/-serverId-)

[DELETE /ipLoadbalancing/{serviceName}/tcp/farm/{farmId}/server/{serverId}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/tcp/farm/-farmId-/server/-serverId-)

 

## SSL certificates

### Return the list of SSL certificates

[GET /ipLoadbalancing/{serviceName}/ssl](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/ssl)

 

### Create an SSL certificate

[POST /ipLoadbalancing/{serviceName}/ssl](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/ssl)

 

### Return the settings for a particular SSL Certificate

[GET /ipLoadbalancing/{serviceName}/ssl/{id}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/ssl/-id-)

 

### Delete an SSL certificate

[DELETE /ipLoadbalancing/{serviceName}/ssl/{id}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#delete-/ipLoadbalancing/-serviceName-/ssl/-id-)

 

## Tasks

### Applies the changes to the Load Balancer configuration

[POST /ipLoadbalancing/{serviceName}/refresh](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#post-/ipLoadbalancing/-serviceName-/refresh)

 

### Return the list of task IDs

[GET /ipLoadbalancing/{serviceName}/task](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/task)

 

### Return the status of a particular task

[GET /ipLoadbalancing/{serviceName}/task/{id}](https://api.us.ovhcloud.com/console/?section=/ipLoadbalancing&branch=v1#get-/ipLoadbalancing/-serviceName-/task/-id-)

 

## Go further

Browse all the [Load Balancer guides](https://docs.us.ovhcloud.com/en/network/load-balancer/landing-page-load-balancer.md).

Browse the rest of the [OVHcloud US documentation](https://docs.us.ovhcloud.com/en/index.md) for guides on our other products and services.

Learn more about [Load Balancer](https://us.ovhcloud.com/network/load-balancer/) on the OVHcloud US website.