List Frontends

List all frontends configured on the given load balancer.

Authorization

AuthorizationRequiredBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Path Parameters

lb_idRequiredstring

A unique identifier for a load balancer instance.

curl -X GET "https://api.alpha.openscaler.net/v1/lbs/42/frontends" \
  -H "Authorization: Bearer <token>"

List of frontends.

{
  "frontends": [
    {
      "name": "https-frontend",
      "mode": "http",
      "default_backend": "main-backend",
      "binds": [
        {
          "port": 443,
          "ssl": true,
          "ssl_certificate": "my-cert",
          "use_http3": false
        }
      ],
      "acls": [
        {
          "name": "is_api",
          "criterion": "path_beg",
          "value": "/api"
        }
      ],
      "backends": [
        {
          "backend": "api-backend",
          "cond": "if",
          "test": "is_api"
        }
      ],
      "options": {
        "redirect_ssl": true,
        "forward_for": true
      }
    }
  ]
}

Authorization

OAuth Authentication

Path Parameters

Response

TypeScript