Policy > Networking > Network Services > Load Balancing

Associated URIs:

API Description API Path

List LBAppProfiles


Paginated list of all LBAppProfiles.
GET /policy/api/v1/infra/lb-app-profiles

Delete LBAppProfile and all the entities contained by this LBAppProfile


Delete the LBAppProfile along with all the entities contained
by this LBAppProfile.
DELETE /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Read LBAppProfile


Read a LBAppProfile.
GET /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Create or update a LBAppProfile


If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
PATCH /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

Create or update a LBAppProfile


If a LBAppProfile with the lb-app-profile-id is not already present, create
a new LBAppProfile. If it already exists, update the LBAppProfile. This
is a full replace.
PUT /policy/api/v1/infra/lb-app-profiles/<lb-app-profile-id>

List LBClientSslProfiles


Paginated list of all LBClientSslProfiles.
GET /policy/api/v1/infra/lb-client-ssl-profiles

Delete LBClientSslProfile and all the entities contained by this LBClientSslProfile


Delete the LBClientSslProfile along with all the entities contained
by this LBClientSslProfile.
DELETE /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Read LBClientSslProfile


Read a LBClientSslProfile.
GET /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Create or update a LBClientSslProfile


If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

Create or update a LBClientSslProfile


If a LBClientSslProfile with the lb-client-ssl-profile-id is not already
present, create a new LBClientSslProfile. If it already exists, update the
LBClientSslProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-client-ssl-profiles/<lb-client-ssl-profile-id>

List LBMonitorProfiles for infra


Paginated list of all LBMonitorProfiles for infra.
GET /policy/api/v1/infra/lb-monitor-profiles

Delete LBMonitorProfile and all the entities contained by this LBMonitorProfile


Delete the LBMonitorProfile along with all the entities contained
by this LBMonitorProfile.
DELETE /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Read LBMonitorProfile


Read a LBMonitorProfile.
GET /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Create or update a LBMonitorProfile


If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Create or update a LBMonitorProfile


If a LBMonitorProfile with the lb-monitor-profile-id is not
already present, create a new LBMonitorProfile. If it already exists,
update the LBMonitorProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-monitor-profiles/<lb-monitor-profile-id>

Read load balancer usage for the given node


API is used to retrieve node usage for load balancer which contains basic
information, LB entity usages and capacities for the given node.
Currently only edge node is supported.
The parameter ?node_path= is required. For example, ?node_path=
/infra/sites/default/enforcement-points/default/edge-clusters/
85175e0b-4d74-461d-83e1-f3b785adef9c/edge-nodes/
86e077c0-449f-11e9-87c8-02004eb37029.
GET /policy/api/v1/infra/lb-node-usage

Read load balancer node usage summary


The API is used to retrieve the load balancer node usage summary of all
nodes for every enforcement point.
- If the parameter ?include_usages=true exists, the property node_usages
are included in response. By default, the property node_usages is not
included in response.
- If parameter ?enforcement_point_path= exists,
only node usage summary from specific enforcement point is included
in response. If no enforcement point path is specified, information will
be aggregated from each enforcement point.
GET /policy/api/v1/infra/lb-node-usage-summary

List LBPersistenceProfiles for infra


Paginated list of all LBPersistenceProfiles for infra.
GET /policy/api/v1/infra/lb-persistence-profiles

Delete LBPersistenceProfile and all the entities contained by this LBPersistenceProfile


Delete the LBPersistenceProfile along with all the entities
contained by this LBPersistenceProfile.
DELETE /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Read LBPersistenceProfile


Read a LBPersistenceProfile.
GET /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

Create or update a LBPersistenceProfile


If a LBPersistenceProfile with the lb-persistence-profile-id is not
already present, create a new LBPersistenceProfile. If it already exists,
update the LBPersistenceProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-persistence-profiles/<lb-persistence-profile-id>

List LBPools


Paginated list of all LBPools.
GET /policy/api/v1/infra/lb-pools

Delete LBPool and all the entities contained by this LBPool


Delete the LBPool along with all the entities contained
by this LBPool.
DELETE /policy/api/v1/infra/lb-pools/<lb-pool-id>

Read LBPool


Read a LBPool.
GET /policy/api/v1/infra/lb-pools/<lb-pool-id>

Create or update a LBPool


If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
PATCH /policy/api/v1/infra/lb-pools/<lb-pool-id>

Create or update a LBPool


If a LBPool with the lb-pool-id is not already present,
create a new LBPool. If it already exists, update the
LBPool. This is a full replace.
PUT /policy/api/v1/infra/lb-pools/<lb-pool-id>

List LBServerSslProfiles


Paginated list of all LBServerSslProfiles.
GET /policy/api/v1/infra/lb-server-ssl-profiles

Delete LBServerSslProfile and all the entities contained by this LBServerSslProfile


Delete the LBServerSslProfile along with all the entities contained
by this LBServerSslProfile.
DELETE /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Read LBServerSslProfile


Read a LBServerSslProfile.
GET /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Create or update a LBServerSslProfile


If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
PATCH /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Create or update a LBServerSslProfile


If a LBServerSslProfile with the lb-server-ssl-profile-id is not already
present, create a new LBServerSslProfile. If it already exists, update the
LBServerSslProfile. This is a full replace.
PUT /policy/api/v1/infra/lb-server-ssl-profiles/<lb-server-ssl-profile-id>

Read load balancer service usage summary


API is used to retrieve the load balancer usage summary for
all load balancer services.
If the parameter ?include_usages=true exists, the property service-usages
is included in the response. By default, service-usages is not included
in the response.
GET /policy/api/v1/infra/lb-service-usage-summary

List LBService


Paginated list of all LBService.
GET /policy/api/v1/infra/lb-services

Delete LBService and all the entities contained by this LBService


Delete the LBService along with all the entities contained by
this LBService.
DELETE /policy/api/v1/infra/lb-services/<lb-service-id>

Read LBService


Read an LBService.
GET /policy/api/v1/infra/lb-services/<lb-service-id>

Create or update a LBVirtualServer


If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
PATCH /policy/api/v1/infra/lb-services/<lb-service-id>

Create or update a LBService


If a LBService with the lb-service-id is not already
present, create a new LBService. If it already exists, update the
LBService. This is a full replace.
PUT /policy/api/v1/infra/lb-services/<lb-service-id>

Get LBService status information


Get LBService detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/detailed-status

Get LBPool status information


Get LBPool detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/detailed-status

Get LBPool statistics information


Get LBPoolStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-pools/<lb-pool-id>/statistics

Get LBVirtualServer status information


Get LBVirtualServer detailed status information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/detailed-status

Get LBVirtualServer statistics information


Get LBVirtualServerStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/lb-virtual-servers/<lb-virtual-server-id>/statistics

Get LBService usage information


Get LBServiceUsage information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/service-usage

Get LBService statistics information


Get LBServiceStatistics information.
- no enforcement point path specified: Information will be aggregated from
each enforcement point.
- {enforcement_point_path}: Information will be retrieved only from the
given enforcement point.
GET /policy/api/v1/infra/lb-services/<lb-service-id>/statistics

Retrieve a list of supported SSL ciphers and protocols


Retrieve a list of supported SSL ciphers and protocols.
GET /policy/api/v1/infra/lb-ssl-ciphers-and-protocols

List LBVirtualServers


Paginated list of all LBVirtualServers.
GET /policy/api/v1/infra/lb-virtual-servers

Delete LBVirtualServer and all the entities contained by this LBVirtualServer


Delete the LBVirtualServer along with all the entities contained by
this LBVirtualServer.
DELETE /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Read LBVirtualServer


Read a LBVirtualServer.
GET /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Create or update a LBVirtualServer


If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
PATCH /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>

Create or update a LBVirtualServer


If a LBVirtualServer with the lb-virtual-server-id is not already
present, create a new LBVirtualServer. If it already exists, update the
LBVirtualServer. This is a full replace.
PUT /policy/api/v1/infra/lb-virtual-servers/<lb-virtual-server-id>