Returns details about a load balancer.
If successful, this endpoint will return a 200 OK status.
One of the following scopes are required to use this endpoint.
The following arguments are supported for this endpoint.
Name | Type | Default Value |
---|---|---|
load_balancer Required The load balancer to return the details for |
Load balancer lookup | None |
The following errors may occur during this request.
Details | HTTP status |
---|---|
No load balancer was found matching any of the criteria provided in the arguments |
404 Not Found |
When the request is successful, you can expect an object matching the specification below to be returned.
{ load_balancer: LoadBalancer { id: String name: String api_reference: String? resource_type: LoadBalancerResourceTypesEnum resources: [ LoadBalancerResource ] resource_ids: [ String ] ip_address: IPAddress { id: String address: String } https_redirect: Boolean backend_certificate: String backend_certificate_key: String data_center: DataCenter { id: String name: String permalink: String } enable_weighting: Boolean weights: [ LoadBalancerWeight { virtual_machine_id: String weight: Integer } ] standby_vms: [ String ] } annotations: [ KeyValue { key: String value: String? } ] }