---
title: "Get load balancer"
method: GET
path: "/api/v2/loadbalancers/{loadBalancerID}"
tags: ["Load balancers"]
---

# Get load balancer

`GET /api/v2/loadbalancers/{loadBalancerID}`

Get a load balancer.

## Response `200`

A load balancer.

- LoadBalancerV2Read — A load balancer.
  - `metadata` ProjectScopedResourceReadMetadata, required — Metadata required for all API resource reads and writes.
    - `name` string, required — A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
    - `description` string — The resource description, this optionally augments the name with more context.
    - `tags` Tag[] — A list of tags.
      - `name` string, required — A unique tag name.
      - `value` string, required — The value of the tag.
    - `id` string, required — The unique resource ID.
    - `creationTime` string, date-time, required — The time the resource was created.
    - `createdBy` string — The user who created the resource.
    - `modifiedTime` string, date-time — The time a resource was updated.
    - `modifiedBy` string — The user who updated the resource.
    - `deletionTime` string, date-time — The time the resource was deleted.
    - `provisioningStatus` 'unknown' | 'provisioning' | 'provisioned' | 'deprovisioning' | 'error', required — The provisioning state of a resource.
    - `healthStatus` 'unknown' | 'healthy' | 'degraded' | 'error', required — The health state of a resource.
    - `organizationId` string, required — The organization identifier the resource belongs to.
    - `projectId` string, required — The project identifier the resource belongs to.
  - `spec` LoadBalancerV2Spec, required — A load balancer's specification.
    - `publicIP` boolean — Whether to allocate a public IP.
    - `listeners` LoadBalancerListenerV2[], required — A list of load balancer listeners.
      - `name` string, required — A load balancer listener name. Must start with a lower-case letter and otherwise be a valid DNS label.
      - `protocol` 'tcp' | 'udp', required — The load balancer listener protocol.
      - `port` integer, required — The listener port.
      - `allowedCidrs` string[] — A list of source IPv4 CIDRs allowed to access the listener.
      - `idleTimeoutSeconds` integer — The idle timeout in seconds. Defaults to 60 for TCP listeners and is unsupported for UDP listeners.
      - `pool` LoadBalancerPoolV2, required — A load balancer listener pool.
        - `proxyProtocolV2` boolean — Whether to enable Proxy Protocol v2.
        - `members` LoadBalancerMemberV2[], required — A list of pool members.
          - `address` string, ipv4, required — An IPv4 address.
          - `port` integer, required
        - `healthCheck` LoadBalancerHealthCheckV2 — A load balancer pool health check.
          - `intervalSeconds` integer
          - `timeoutSeconds` integer
          - `healthyThreshold` integer
          - `unhealthyThreshold` integer
  - `status` LoadBalancerV2Status, required — Read only status information about a load balancer.
    - `regionId` string, required — The region the load balancer belongs to.
    - `networkId` string, required — The network the load balancer belongs to.
    - `vipAddress` string, ipv4 — An IPv4 address.
    - `publicIP` string, ipv4 — An IPv4 address.

## Other responses

- `400` — Request body failed schema validation, or the request does not contain all the required fields.
- `401` — Authentication failed or the access token has expired.
- `403` — Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform.
- `404` — Unable to find a resource.
- `500` — An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue.

---

[API](https://skmtc.net/nscale/apis/region-service-api.md) · [All operations](https://skmtc.net/nscale/apis/region-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nscale/region-service-api/revisions/c2991b23da6e/schema)