Scaleway Block Storage
@sntxrr/scaleway-block-storagev2026.07.19.1
01README
Manage a Scaleway Block Storage volume — sync current state, create, update (resize/rename/re-tag), delete, and discover volumes in a zone, via the Block Storage API with X-Auth-Token auth.
02Models
@sntxrr/scaleway-block-storagev2026.07.19.1scaleway_block_storage.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 volume. |
| zone | string | Availability zone, e.g. fr-par-1, nl-ams-1, pl-waw-1. |
| volumeId? | string | ID of the Block Storage volume this model manages. Optional — `create` |
| endpoint? | string | Override the API host. Defaults to https://api.scaleway.com. |
fn sync()
Fetch the volume's current state (GetVolume).
fn create(name: string, size?: number, perfIops?: number, fromSnapshotId?: string, tags?: array)
Provision a new Block Storage volume (CreateVolume).
| Argument | Type | Description |
|---|---|---|
| name | string | Human-readable name for the new volume. |
| size? | number | Volume size in bytes. Required when creating from empty; optional (defaults to the snapshot size) when creating from a snapshot. |
| perfIops? | number | Requested provisioned IOPS for the volume (e.g. 5000 or 15000). |
| fromSnapshotId? | string | If set, create the volume from this snapshot ID instead of from empty. |
| tags? | array | Optional list of tags to attach to the volume. |
fn update(name?: string, size?: number, perfIops?: number, tags?: array)
Mutate a volume's name, size (resize), IOPS, or tags (UpdateVolume, PATCH).
| Argument | Type | Description |
|---|---|---|
| name? | string | New name for the volume. |
| size? | number | New volume size in bytes (resize; may only grow). |
| perfIops? | number | New requested provisioned IOPS for the volume. |
| tags? | array | Replacement list of tags for the volume. |
fn delete()
Deprovision the volume (DeleteVolume).
fn list()
Discover all Block Storage volumes in the zone (factory).
Resources
volume(infinite)— Snapshot of the Block Storage volume's state
03Previous Versions
2026.07.18.1
04Stats
A
100 / 100
Downloads
0
Archive size
9.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
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/sntxrr/swamp-scaleway05Platforms
06Labels