Moonraker API

NebulaOS Moonraker API reference

The OS-settings API that NebulaScreen - and any other Moonraker client - uses to read and change NebulaOS settings.

Source: NebulaOS-firmware at b95b156, scripts/build/overlay/usr/lib/nebulaos/moonraker/nebulaos.py. 59 endpoints, 1 notification(s).

How this fits together

NebulaScreen panel  (or any Moonraker client)
  -> Moonraker JSON-RPC   machine.nebulaos.*
  -> nebulaos.py          a Moonraker component, in Moonraker's own process
  -> /usr/libexec/nebulaos/nebulaos-osconfig
                          argv in, one JSON object out, validated, atomic
  -> nebulaos_osconfig/*.py   the helper modules that do the work

There is no second daemon. The component is composed into the Moonraker checkout by the S05nebulaos-activate boot service as an excluded symlink - the same mechanism NebulaOS uses for its Klipper extras - and is configured by a [nebulaos] section in /etc/nebulaos/moonraker/nebulaos.conf. If that file is absent, Moonraker runs without the component, and every endpoint below is simply missing. That is the difference between a printer that shows OS settings and one that does not.

Moonraker exposes each HTTP path /machine/nebulaos/x/y as the JSON-RPC method machine.nebulaos.x.y, which is how NebulaScreen addresses them.

What this reference proves, and what it does not

Established from source: that each endpoint is registered, its HTTP method, its JSON-RPC name, its handler, and which request parameters that handler reads with which defaults.

Also established, since 2026-11-03: which nebulaos-osconfig call each endpoint makes, and the keys that helper's own return statements carry - see Responses for how far that goes and where it stops.

Not established here: the values. A key is listed because a return in the helper puts it there, not because anyone saw what it contained on a printer.

No endpoint here is hardware-verified. Nothing in this reference was observed on a printer.

Responses

Every endpoint answers through the same envelope, and it is worth reading once rather than per endpoint.

The helper writes a single JSON object to stdout: {"ok": true, ...} with its own result merged in, or {"ok": false, "error": "<CODE>", "message": "..."}. The Moonraker component pops ok. On success the JSON-RPC result is the helper's object verbatim, which is why listing the helper's return keys is the same thing as listing the response keys. On failure it raises a Moonraker error "<CODE>: <message>", with the HTTP status taken from the helper's exit code:

Helper exit	What the client sees
refused	a refusal, carrying the code and message
1 or 64	HTTP 400
anything else	HTTP 500
no JSON at all	HTTP 500, nebulaos-osconfig returned no result
over the timeout	HTTP 504

Where the keys come from. They are extracted with ast by walking the chain this reference already describes - endpoint handler to its _read/_write call, the CLI dispatcher to the helper function, that function's return statements to their keys. Nothing is transcribed by hand.

Where it stops, and why that is said out loud. 9 of the 59 endpoints could not be resolved this way: some handlers build their answer in the component rather than delegating a single call, and some helpers return a value this extractor cannot read. Those say Result keys not resolved from source rather than carrying a plausible list. An invented response example is indistinguishable from a real one to the reader, which is exactly why guessing here would be worse than a gap.

A key listed on a branch - added only when some condition holds - is still listed, because the response can carry it. The list is what the endpoint may return, not what it always returns.

Example values

Three endpoints carry a table of values asserted by the repository's own tests, with the test named. That is the whole yield, and the number is the finding rather than a shortfall: tests/nebulaos-osconfig-tests.py is 4381 lines, but it mostly exercises the nebulaos_osconfig helper functions directly rather than through an endpoint, so it is not a source of per-endpoint examples at scale. A value is only attributed to an endpoint when the test calls exactly one, so it cannot land on the wrong one.

The alternative - composing plausible example responses from the key names - was available and was not taken. It would have read better and been unfalsifiable.

Recorded from a printer

Where static analysis cannot resolve an endpoint, a response recorded from a real printer is shown instead, with the capture's date, source file and the firmware it ran - and with the reason it is still current, which is always a checked statement about the helper's source rather than an assumption. Such a sample is weaker evidence than the code: it shows one answer this endpoint gave once, not every answer it can give. It is therefore never attached to an endpoint whose keys the source already settles.

Endpoints

A parameter with no default is required; the request fails without it.

`machine.nebulaos.boot_display.delete_image`


HTTP	`POST` `/machine/nebulaos/boot_display/delete_image`
JSON-RPC	`machine.nebulaos.boot_display.delete_image`
Handler	`_bd_delete_image`

Parameter	Type	Default
`filename`	string	required

Runs nebulaos-osconfig boot-display delete-image -> bootdisplay.delete_image.

Result keys: name, result.

`machine.nebulaos.boot_display.image`


HTTP	`POST` `/machine/nebulaos/boot_display/image`
JSON-RPC	`machine.nebulaos.boot_display.image`
Handler	`_bd_image`

Parameter	Type	Default
`filename`	string	required

Runs nebulaos-osconfig boot-display set-image -> bootdisplay.set_image.

Result keys not resolved from source - see Responses.

`machine.nebulaos.boot_display.images`


HTTP	`GET` `/machine/nebulaos/boot_display/images`
JSON-RPC	`machine.nebulaos.boot_display.images`
Handler	`_bd_images`

No request parameters.

Runs nebulaos-osconfig boot-display list-images -> bootdisplay.list_images, bootdisplay.status.

Result keys: cache, config, config_error, custom_active, custom_image_present, formats, images, max_dimension, max_file_bytes, modes, power_on, selected, usb, usb_present.

`machine.nebulaos.boot_display.import_usb`


HTTP	`POST` `/machine/nebulaos/boot_display/import_usb`
JSON-RPC	`machine.nebulaos.boot_display.import_usb`
Handler	`_bd_import_usb`

Parameter	Type	Default
`file`	string	required

Runs nebulaos-osconfig boot-display import-usb -> bootdisplay.import_usb.

Result keys: existing, name, result.

`machine.nebulaos.boot_display.mode`


HTTP	`POST` `/machine/nebulaos/boot_display/mode`
JSON-RPC	`machine.nebulaos.boot_display.mode`
Handler	`_bd_mode`

Parameter	Type	Default
`mode`	string	required

Runs nebulaos-osconfig boot-display set-mode -> bootdisplay.set_mode.

Result keys: applies, config, result.

`machine.nebulaos.boot_display.preview`


HTTP	`POST` `/machine/nebulaos/boot_display/preview`
JSON-RPC	`machine.nebulaos.boot_display.preview`
Handler	`_bd_preview`

Parameter	Type	Default
`filename`	string	`""`

Result keys not resolved from source - see Responses.

`machine.nebulaos.boot_display.reset_image`


HTTP	`POST` `/machine/nebulaos/boot_display/reset_image`
JSON-RPC	`machine.nebulaos.boot_display.reset_image`
Handler	`_bd_reset_image`

No request parameters.

Runs nebulaos-osconfig boot-display reset-image -> bootdisplay.reset_image.

Result keys not resolved from source - see Responses.

`machine.nebulaos.boot_display.restore_original_logo`


HTTP	`POST` `/machine/nebulaos/boot_display/restore_original_logo`
JSON-RPC	`machine.nebulaos.boot_display.restore_original_logo`
Handler	`_bd_restore_original_logo`

No request parameters.

Runs nebulaos-osconfig boot-display restore-original-logo -> bootdisplay.restore_original_logo.

Result keys not resolved from source - see Responses.

`machine.nebulaos.boot_display.status`


HTTP	`GET` `/machine/nebulaos/boot_display/status`
JSON-RPC	`machine.nebulaos.boot_display.status`
Handler	`_bd_status`

No request parameters.

Runs nebulaos-osconfig boot-display status -> bootdisplay.status.

Result keys: cache, config, config_error, custom_image_present, formats, max_dimension, max_file_bytes, modes, power_on.

`machine.nebulaos.camera.defaults`


HTTP	`POST` `/machine/nebulaos/camera/defaults`
JSON-RPC	`machine.nebulaos.camera.defaults`
Handler	`_cam_defaults`

No request parameters.

Runs nebulaos-osconfig camera defaults -> camera.defaults.

Result keys: config, reenumerated, result.

`machine.nebulaos.camera.reset`


HTTP	`POST` `/machine/nebulaos/camera/reset`
JSON-RPC	`machine.nebulaos.camera.reset`
Handler	`_cam_reset`

No request parameters.

Runs nebulaos-osconfig camera reset -> camera.reset.

Result keys: config, reenumerated, result.

`machine.nebulaos.camera.settings`


HTTP	`POST` `/machine/nebulaos/camera/settings`
JSON-RPC	`machine.nebulaos.camera.settings`
Handler	`_cam_settings`

Parameter	Type	Default
`settings`	any	`{}`

Runs nebulaos-osconfig camera set -> camera.set_settings.

Result keys: config, result.

`machine.nebulaos.camera.status`


HTTP	`GET` `/machine/nebulaos/camera/status`
JSON-RPC	`machine.nebulaos.camera.status`
Handler	`_cam_status`

No request parameters.

Runs nebulaos-osconfig camera status -> camera.status.

Result keys: config, config_error, defaults, device, firmware, ir_modes, power_line_modes, present, ranges.

`machine.nebulaos.camera.version`


HTTP	`POST` `/machine/nebulaos/camera/version`
JSON-RPC	`machine.nebulaos.camera.version`
Handler	`_cam_version`

No request parameters.

Runs nebulaos-osconfig camera version -> camera.version.

Result keys: firmware, result.

`machine.nebulaos.cleanup.creality`


HTTP	`POST` `/machine/nebulaos/cleanup/creality`
JSON-RPC	`machine.nebulaos.cleanup.creality`
Handler	`_cleanup_creality`

No request parameters.

Runs nebulaos-osconfig system cleanup-creality -> cleanup.clean_creality.

Result keys: freed_bytes, kept, removed, result.

`machine.nebulaos.cleanup.nebulaos`


HTTP	`POST` `/machine/nebulaos/cleanup/nebulaos`
JSON-RPC	`machine.nebulaos.cleanup.nebulaos`
Handler	`_cleanup_nebulaos`

No request parameters.

Runs nebulaos-osconfig system cleanup-nebulaos -> cleanup.clean_nebulaos.

Result keys: freed_bytes, result.

`machine.nebulaos.cleanup.nebulaos.plan`


HTTP	`GET` `/machine/nebulaos/cleanup/nebulaos/plan`
JSON-RPC	`machine.nebulaos.cleanup.nebulaos.plan`
Handler	`_cleanup_nebulaos_plan`

No request parameters.

Runs nebulaos-osconfig system cleanup-nebulaos-plan -> cleanup.nebulaos_plan, system.info.

Result keys: after_clean_reset, build, bytes, clean_reset_pending, hostname, items, kernel, notices, sftp, slot, storage.

`machine.nebulaos.cleanup.plan`


HTTP	`GET` `/machine/nebulaos/cleanup/plan`
JSON-RPC	`machine.nebulaos.cleanup.plan`
Handler	`_cleanup_plan`

No request parameters.

Runs nebulaos-osconfig system cleanup-plan -> cleanup.plan, system.info.

Result keys: after_clean_reset, build, bytes, clean_reset_pending, hostname, include_videos, items, kernel, notices, other_slot, sftp, slot, storage, videos_bytes.

`machine.nebulaos.display.brightness`


HTTP	`POST` `/machine/nebulaos/display/brightness`
JSON-RPC	`machine.nebulaos.display.brightness`
Handler	`_disp_brightness`

Parameter	Type	Default
`level`	int	required

Runs nebulaos-osconfig display set-brightness -> display.set_brightness.

Result keys: backlight, config, result.

`machine.nebulaos.display.sleep`


HTTP	`POST` `/machine/nebulaos/display/sleep`
JSON-RPC	`machine.nebulaos.display.sleep`
Handler	`_disp_sleep`

No request parameters.

Runs nebulaos-osconfig display sleep -> display.sleep.

Result keys: backlight, result.

`machine.nebulaos.display.status`


HTTP	`GET` `/machine/nebulaos/display/status`
JSON-RPC	`machine.nebulaos.display.status`
Handler	`_disp_status`

No request parameters.

Runs nebulaos-osconfig display status -> display.status.

Result keys: backlight, config, config_error, interface, levels.

`machine.nebulaos.display.wake`


HTTP	`POST` `/machine/nebulaos/display/wake`
JSON-RPC	`machine.nebulaos.display.wake`
Handler	`_disp_wake`

No request parameters.

Runs nebulaos-osconfig display wake -> display.wake.

Result keys: backlight, result.

`machine.nebulaos.image.ack`


HTTP	`POST` `/machine/nebulaos/image/ack`
JSON-RPC	`machine.nebulaos.image.ack`
Handler	`_image_ack`

No request parameters.

Runs nebulaos-osconfig image ack -> image.ack.

Result keys: result.

`machine.nebulaos.image.check`


HTTP	`POST` `/machine/nebulaos/image/check`
JSON-RPC	`machine.nebulaos.image.check`
Handler	`_image_check`

Parameter	Type	Default
`file`	string	required

Runs nebulaos-osconfig image check -> image.check.

Result keys: build, date, file, has_rtos, kernel, kernel_size, result, rootfs_size, sha256, size, slots, system, target, version.

`machine.nebulaos.image.install`


HTTP	`POST` `/machine/nebulaos/image/install`
JSON-RPC	`machine.nebulaos.image.install`
Handler	`_image_install`

Parameter	Type	Default
`file`	string	required
`sha256`	string	required

Runs nebulaos-osconfig image install -> image.install.

Result keys: applies, result.

`machine.nebulaos.image.list`


HTTP	`GET` `/machine/nebulaos/image/list`
JSON-RPC	`machine.nebulaos.image.list`
Handler	`_image_list`

No request parameters.

Runs nebulaos-osconfig image list -> image.list_files.

Result keys: files, slots, upload_dir, usb.

`machine.nebulaos.image.status`


HTTP	`GET` `/machine/nebulaos/image/status`
JSON-RPC	`machine.nebulaos.image.status`
Handler	`_image_status`

No request parameters.

Runs nebulaos-osconfig image status -> image.status.

Result keys: job, last, slots, trial.

`machine.nebulaos.info`


HTTP	`GET` `/machine/nebulaos/info`
JSON-RPC	`machine.nebulaos.info`
Handler	`_info`

No request parameters.

Runs nebulaos-osconfig system info -> system.info.

Result keys: after_clean_reset, build, clean_reset_pending, hostname, kernel, notices, sftp, slot, storage.

`machine.nebulaos.logs.level`


HTTP	`POST` `/machine/nebulaos/logs/level`
JSON-RPC	`machine.nebulaos.logs.level`
Handler	`_logs_level`

Parameter	Type	Default
`level`	string	required

Runs nebulaos-osconfig logs set-level -> logs.set_level.

Result keys: level, moonraker, result, system_log.

`machine.nebulaos.logs.save`


HTTP	`POST` `/machine/nebulaos/logs/save`
JSON-RPC	`machine.nebulaos.logs.save`
Handler	`_logs_save`

No request parameters.

Runs nebulaos-osconfig logs save -> logs.save_logs.

Result keys: bytes, file, files, result, safe_to_remove, usb.

`machine.nebulaos.logs.status`


HTTP	`GET` `/machine/nebulaos/logs/status`
JSON-RPC	`machine.nebulaos.logs.status`
Handler	`_logs_status`

No request parameters.

Runs nebulaos-osconfig logs status -> logs.status.

Result keys: applies_to, debug_until, level, levels, not_applicable.

`machine.nebulaos.mcu.files`


HTTP	`GET` `/machine/nebulaos/mcu/files`
JSON-RPC	`machine.nebulaos.mcu.files`
Handler	`_mcu_files`

No request parameters.

Runs nebulaos-osconfig mcu list -> mcu.list_files.

Result keys: builtin, files, upload_dir, usb.

`machine.nebulaos.mcu.flash`


HTTP	`POST` `/machine/nebulaos/mcu/flash`
JSON-RPC	`machine.nebulaos.mcu.flash`
Handler	`_mcu_flash`

Parameter	Type	Default
`file`	string	required
`sha256`	string	required

Runs nebulaos-osconfig mcu flash -> mcu.flash.

Result keys: file, kind, log, managed, native, result.

`machine.nebulaos.mcu.status`


HTTP	`GET` `/machine/nebulaos/mcu/status`
JSON-RPC	`machine.nebulaos.mcu.status`
Handler	`_mcu_status`

No request parameters.

Runs nebulaos-osconfig mcu status -> mcu.status.

Result keys: guard, last_flash, managed, upload_dir.

`machine.nebulaos.network.hostname`


HTTP	`POST` `/machine/nebulaos/network/hostname`
JSON-RPC	`machine.nebulaos.network.hostname`
Handler	`_net_hostname`

Parameter	Type	Default
`hostname`	string	required

Runs nebulaos-osconfig network set-hostname -> network.set_hostname.

Result keys: config, mdns_restart_required, result.

`machine.nebulaos.network.ipv4`


HTTP	`POST` `/machine/nebulaos/network/ipv4`
JSON-RPC	`machine.nebulaos.network.ipv4`
Handler	`_net_ipv4`

Parameter	Type	Default
`address`	string	required
`gateway`	string	required
`mode`	string	required
`prefix`	int	required

Runs nebulaos-osconfig network set-ipv4 -> network.set_ipv4.

Result keys: config, result.

`machine.nebulaos.network.status`


HTTP	`GET` `/machine/nebulaos/network/status`
JSON-RPC	`machine.nebulaos.network.status`
Handler	`_net_status`

No request parameters.

Runs nebulaos-osconfig network status -> network.status.

Result keys: boot_state, config, config_error, last_known_good, live, mdns_name, mdns_note.

`machine.nebulaos.ota.check`


HTTP	`POST` `/machine/nebulaos/ota/check`
JSON-RPC	`machine.nebulaos.ota.check`
Handler	`_ota_check`

Parameter	Type	Default
`force`	bool	`false`

Runs nebulaos-osconfig ota check -> ota.check.

Result keys not resolved from source - see Responses.

`machine.nebulaos.ota.discard`


HTTP	`POST` `/machine/nebulaos/ota/discard`
JSON-RPC	`machine.nebulaos.ota.discard`
Handler	`_ota_discard`

No request parameters.

Runs nebulaos-osconfig ota discard -> ota.discard.

Result keys: result.

`machine.nebulaos.ota.download`


HTTP	`POST` `/machine/nebulaos/ota/download`
JSON-RPC	`machine.nebulaos.ota.download`
Handler	`_ota_download`

No request parameters.

Runs nebulaos-osconfig ota download -> ota.download.

Result keys: downloaded, result.

`machine.nebulaos.ota.status`


HTTP	`GET` `/machine/nebulaos/ota/status`
JSON-RPC	`machine.nebulaos.ota.status`
Handler	`_ota_status`

No request parameters.

Runs nebulaos-osconfig ota status -> ota.status.

Result keys: channel, download, downloaded, last, running_version.

`machine.nebulaos.screen.report`


HTTP	`POST` `/machine/nebulaos/screen/report`
JSON-RPC	`machine.nebulaos.screen.report`
Handler	`_screen_report`

Parameter	Type	Default
`name`	string	required
`nebulaos_ui_api`	int	required
`version`	string	required

Result keys not resolved from source - see Responses.

From the repository's own tests:

Key	Asserted value	Test
the whole result	`{"result": "RECORDED"}`	`test_screen_report_recorded`

`machine.nebulaos.spoolman.remove`


HTTP	`POST` `/machine/nebulaos/spoolman/remove`
JSON-RPC	`machine.nebulaos.spoolman.remove`
Handler	`_sm_remove`

No request parameters.

Runs nebulaos-osconfig spoolman remove -> spoolman.remove.

Result keys: configured, host, port, restart, result, server.

`machine.nebulaos.spoolman.server`


HTTP	`POST` `/machine/nebulaos/spoolman/server`
JSON-RPC	`machine.nebulaos.spoolman.server`
Handler	`_sm_server`

Parameter	Type	Default
`host`	string	required
`port`	int	required

Runs nebulaos-osconfig spoolman set -> spoolman.set_server.

Result keys: configured, host, port, restart, result, server.

`machine.nebulaos.spoolman.status`


HTTP	`GET` `/machine/nebulaos/spoolman/status`
JSON-RPC	`machine.nebulaos.spoolman.status`
Handler	`_sm_status`

No request parameters.

Runs nebulaos-osconfig spoolman status -> spoolman.status.

Result keys: configured, host, port, server.

`machine.nebulaos.stats`


HTTP	`GET` `/machine/nebulaos/stats`
JSON-RPC	`machine.nebulaos.stats`
Handler	`_stats`

No request parameters.

Runs nebulaos-osconfig stats baseline -> stats.baseline.

Result keys: sources.

From the repository's own tests:

Key	Asserted value	Test
`lifetime.print_time`	`7200.0`	`test_stats_endpoint_reads_moonraker_history`
`nebulaos.by_status`	`{"completed": 3, "error": 1}`	`test_stats_endpoint_reads_moonraker_history`
`nebulaos.print_time`	`7200.0`	`test_stats_endpoint_reads_moonraker_history`

`machine.nebulaos.storage`


HTTP	`GET` `/machine/nebulaos/storage`
JSON-RPC	`machine.nebulaos.storage`
Handler	`_storage`

No request parameters.

Runs nebulaos-osconfig system storage -> cleanup.storage, system.info.

Result keys: after_clean_reset, at, build, clean_reset_pending, free_bytes, hostname, kernel, notices, other_slot, parts, sftp, slot, storage, total_bytes.

`machine.nebulaos.system.ack_clean_reset`


HTTP	`POST` `/machine/nebulaos/system/ack_clean_reset`
JSON-RPC	`machine.nebulaos.system.ack_clean_reset`
Handler	`_ack_clean_reset`

No request parameters.

Runs nebulaos-osconfig system ack-clean-reset -> system.ack_clean_reset.

Result keys: result.

`machine.nebulaos.system.ack_notice`


HTTP	`POST` `/machine/nebulaos/system/ack_notice`
JSON-RPC	`machine.nebulaos.system.ack_notice`
Handler	`_ack_notice`

Parameter	Type	Default
`id`	string	required

Runs nebulaos-osconfig system ack-notice -> system.ack_notice.

Result keys: id, result.

`machine.nebulaos.system.busy`


HTTP	`GET` `/machine/nebulaos/system/busy`
JSON-RPC	`machine.nebulaos.system.busy`
Handler	`_system_busy`

Parameter	Type	Default
`profile`	string	`"request"`

Runs nebulaos-osconfig system busy -> common.busy_state, system.info.

Result keys: after_clean_reset, build, busy, clean_reset_pending, hostname, kernel, klippy, message, notices, profile, reason, sftp, slot, storage.

`machine.nebulaos.system.clean_reset`


HTTP	`POST` `/machine/nebulaos/system/clean_reset`
JSON-RPC	`machine.nebulaos.system.clean_reset`
Handler	`_clean_reset`

No request parameters.

Runs nebulaos-osconfig system clean-reset -> system.request_clean_reset.

Result keys: applies, result.

`machine.nebulaos.system.notify_refused`


HTTP	`POST` `/machine/nebulaos/system/notify_refused`
JSON-RPC	`machine.nebulaos.system.notify_refused`
Handler	`_notify_refused`

Parameter	Type	Default
`message`	string	required

Result keys not resolved from source - see Responses.

From the repository's own tests:

Key	Asserted value	Test
the whole result	`{"result": "SENT"}`	`test_g98_notify_refused_console_line`

`machine.nebulaos.system.swap_slot`


HTTP	`POST` `/machine/nebulaos/system/swap_slot`
JSON-RPC	`machine.nebulaos.system.swap_slot`
Handler	`_swap_slot`

No request parameters.

Runs nebulaos-osconfig system swap-slot -> system.swap_slot.

Result keys: applies, from, next_boot, result, trial.

`machine.nebulaos.updates.check_readiness`


HTTP	`POST` `/machine/nebulaos/updates/check_readiness`
JSON-RPC	`machine.nebulaos.updates.check_readiness`
Handler	`_upd_check_readiness`

Parameter	Type	Default
`if_changed`	bool	`false`

Result keys not resolved from source - see Responses.

`machine.nebulaos.updates.readiness`


HTTP	`GET` `/machine/nebulaos/updates/readiness`
JSON-RPC	`machine.nebulaos.updates.readiness`
Handler	`_upd_readiness`

No request parameters.

Runs nebulaos-osconfig updates readiness -> updates.readiness.

Result keys not resolved from source - see Responses.

Recorded from a printer on 2026-11-04 by the foreground session, on ke-dev (_scratch/run23/api-snapshot/redacted/machine_nebulaos_updates_readiness.json, firmware ba98eec). One sample, not a schema: it shows what this printer sent once. It is current because scripts/build/overlay/usr/lib/nebulaos/python/nebulaos_osconfig/updates.py is byte-identical between ba98eec and b95b156 (git diff --quiet), so the helper that produced this response is the one documented here.

Keys in that response: apps, checked_at, checked_epoch, message, result, targets.

{
  "result": {
    "apps": {
      "klipper": {
        "detail": "",
        "helper": "cached",
        "helper_source_hash": "ba5d16812a19bbf9725860c1c841c496bfc8cca6d1b234c2073773a27d0c003c",
        "packages": "ok",
        "ready": true,
        "target": "0cee841e31d701595b3e509a0b502f6e320f52a8"
      },
      "moonraker": {
        "detail": "",
        "packages": "ok",
        "ready": true,
        "target": "985c1d0bbeb90bc057d34a232c9dc3b05e0c6c8d"
      }
    },
    "checked_at": "2026-11-04T19:26:17Z",
    "checked_epoch": 1793820377,
    "message": "The pending update can be installed.",
    "result": "READY",
    "targets": {
      "klipper": "0cee841e31d701595b3e509a0b502f6e320f52a8",
      "moonraker": "985c1d0bbeb90bc057d34a232c9dc3b05e0c6c8d"
    }
  }
}

`machine.nebulaos.wifi.connect`


HTTP	`POST` `/machine/nebulaos/wifi/connect`
JSON-RPC	`machine.nebulaos.wifi.connect`
Handler	`_wifi_connect`

Parameter	Type	Default
`hidden`	bool	`false`
`password`	string	`""`
`ssid`	string	required

Runs nebulaos-osconfig wifi connect -> wifi.connect.

Result keys: address, address_mode, address_note, address_ok, result, ssid.

`machine.nebulaos.wifi.forget`


HTTP	`POST` `/machine/nebulaos/wifi/forget`
JSON-RPC	`machine.nebulaos.wifi.forget`
Handler	`_wifi_forget`

Parameter	Type	Default
`ssid`	string	required

Runs nebulaos-osconfig wifi forget -> wifi.forget.

Result keys: removed, result, ssid.

`machine.nebulaos.wifi.scan`


HTTP	`POST` `/machine/nebulaos/wifi/scan`
JSON-RPC	`machine.nebulaos.wifi.scan`
Handler	`_wifi_scan`

No request parameters.

Runs nebulaos-osconfig wifi scan -> wifi.scan.

Result keys: complete, networks, status.

`machine.nebulaos.wifi.status`


HTTP	`GET` `/machine/nebulaos/wifi/status`
JSON-RPC	`machine.nebulaos.wifi.status`
Handler	`_wifi_status`

No request parameters.

Runs nebulaos-osconfig wifi status -> wifi.status.

Result keys: interface, saved, status.

Notifications

Published by the component over Moonraker's websocket.

nebulaos:settings_changed

🧩 NebulaOS-firmware

Home

How it works

Reference (generated)

Build and install

Project

Repository map

End-user manual
Kernel · Extensions · Screen

Moonraker API

NebulaOS Moonraker API reference

How this fits together

What this reference proves, and what it does not

Responses

Example values

Recorded from a printer

Endpoints

machine.nebulaos.boot_display.delete_image

machine.nebulaos.boot_display.image

machine.nebulaos.boot_display.images

machine.nebulaos.boot_display.import_usb

machine.nebulaos.boot_display.mode

machine.nebulaos.boot_display.preview

machine.nebulaos.boot_display.reset_image

machine.nebulaos.boot_display.restore_original_logo

machine.nebulaos.boot_display.status

machine.nebulaos.camera.defaults

machine.nebulaos.camera.reset

machine.nebulaos.camera.settings

machine.nebulaos.camera.status

machine.nebulaos.camera.version

machine.nebulaos.cleanup.creality

machine.nebulaos.cleanup.nebulaos

machine.nebulaos.cleanup.nebulaos.plan

machine.nebulaos.cleanup.plan

machine.nebulaos.display.brightness

machine.nebulaos.display.sleep

machine.nebulaos.display.status

machine.nebulaos.display.wake

machine.nebulaos.image.ack

machine.nebulaos.image.check

machine.nebulaos.image.install

machine.nebulaos.image.list

machine.nebulaos.image.status

machine.nebulaos.info

machine.nebulaos.logs.level

machine.nebulaos.logs.save

machine.nebulaos.logs.status

machine.nebulaos.mcu.files

machine.nebulaos.mcu.flash

machine.nebulaos.mcu.status

machine.nebulaos.network.hostname

machine.nebulaos.network.ipv4

machine.nebulaos.network.status

machine.nebulaos.ota.check

machine.nebulaos.ota.discard

machine.nebulaos.ota.download

machine.nebulaos.ota.status

machine.nebulaos.screen.report

machine.nebulaos.spoolman.remove

machine.nebulaos.spoolman.server

machine.nebulaos.spoolman.status

machine.nebulaos.stats

machine.nebulaos.storage

machine.nebulaos.system.ack_clean_reset

machine.nebulaos.system.ack_notice

machine.nebulaos.system.busy

machine.nebulaos.system.clean_reset

machine.nebulaos.system.notify_refused

machine.nebulaos.system.swap_slot

machine.nebulaos.updates.check_readiness

machine.nebulaos.updates.readiness

machine.nebulaos.wifi.connect

machine.nebulaos.wifi.forget

machine.nebulaos.wifi.scan

machine.nebulaos.wifi.status

Notifications

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

`machine.nebulaos.boot_display.delete_image`

`machine.nebulaos.boot_display.image`

`machine.nebulaos.boot_display.images`

`machine.nebulaos.boot_display.import_usb`

`machine.nebulaos.boot_display.mode`

`machine.nebulaos.boot_display.preview`

`machine.nebulaos.boot_display.reset_image`

`machine.nebulaos.boot_display.restore_original_logo`

`machine.nebulaos.boot_display.status`

`machine.nebulaos.camera.defaults`

`machine.nebulaos.camera.reset`

`machine.nebulaos.camera.settings`

`machine.nebulaos.camera.status`

`machine.nebulaos.camera.version`

`machine.nebulaos.cleanup.creality`

`machine.nebulaos.cleanup.nebulaos`

`machine.nebulaos.cleanup.nebulaos.plan`

`machine.nebulaos.cleanup.plan`

`machine.nebulaos.display.brightness`

`machine.nebulaos.display.sleep`

`machine.nebulaos.display.status`

`machine.nebulaos.display.wake`

`machine.nebulaos.image.ack`

`machine.nebulaos.image.check`

`machine.nebulaos.image.install`

`machine.nebulaos.image.list`

`machine.nebulaos.image.status`

`machine.nebulaos.info`

`machine.nebulaos.logs.level`

`machine.nebulaos.logs.save`

`machine.nebulaos.logs.status`

`machine.nebulaos.mcu.files`

`machine.nebulaos.mcu.flash`

`machine.nebulaos.mcu.status`

`machine.nebulaos.network.hostname`

`machine.nebulaos.network.ipv4`

`machine.nebulaos.network.status`

`machine.nebulaos.ota.check`

`machine.nebulaos.ota.discard`

`machine.nebulaos.ota.download`

`machine.nebulaos.ota.status`

`machine.nebulaos.screen.report`

`machine.nebulaos.spoolman.remove`

`machine.nebulaos.spoolman.server`

`machine.nebulaos.spoolman.status`

`machine.nebulaos.stats`

`machine.nebulaos.storage`

`machine.nebulaos.system.ack_clean_reset`

`machine.nebulaos.system.ack_notice`

`machine.nebulaos.system.busy`

`machine.nebulaos.system.clean_reset`

`machine.nebulaos.system.notify_refused`

`machine.nebulaos.system.swap_slot`

`machine.nebulaos.updates.check_readiness`

`machine.nebulaos.updates.readiness`

`machine.nebulaos.wifi.connect`

`machine.nebulaos.wifi.forget`

`machine.nebulaos.wifi.scan`

`machine.nebulaos.wifi.status`