Fetch Load Balancer Info

Fetch Load Balancer configuration data for the load balancer container in an specific environment.

Requires the environments-view permission.

Parameters: token hubIdenvironment ID

Load Balancer Info Resource
  • default_config
    object

    The default configuration of the load balancer, if no override config is provided.

    Show child fields
  • service
    object

    Contains information about the status of the load balancer, as well as configuration overrides.

    Show child fields

Returns

Returns an Load Balancer Info resource, otherwise returns an Error.

GET /v1/environments/5b9c2a77b6393d0001eb45fd/services/lb

Example Request
$ curl https://api.cycle.io/v1/environments/5b9c2a77b6393d0001eb45fd/services/lb \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -X GET
Example Response
{
  "data": {
    "default_config": {
      "haproxy": {
        "default": {
          "frontend": {
            "mode": "tcp",
            "max_connections": 1500,
            "timeouts": {
              "client_secs": 8,
              "client_fin_ms": null,
              "http_keep_alive_ms": null,
              "http_request_ms": null
            }
          },
          "backend": {
            "balance": "roundrobin",
            "timeouts": {
              "server_secs": 8,
              "server_fin_ms": null,
              "connect_ms": 250,
              "queue_ms": 250,
              "tunnel_secs": null
            }
          }
        },
        "ports": {
          "1194": {
            "frontend": {
              "mode": "tcp",
              "max_connections": 100,
              "timeouts": {
                "client_secs": 8,
                "client_fin_ms": null,
                "http_keep_alive_ms": null,
                "http_request_ms": null
              }
            },
            "backend": {
              "balance": "source",
              "timeouts": {
                "server_secs": 8,
                "server_fin_ms": null,
                "connect_ms": 500,
                "queue_ms": 500,
                "tunnel_secs": null
              }
            }
          }
        }
      },
      "ipv4": true,
      "ipv6": true
    },
    "service": {
      "enable": true,
      "container_id": "5b9c2a77b6393d0001eb45fd",
      "high_availability": false,
      "config": {
        "haproxy": {
          "default": {
            "frontend": {
              "mode": "tcp",
              "max_connections": 1500,
              "timeouts": {
                "client_secs": 8,
                "client_fin_ms": null,
                "http_keep_alive_ms": null,
                "http_request_ms": null
              }
            },
            "backend": {
              "balance": "source",
              "timeouts": {
                "server_secs": 8,
                "server_fin_ms": null,
                "connect_ms": 250,
                "queue_ms": 250,
                "tunnel_secs": null
              }
            }
          },
          "ports": {
            "1194": {
              "frontend": {
                "mode": "tcp",
                "max_connections": 100,
                "timeouts": {
                  "client_secs": 8,
                  "client_fin_ms": null,
                  "http_keep_alive_ms": null,
                  "http_request_ms": null
                }
              },
              "backend": {
                "balance": "source",
                "timeouts": {
                  "server_secs": 8,
                  "server_fin_ms": null,
                  "connect_ms": 500,
                  "queue_ms": 500,
                  "tunnel_secs": null
                }
              }
            }
          }
        },
        "ipv4": true,
        "ipv6": true
      }
    }
  }
}