Create, list, inspect, and delete volumes

# cloud_volume_crud.py — create, list, inspect, delete
# Run: python cloud_volume_crud.py
import asyncio
import os
import time

from boxlite import ApiKeyCredential, Boxlite, BoxliteRestOptions

api_key = os.environ.get("BOXLITE_API_KEY")
if not api_key:
    raise SystemExit("Set BOXLITE_API_KEY to your blk_live_... key before running this.")


async def main() -> None:
    rt = Boxlite.rest(
        BoxliteRestOptions(
            url=os.environ.get("BOXLITE_REST_URL", "https://api.boxlite.ai"),
            credential=ApiKeyCredential(api_key),
        )
    )

    volume = None
    try:
        # CREATE — name is optional; omit it and the server names the volume after its id.
        volume = await rt.volumes.create(f"crud-demo-{int(time.time())}")
        print(f"created  id={volume.id}  name={volume.name}  created_at={volume.created_at}")

        # LIST — every volume this key can see.
        volumes = await rt.volumes.list()
        print(f"listed   {len(volumes)} volume(s); ours present: "
              f"{any(v.id == volume.id for v in volumes)}")

        # INSPECT — by id, never by name.
        same = await rt.volumes.get(volume.id)
        # size_bytes is always None on Cloud; measure usage from inside a box instead.
        print(f"fetched  id={same.id}  name={same.name}  size_bytes={same.size_bytes}")

        # DELETE — returns an acknowledgement, not a finished deletion.
        await rt.volumes.remove(volume.id)
        print("delete accepted")

        # Deletion is asynchronous: poll the listing with a bound, never wait for a 404.
        for _ in range(12):
            if all(v.id != volume.id for v in await rt.volumes.list()):
                print("reclaimed")
                return
            await asyncio.sleep(5)
        print("still listed after 60s — reclamation runs on the platform's cycle")
    except Exception as exc:
        print(f"failed: {type(exc).__name__}: {exc}")
        if volume is not None:
            try:
                await rt.volumes.remove(volume.id, force=True)
            except Exception:
                pass


if __name__ == "__main__":
    asyncio.run(main())

// cloudVolumeCrud.ts — create, list, inspect, delete
// Run: node cloudVolumeCrud.ts
import { ApiKeyCredential, BoxliteRestOptions, JsBoxlite } from "@boxlite-ai/boxlite";

const apiKey = process.env.BOXLITE_API_KEY;
if (!apiKey) {
  throw new Error("Set BOXLITE_API_KEY to your blk_live_... key before running this.");
}

const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));

async function main(): Promise<void> {
  const rt = JsBoxlite.rest(
    new BoxliteRestOptions({
      url: process.env.BOXLITE_REST_URL ?? "https://api.boxlite.ai",
      credential: new ApiKeyCredential(apiKey),
    }),
  );

  let volume = null;
  try {
    // CREATE — name is optional; omit it and the server names the volume after its id.
    volume = await rt.volumes.create(`crud-demo-${Math.floor(Date.now() / 1000)}`);
    console.log(`created  id=${volume.id}  name=${volume.name}  createdAt=${volume.createdAt}`);

    // LIST — every volume this key can see.
    const volumes = await rt.volumes.list();
    console.log(`listed   ${volumes.length} volume(s); ours present: ` +
      `${volumes.some((v) => v.id === volume.id)}`);

    // INSPECT — by id, never by name.
    const same = await rt.volumes.get(volume.id);
    // sizeBytes is always undefined on Cloud; measure usage from inside a box instead.
    console.log(`fetched  id=${same.id}  name=${same.name}  sizeBytes=${same.sizeBytes}`);

    // DELETE — returns an acknowledgement, not a finished deletion.
    await rt.volumes.remove(volume.id);
    console.log("delete accepted");

    // Deletion is asynchronous: poll the listing with a bound, never wait for a 404.
    for (let attempt = 0; attempt < 12; attempt++) {
      const current = await rt.volumes.list();
      if (current.every((v) => v.id !== volume.id)) {
        console.log("reclaimed");
        return;
      }
      await sleep(5000);
    }
    console.log("still listed after 60s — reclamation runs on the platform's cycle");
  } catch (err) {
    console.error(`failed: ${err instanceof Error ? err.message : err}`);
    if (volume) {
      await rt.volumes.remove(volume.id, true).catch(() => {});
    }
  } finally {
    rt.close();
  }
}

main();

#!/usr/bin/env bash
# cloud_volume_crud.sh — create, list, inspect, delete
set -euo pipefail

BOXLITE_REST_URL="${BOXLITE_REST_URL:-https://api.boxlite.ai}"
AUTH=(-H "Authorization: Bearer ${BOXLITE_API_KEY}")

# CREATE — name is optional.
VOLUME_ID=$(curl -fsS -X POST "${BOXLITE_REST_URL}/v1/volumes" "${AUTH[@]}" \
  -H 'Content-Type: application/json' \
  -d "{\"name\":\"crud-demo-$(date +%s)\"}" | jq -r .id)
echo "created  ${VOLUME_ID}"

# LIST
curl -fsS "${BOXLITE_REST_URL}/v1/volumes" "${AUTH[@]}" | jq -r '.volumes[] | "\(.id)  \(.name)  \(.state)"'

# INSPECT — state and error_reason are REST-only; the SDK does not expose them.
curl -fsS "${BOXLITE_REST_URL}/v1/volumes/${VOLUME_ID}" "${AUTH[@]}" \
  | jq '{id, name, state, error_reason}'

# DELETE — 204, and reclamation continues afterwards.
curl -fsS -X DELETE "${BOXLITE_REST_URL}/v1/volumes/${VOLUME_ID}" "${AUTH[@]}"
echo "delete accepted"

# Watch state rather than waiting for a 404.
for _ in $(seq 12); do
  STATE=$(curl -fsS "${BOXLITE_REST_URL}/v1/volumes/${VOLUME_ID}" "${AUTH[@]}" | jq -r .state 2>/dev/null || true)
  if [ -z "${STATE}" ] || [ "${STATE}" = "deleted" ]; then echo "reclaimed"; exit 0; fi
  echo "state: ${STATE}"
  sleep 5
done
echo "still present after 60s — reclamation runs on the platform's cycle"