v1
ApplicationAPI & CLI
API
CLI
JS Client

Load Balancers /

List load balancers

Gets a list of load balancers belonging to the team

Required permission

Account > LoadBalancers > General > Read

Query parameters

    • per_page

      integer
      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer
      The page number to access.

    • cursor

      string
      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • loadBalancers

        [array] required
        An array of load balancers.
        • {object}
          A load balancer object.

          • name

            string required
            The name of the load balancer.
            min length
            3
            max length
            39
            pattern
            ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

          • description

            string
            The description of the load balancer.
            max length
            200
            pattern
            ^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

          • spec

            {object} required
            Load balancer specification

          • id

            string required
            ID of the load balancer
            pattern
            ^[A-Za-z0-9-]+$

          • createdAt

            string required
            The time the load balancer was created.

          • updatedAt

            string required
            The time the load balancer was last updated.

    • pagination

      {object} required
      Data about the endpoint pagination.

      • hasNextPage

        boolean required
        Is there another page of results available?

      • cursor

        string
        The cursor to access the next page of results.

      • count

        number required
        The number of results returned by this request.
API
CLI
JS Client

GET /v1/load-balancers

Example response

200 OK

A list of load balancers belonging to the team.

JSON

{
  "data": {
    "loadBalancers": [
      {
        "name": "my-load-balancer",
        "description": "This is a new load balancer.",
        "spec": {
          "type": "tcp",
          "target": {
            "type": "region",
            "targetId": "europe-west"
          },
          "ports": [
            {
              "id": "port-80",
              "backends": [
                {
                  "id": "my-project/my-service",
                  "type": "service",
                  "port": 3000,
                  "weight": 1
                }
              ]
            }
          ]
        },
        "id": "my-load-balancer",
        "createdAt": "2021-01-20T11:19:53.175Z",
        "updatedAt": "2021-01-20T11:19:53.175Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com