---
title: "Load Balancer API Quick Reference"
url: https://docs.ovhcloud.com/es/guides/network/load-balancer/use-api-reference
lang: es
lastUpdated: 2025-09-26
---
# Load Balancer API Quick Reference

## 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](/es/guides/network/load-balancer/use-api-details.md).

:::info
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.
:::

:::warning
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


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Create a frontend


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Return the parameters applied to a frontend


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Edit parameters related to a particular frontend


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Delete a frontend


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

## Server farm

### Return the list of IDs of existing farms


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Create a Farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Return the parameters applied to a farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Edit parameters related to a particular farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Delete a Farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

## Server

### Return the list of server IDs linked to a particular farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Creates a server for a particular farm


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Return the parameters of a particular server


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Edit settings for a particular server


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

### Delete a server


🇪🇺EU▾

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


🇪🇺EU▾

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


🇪🇺EU▾

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

## SSL certificates

### Return the list of SSL certificates


🇪🇺EU▾

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

### Create an SSL certificate


🇪🇺EU▾

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

### Return the settings for a particular SSL Certificate


🇪🇺EU▾

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

### Delete an SSL certificate


🇪🇺EU▾

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

## Tasks

### Applies the changes to the Load Balancer configuration


🇪🇺EU▾

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

### Return the list of task IDs


🇪🇺EU▾

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

### Return the status of a particular task


🇪🇺EU▾

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