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

# List the LB's instance replicas with live health

> Returns one entry per compute instance backing the LB. The
per-replica `proxy_ok` + `last_seen` overlay is refreshed on
every replica health report (typically every 15s) and is absent
when a replica hasn't yet reported (boot still in flight).




## OpenAPI

````yaml /api-reference/specs/loadbalancer.yaml get /v1/load-balancers/{id}/replicas
openapi: 3.0.3
info:
  title: Basaltic Load Balancer API
  version: 1.0.0
  description: |
    Managed load balancers: listeners, target pools, health checks and the
    TLS certificates a listener terminates.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://loadbalancer.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
paths:
  /v1/load-balancers/{id}/replicas:
    get:
      tags:
        - Load Balancers
      summary: List the LB's instance replicas with live health
      description: |
        Returns one entry per compute instance backing the LB. The
        per-replica `proxy_ok` + `last_seen` overlay is refreshed on
        every replica health report (typically every 15s) and is absent
        when a replica hasn't yet reported (boot still in flight).
      operationId: listLoadBalancerReplicas
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: 4e1f8c2a-9b3d-4f6e-8a1c-2d5e7f9a0b3c
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadBalancerReplicasResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    LoadBalancerReplicasResponse:
      type: object
      properties:
        replicas:
          type: array
          items:
            $ref: '#/components/schemas/LoadBalancerReplica'
    LoadBalancerReplica:
      type: object
      description: >
        One compute instance backing the load balancer. The bookkeeping

        fields (instance_id, replica_index, created_at, flavor_id) are

        persisted; the liveness overlay (last_seen, proxy_ok, agent_version)

        refreshes on each replica health report.


        Replicas are managed instances, so the compute instance endpoints do not

        return them — this is where you watch them. During a resize the replicas

        turn over one at a time: a replica has been replaced when its
        instance_id

        changes, and the resize is complete when every flavor_id here matches
        the

        load balancer's. Expect one more replica than replica_count to be listed

        part-way through, which is the resize keeping capacity up rather than a

        replica leaking; it goes away when the last old one does.
      required:
        - instance_id
        - replica_index
        - created_at
        - flavor_id
        - proxy_ok
        - status
      properties:
        instance_id:
          type: string
          format: uuid
          example: a7b8c9d0-e1f2-4345-a6b7-c8d9e0f1a2b3
        replica_index:
          type: integer
          example: 0
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        flavor_id:
          type: string
          format: uuid
          example: e5f6a7b8-c9d0-4123-e4f5-a6b7c8d9e0f1
          description: >-
            The size this replica actually booted on. Matches the load
            balancer's flavor_id except mid-resize, when the replicas not yet
            replaced still report the old one.
        status:
          type: string
          enum:
            - initializing
            - healthy
            - unhealthy
          example: healthy
          description: >-
            The liveness view folded into one word: 'initializing' (the agent
            has never reported — boot still in flight), 'healthy' (heartbeating
            and the proxy is serving), 'unhealthy' (heartbeating but the proxy
            is down).
        proxy_ok:
          type: boolean
          description: Whether the proxy reported ready at the last health report
          example: true
        agent_version:
          type: string
          example: 1.4.2
        last_seen:
          type: string
          format: date-time
          description: Omitted when this replica hasn't reported yet
          example: '2026-01-15T09:31:00Z'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````