Scaleway Load Balancer
@sntxrr/scaleway-load-balancerv2026.10.14.1
01README
Manage a Scaleway Load Balancer — sync current state, create, update, delete, and discover Load Balancers plus their backends and frontends in a zone, via the zoned Load Balancer API with X-Auth-Token auth.
02Release Notes
Declare SPDX license (MIT) in manifest.
03Behaviors
@sntxrr/scaleway-load-balancerv2026.07.19.1scaleway_load_balancer.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| secretKey | string | Scaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}. |
| projectId | string | Scaleway Project ID that owns the Load Balancer. |
| zone? | string | Availability zone, e.g. fr-par-1, nl-ams-1, pl-waw-1. |
| lbId? | string | ID of the Load Balancer this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the Load Balancer's current state (GetLb).
fn create(name: string, description?: string, type?: string, tags?: array, assignFlexibleIp?: boolean)
Provision a new Load Balancer (CreateLb).
| Argument | Type | Description |
|---|---|---|
| name | string | Name to assign to the new Load Balancer. |
| description? | string | Optional human-readable description of the Load Balancer. |
| type? | string | Commercial offer type, e.g. LB-S, LB-GP-M, LB-GP-L. |
| tags? | array | Optional list of tags to attach to the Load Balancer. |
| assignFlexibleIp? | boolean | Whether to automatically assign a new flexible IP to the Load Balancer. |
fn update(name?: string, description?: string, tags?: array)
Update the Load Balancer's mutable fields (UpdateLb).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the Load Balancer. |
| description? | string | New human-readable description of the Load Balancer. |
| tags? | array | Replacement list of tags to attach to the Load Balancer. |
fn delete(releaseIp?: boolean)
Deprovision the Load Balancer (DeleteLb).
| Argument | Type | Description |
|---|---|---|
| releaseIp? | boolean | Whether to release the Load Balancer's flexible IP addresses on delete. |
fn list()
Discover all Load Balancers in the zone (factory).
fn list-backends()
Discover all backends attached to this Load Balancer (factory).
fn list-frontends()
Discover all frontends attached to this Load Balancer (factory).
Resources
loadBalancer(infinite)— Snapshot of the Load Balancer's state
backend(infinite)— Snapshot of a Load Balancer backend
frontend(infinite)— Snapshot of a Load Balancer frontend
04Previous Versions
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
27
Archive size
8.5 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-scaleway06Platforms
07Labels