Load balancer API

Creates a regional load balancer and its listeners.

Send name, region_id, network_id, exposure, and at least one listener. Exposure is internal by default or public with an eligible public assignment. A listener has protocol, port, backend_port, and a backend selection.

To create an HTTP listener for the selected application backends, send:

{
  "name": "payments-edge",
  "region_id": "reg_euwest",
  "network_id": "net_production",
  "exposure": "internal",
  "listeners": [
    {
      "protocol": "http",
      "port": 80,
      "backend_port": 8080,
      "backend_selector": { "service": "web" },
      "health_check": { "protocol": "http", "path": "/ready" }
    }
  ]
}

Listener protocols are tcp, http, or https. Ports are integers 1–65535. HTTPS requires certificate_secret_id. A duplicate listener address and port, an invalid health timing, or a foreign-project network returns 422. Accepted creation returns 202 with the service ID and operation.

Returns resolved backend IDs, probe result, membership state, and active connection count. Requires networks:read. Selector resolution does not imply healthy membership.

Replaces the supplied listener configuration.

Requires If-Match. A supplied listeners array replaces the complete listener definition. Omission leaves it unchanged; an empty array is rejected. Accepted changes return 202 and expose desired versus active revision in later reads.

A failed certificate validation leaves the active listener unchanged. A deployment failure after acceptance can leave some instances on their previous revision. Inspect operation adoption before revoking old certificate material.

Drains a backend after the membership revision applies.

Accepts drain_timeout_seconds, default 300, integer 0–3600. It returns 202 and prevents new selection after the revision applies. Existing connections close on completion or timeout.

Requests return to active membership; the backend still needs to pass its healthy threshold. Reactivation cannot recreate connections already closed by the drain.

Deletes the load balancer while retaining independent backend droplets.

Deletion requires If-Match and returns an operation. Backend droplets remain independent. The public assignment's retention is explicit and is not inferred from the backend list. See TLS rotation and connection draining.