Shinobu API
4 endpoints.
Get Shinobu status
Section titled “Get Shinobu status”Get the current status of the FileWatcher.
Responses
200Status
{
"is_alive": 1,
"operation": "shinobu_status",
"pid": 1608,
"success": 1
}Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Rescan filemap and restart Shinobu
Section titled “Rescan filemap and restart Shinobu”This deletes the internal map of scanned files on your system (the “filemap”) and restarts Shinobu, effectively prompting a full rescan of your FS.
Responses
200Result
{
"new_pid": 1727,
"operation": "shinobu_rescan",
"success": 1
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Restart Shinobu
Section titled “Restart Shinobu”Restart the Shinobu filewatcher
Responses
200Result
{
"new_pid": 1727,
"operation": "shinobu_restart",
"success": 1
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Stop Shinobu
Section titled “Stop Shinobu”Stops the Filewatcher. Use /api/shinobu/restart to start it again.
Responses
200Result
{
"error": "",
"operation": "",
"success": 0,
"successMessage": ""
}This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.