Scaleway Public Gateway
@sntxrr/scaleway-public-gatewayv2026.10.14.1
01README
Manage a Scaleway Public Gateway — sync current state, create, update, delete, and discover Public Gateways in a zone, via the zoned Public Gateway v2 API with X-Auth-Token auth.
02Release Notes
Declare SPDX license (MIT) in manifest.
03Behaviors
@sntxrr/scaleway-public-gatewayv2026.07.19.1scaleway_public_gateway.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 Public Gateway. |
| zone? | string | Availability zone, e.g. fr-par-1, it-mil-1, nl-ams-1, pl-waw-1. |
| gatewayId? | string | ID of the Public Gateway this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the Public Gateway's current state (GetGateway).
fn create(name: string, type?: string, tags?: array, ipId?: string, enableBastion?: boolean, enableSmtp?: boolean)
Provision a new Public Gateway (CreateGateway).
| Argument | Type | Description |
|---|---|---|
| name | string | Name to assign to the new Public Gateway. |
| type? | string | Commercial offer type, e.g. VPC-GW-S, VPC-GW-M, VPC-GW-L. |
| tags? | array | Optional list of tags to attach to the Public Gateway. |
| ipId? | string | Optional existing flexible IP address ID to attach to the gateway. |
| enableBastion? | boolean | Whether to enable the SSH bastion on the gateway. |
| enableSmtp? | boolean | Whether to allow SMTP traffic to pass through the gateway. |
fn update(name?: string, tags?: array, enableBastion?: boolean, enableSmtp?: boolean)
Update the Public Gateway's mutable fields (UpdateGateway).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the Public Gateway. |
| tags? | array | Replacement list of tags to attach to the Public Gateway. |
| enableBastion? | boolean | Whether the SSH bastion should be enabled on the gateway. |
| enableSmtp? | boolean | Whether SMTP traffic should be allowed to pass through the gateway. |
fn delete(deleteIp?: boolean)
Deprovision the Public Gateway (DeleteGateway).
| Argument | Type | Description |
|---|---|---|
| deleteIp? | boolean | Whether to delete the gateway's flexible IP address on delete |
fn list()
Discover all Public Gateways in the zone (factory).
Resources
gateway(infinite)— Snapshot of the Public Gateway's state
04Previous Versions
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
27
Archive size
7.9 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