---
title: "List a project's load balancers, newest first"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Load Balancers API

`GET /v1/organizations/{orgId}/projects/{projectId}/load-balancers`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListLoadBalancers.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `ListLoadBalancers.path.projectId` (string, required) — UUID or prefixed ID (prj_…)

## Query parameters

- `ListLoadBalancers.query.limit` (integer, optional) — The page size. Out of range is 400, never a clamp.
  - min 1; max 100; default `20`
- `ListLoadBalancers.query.cursor` (string, optional) — The previous page's nextCursor. Bound to the organization, the list and its filters.
- `ListLoadBalancers.query.tag` (array<string>, optional) — Only load balancers with this tag, as <key>=<value> (split at the first =). Repeat it for up to 5 tags; a load balancer must have every one.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://lb-api.ezghcloud.com/v1/organizations/string/projects/string/load-balancers \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://lb-api.ezghcloud.com/v1/organizations/string/projects/string/load-balancers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://lb-api.ezghcloud.com/v1/organizations/string/projects/string/load-balancers"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of load balancers.

#### Example

```json
{
  "loadBalancers": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "ipv4Address": "string",
      "ipv6": true,
      "ipv6Address": "string",
      "lastChange": {
        "generation": 0,
        "reason": "string",
        "state": "applying"
      },
      "name": "string",
      "organizationId": "string",
      "privateIpv4Address": "string",
      "projectId": "string",
      "region": "string",
      "resourceName": "string",
      "scheme": "internet",
      "slug": "string",
      "status": "provisioning",
      "subnet": "string",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z",
      "vpc": "string",
      "waf": {
        "status": "applying",
        "version": 0
      },
      "wafId": "string"
    }
  ],
  "nextCursor": "string"
}
```

- `ListLoadBalancers.response.200.loadBalancers` (array<object>, required)
  - `ListLoadBalancers.response.200.loadBalancers.createdAt` (string, required)
    - format `date-time`
  - `ListLoadBalancers.response.200.loadBalancers.description` (string | null, required)
  - `ListLoadBalancers.response.200.loadBalancers.id` (string, required)
    - format `uuid`
  - `ListLoadBalancers.response.200.loadBalancers.ipv4Address` (string | null, required) — The load balancer's public IPv4 address, null when it has only IPv6.
  - `ListLoadBalancers.response.200.loadBalancers.ipv6` (boolean, required) — Whether the load balancer answers on IPv6.
  - `ListLoadBalancers.response.200.loadBalancers.ipv6Address` (string | null, required) — The address IPv6 clients connect to, null while IPv6 is off or being turned on.
  - `ListLoadBalancers.response.200.loadBalancers.lastChange` (one of, required)
    - one of: [LastChange](/lb-api/schemas/LastChange/), `null`
  - `ListLoadBalancers.response.200.loadBalancers.name` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.organizationId` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.privateIpv4Address` (string | null, required) — An internal load balancer's address in its subnet, null on an internet load balancer and until it has one.
  - `ListLoadBalancers.response.200.loadBalancers.projectId` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.region` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.resourceName` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.scheme` (unknown, required) — internet: reached at its public addresses. internal: reached only from inside its VPC, at privateIpv4Address.
    - one of `"internet"`, `"internal"`
  - `ListLoadBalancers.response.200.loadBalancers.slug` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.status` (unknown, required)
    - one of `"provisioning"`, `"active"`, `"deleting"`, `"deleted"`
  - `ListLoadBalancers.response.200.loadBalancers.subnet` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.tags` (map<string>, required) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
  - `ListLoadBalancers.response.200.loadBalancers.updatedAt` (string, required)
    - format `date-time`
  - `ListLoadBalancers.response.200.loadBalancers.vpc` (string, required)
  - `ListLoadBalancers.response.200.loadBalancers.waf` (one of, required) — How the attached WAF's latest version is going, null with no WAF.
    - one of: [LoadBalancerWaf](/lb-api/schemas/LoadBalancerWaf/), `null`
  - `ListLoadBalancers.response.200.loadBalancers.wafId` (string | null, required) — The WAF that inspects the load balancer's http and https listeners, null for none. tcp and tls listeners pass uninspected.
- `ListLoadBalancers.response.200.nextCursor` (string | null, required)

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.400.error` (object, required)
  - `ListLoadBalancers.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.400.error.issues.message` (string, required)
    - `ListLoadBalancers.response.400.error.issues.path` (string, required)
  - `ListLoadBalancers.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.400.error.quota.id` (string, required)
    - `ListLoadBalancers.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.400.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.401.error` (object, required)
  - `ListLoadBalancers.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.401.error.issues.message` (string, required)
    - `ListLoadBalancers.response.401.error.issues.path` (string, required)
  - `ListLoadBalancers.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.401.error.quota.id` (string, required)
    - `ListLoadBalancers.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.401.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.403.error` (object, required)
  - `ListLoadBalancers.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.403.error.issues.message` (string, required)
    - `ListLoadBalancers.response.403.error.issues.path` (string, required)
  - `ListLoadBalancers.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.403.error.quota.id` (string, required)
    - `ListLoadBalancers.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.403.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.404.error` (object, required)
  - `ListLoadBalancers.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.404.error.issues.message` (string, required)
    - `ListLoadBalancers.response.404.error.issues.path` (string, required)
  - `ListLoadBalancers.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.404.error.quota.id` (string, required)
    - `ListLoadBalancers.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.404.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.429.error` (object, required)
  - `ListLoadBalancers.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.429.error.issues.message` (string, required)
    - `ListLoadBalancers.response.429.error.issues.path` (string, required)
  - `ListLoadBalancers.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.429.error.quota.id` (string, required)
    - `ListLoadBalancers.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.429.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.500.error` (object, required)
  - `ListLoadBalancers.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.500.error.issues.message` (string, required)
    - `ListLoadBalancers.response.500.error.issues.path` (string, required)
  - `ListLoadBalancers.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.500.error.quota.id` (string, required)
    - `ListLoadBalancers.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.500.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListLoadBalancers.response.503.error` (object, required)
  - `ListLoadBalancers.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListLoadBalancers.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListLoadBalancers.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListLoadBalancers.response.503.error.issues.message` (string, required)
    - `ListLoadBalancers.response.503.error.issues.path` (string, required)
  - `ListLoadBalancers.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListLoadBalancers.response.503.error.quota.id` (string, required)
    - `ListLoadBalancers.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListLoadBalancers.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListLoadBalancers.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListLoadBalancers.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.503.error.quota.region` (string, optional)
    - `ListLoadBalancers.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListLoadBalancers.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListLoadBalancers.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListLoadBalancers.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/lb-api/ListLoadBalancers/index.md
