Scaleway Ipam
@sntxrr/scaleway-ipamv2026.10.14.1
01README
Manage a Scaleway IPAM IP address — sync state, book (reserve), update tags/reverses, and release an IP, and discover managed IPs in a region, via the IPAM API with X-Auth-Token auth.
02Release Notes
Declare SPDX license (MIT) in manifest.
03Behaviors
@sntxrr/scaleway-ipamv2026.07.19.1scaleway_ipam.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 managed IP address. |
| region? | string | Region, e.g. fr-par, nl-ams, pl-waw. |
| ipId? | string | ID of the managed IP address this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the managed IP's current state (GetIP).
fn create(source: record, isIpv6?: boolean, address?: string, tags?: array)
Book (reserve) a new IP address (BookIP) and snapshot it.
| Argument | Type | Description |
|---|---|---|
| source | record | Source pool to book from, e.g. {"subnet_id":"..."} or {"zonal":"fr-par-1"}. |
| isIpv6? | boolean | Whether to book an IPv6 address instead of IPv4. |
| address? | string | Optional specific address to request (CIDR), e.g. 192.0.2.10/32. |
| tags? | array | Tags to attach to the newly booked IP. |
fn update(tags?: array, reverses?: array)
Mutate a managed IP's mutable fields — tags, reverses (UpdateIP).
| Argument | Type | Description |
|---|---|---|
| tags? | array | Replacement set of tags for the IP. |
| reverses? | array | Replacement set of reverse DNS entries for the IP. |
fn delete()
Release the managed IP address (ReleaseIP).
fn list()
Discover all managed IPs in the region (factory).
Resources
ip(infinite)— Snapshot of the managed IP address's state
04Previous Versions
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
27
Archive size
8.2 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