List Load Balancers

List all load balancers. Optionally filter by project, region, or VPC.

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

Query Parameters

project_idRequiredstring

ID of the project used to filter results.

regionstring

Filter load balancers by region.

vpc_idstring

A unique identifier for a VPC instance. See VPCs section for more details.

curl -X GET "https://api.alpha.openscaler.net/v1/lbs?project_id=default&region=eu-west-1&vpc_id=23" \
  -H "Authorization: Bearer <token>"

List of load balancers.

{
  "load_balancers": [
    {
      "id": "42",
      "name": "my-lb",
      "description": "Production load balancer",
      "user_id": "usr_abc123",
      "project_id": "default",
      "size": "small",
      "region": "eu-west-1",
      "visibility": "public",
      "status": "ready",
      "state": "running",
      "network": {},
      "created_at": "2024-06-01T12:00:00Z",
      "updated_at": "2024-06-15T08:30:00Z"
    }
  ]
}

Authorization

OAuth Authentication

Query Parameters

Response

TypeScript