Shinobu API

Shinobu Filewatcher APIs.

🔑 Get Shinobu status

get

Get the current status of the FileWatcher.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Status

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

is_aliveinteger · enumOptionalPossible values:

pidintegerOptional

Current PID of the Watcher process

get/shinobu

HTTPcURLJavaScriptPython

GET /api/shinobu HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Status

{
  "success": 1,
  "is_alive": 1,
  "operation": "shinobu_status",
  "pid": 1608
}

🔑 Stop Shinobu

post

Stops the Filewatcher. Use /api/shinobu/restart to start it again.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Result

application/json

operationstringRequired

Name of operation

errorstringOptional

Error message if any

successMessagestringOptional

Success message if any

successinteger · enumRequired

Returns 1 if operation was successful, else 0

Possible values:

post/shinobu/stop

HTTPcURLJavaScriptPython

POST /api/shinobu/stop HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Result

{
  "operation": "text",
  "error": "text",
  "successMessage": "text",
  "success": 0
}

🔑 Restart Shinobu

post

Restart the Shinobu filewatcher

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Result

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

new_pidintegerOptional

PID of the new Watcher process.

post/shinobu/restart

HTTPcURLJavaScriptPython

POST /api/shinobu/restart HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Result

{
  "operation": "shinobu_restart",
  "success": 1,
  "new_pid": 1727
}

🔑 Rescan filemap and restart Shinobu

post

This deletes the internal map of scanned files on your system (the "filemap") and restarts Shinobu, effectively prompting a full rescan of your FS.

Authorizations

api_key

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Responses

200

Result

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

new_pidintegerOptional

PID of the new Watcher process.

post/shinobu/rescan

HTTPcURLJavaScriptPython

POST /api/shinobu/rescan HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Result

{
  "operation": "shinobu_rescan",
  "success": 1,
  "new_pid": 1727
}