Get general Spoolman API information (version, database type, debug mode, paths).

Check whether the Spoolman instance is healthy and reachable.

Trigger a database backup on the Spoolman instance (SQLite only). Returns the backup file path.

List and search vendors in Spoolman. Supports filtering by name and pagination.

Get a single vendor by its ID.

Create a new vendor in Spoolman.

Update an existing vendor by ID. Only provide the fields you want to change.

Delete a vendor by ID. This will cascade to associated filaments.

List and search filaments in Spoolman. Supports filtering by vendor, material, color, article number and more.

Get a single filament by its ID.

Create a new filament definition in Spoolman. Density and diameter are required.

Update an existing filament by ID. Only provide the fields you want to change.

Delete a filament by ID.

List and search spools in Spoolman. Filter by filament, vendor, material, location, lot number and more.

Get a single spool by its ID, including remaining weight and usage stats.

Create a new spool in Spoolman. A filament_id is required. Specify either remaining_weight or used_weight (not both).

Update an existing spool by ID. Only provide the fields you want to change. remaining_weight and used_weight are mutually exclusive.

Delete a spool by ID.

Log filament consumption for a spool. Provide either use_length (mm) or use_weight (g), not both.

Update a spool's remaining filament by providing a current weight measurement (spool + filament together in grams).

Retrieve all Spoolman configuration settings.

Retrieve a single Spoolman configuration setting by key.

Set a Spoolman configuration value by key.

List all custom extra fields defined for a given entity type (vendor, filament, or spool).

Add or update a custom extra field for a given entity type.

Remove a custom extra field from an entity type.

List all filament material types that exist in Spoolman (e.g. PLA, PETG, ABS).

List all article numbers of filaments currently tracked in Spoolman.

List all lot/batch numbers of spools currently tracked in Spoolman.

List all spool storage locations defined in Spoolman.

Rename an existing spool storage location. All spools at the old location will be updated to the new name.

Export all spools from Spoolman as JSON or CSV.

Export all filaments from Spoolman as JSON or CSV.

Export all vendors from Spoolman as JSON or CSV.