Retrieving the Load Balance service information using the API requires specific syntax depending on whether you are using REST or SOAP. Use this table to find the syntax for your command.

 

NOTE: The Load Balance Service is deprecated. Legacy users of the service should contact Concierge for any questions on adding a Load Balance service to your zone. All other users should use the GSLB service instead.

 

REST Syntax

Click to view all REST Resources

/REST/LoadBalance/ GET — Retrieve one or all Load Balance service instances

HTTP Action — GET

URIs:
Retrieve a Load Balance service — https://api.dynect.net/REST/LoadBalance/<zone>/<fqdn>/
Retrieve all Load Balance services — https://api.dynect.net/REST/LoadBalance/<zone>/

Arguments:

Retrieve one Load Balance Service — No Arguments.

Retrieve all Load Balance Services —

  • string detail — A boolean indicating whether or not to return the full details or a list of service resources:
    Y – The details of each service are specified.
    N – The list of service resources is returned. ( Default )
Response:

Retrieve a Load Balance service — Click for More Info

Retrieve all Load Balance services: array — Individual Load Balance service resources.

Dyn Logo

SOAP Syntax

Click to view all SOAP Commands

GetOneLoadBalance — Retrieves a single instance of the Load Balance service.

GetLoadBalances — Retrieves all instances of the Load Balance services.

Arguments:

GetOneLoadBalance:

  • string fqdnRequired. Name of node where the service exists.
  • string tokenRequired. The session identifier.
  • string zoneRequired. Name of zone where the service exists.

GetLoadBalances:

  • string tokenRequired. The session identifier.
  • string zoneRequired. Name of zone where the service exists.
Response:

GetOneLoadBalance — Click for More Info

GetLoadBalances — Click for More Info

Example Request (GetOneLoadBalance) — Click for More Info

Example Request (GetLoadBalances) — Click for More Info