Listing all load balancing entries of a domain¶

Note

To get a list of load balancing entries, a domain with DNS records must already have been created.

Send a GET request to the endpoint /domain/{domainId}/load-balancing.

Description¶

The List-load-balancing request allows the user to request a list of all DNS records and their load balancing entries for the entry types A, AAAA and CNAME of a domain of the organisation.

Requirements¶

Values of the request: Domain ID {domainId}

Objects: none

Request¶

To request the load balancing entries of a domain, the Domain-ID {domainId} needs to be added to the path of the request.

As a result, the user gets one or more objects DnsRecordVO with the relevant object UpstreamOptionsVO with the requested information.

The following information for the load balancing is provided under the upstreamOptions attribute:

Attributes	Description	Values
`weight`	The weight of the SRV record.	`integer`
`mxFails`	The number of errors that must be present to start the load balancing.	`integer`
`failTimeout`	The maximum value in seconds of connection errors until the load balancing will be activated.	`1` `10` `60` `600` `900` `1800` `3600`
`backup`	Defines if the entry is a backup server or not.	`true` `false`
`down`	Defines if the server is available.	`true` `false`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "name": "string",
    "value": "string",
    "priority": 0,
    "ttl": 0,
    "vhostId": 0,
    "recordType": "string",
    "weight": 0,
    "port": 0,
    "active": true,
    "paused": true,
    "sslCertTemplate": "string",
    "upstreamOptions": "string",
    "alternativeCname": "string",
    "environment": "string",
    "caaFlags": 0,
    "caaTag": "string",
    "endpoints": "string",
    "serviceType": 0,
    "encryption": "string",
    "identificationNumber": "string",
    "hashType": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "enabled": true,
    "comment": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.