Skip to main content

Scaleway Block Storage

@sntxrr/scaleway-block-storagev2026.10.14.1· MIT(was none)· 1mo agoBEHAVIORS
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.

02Release Notes

Declare SPDX license (MIT) in manifest.

03Behaviors1
@sntxrr/scaleway-block-storagev2026.07.19.1scaleway_block_storage.ts

Global Arguments

ArgumentTypeDescription
secretKeystringScaleway API secret key. Wire with ${{ vault.get(scaleway, SCW_SECRET_KEY) }}.
projectIdstringScaleway Project ID that owns the volume.
zone?stringAvailability zone, e.g. fr-par-1, nl-ams-1, pl-waw-1.
volumeId?stringID of the Block Storage volume this model manages. Optional — `create`
endpoint?stringOverride 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).
ArgumentTypeDescription
namestringHuman-readable name for the new volume.
size?numberVolume size in bytes. Required when creating from empty; optional (defaults to the snapshot size) when creating from a snapshot.
perfIops?numberRequested provisioned IOPS for the volume (e.g. 5000 or 15000).
fromSnapshotId?stringIf set, create the volume from this snapshot ID instead of from empty.
tags?arrayOptional 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).
ArgumentTypeDescription
name?stringNew name for the volume.
size?numberNew volume size in bytes (resize; may only grow).
perfIops?numberNew requested provisioned IOPS for the volume.
tags?arrayReplacement 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
04Previous Versions2
2026.07.19.1
2026.07.18.1
05Stats
A
100 / 100
Downloads
29
Archive size
8.0 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
06Platforms
07Labels