外部 API
外部 API により、プログラムは HTTP 呼び出しで UMS 機能にアクセスしたり、トリガーしたりすることができます。
外部 API を有効にする方法
UMS.conf を編集し、このような api_key を設定します。
api_key = secret_password
secret_password
は 12 文字以上でなければなりません。
API の説明
外部 API が有効になっている場合、/api/COMMAND への POST コールで API にアクセスできます。
フォルダスキャン
再スキャン
ご注意 | 完全なライブラリを再スキャン |
---|---|
URI | /api/folderscanner/rescan |
なし | |
ボディの例 / 説明 | このコマンドは本体の内容を必要としません |
Available since | 10.4.2 |
備考
This can be slow for large libraries
例:
curl -w "%{http_code}\n" -H "api-key: secret_password" http://localhost:5001/api/folderscanner/rescan
ファイルまたはフォルダを再スキャン
Intention | Rescans a partial subtree of the file system. |
---|---|
URI | /api/folderscanner/rescanFileOrFolder |
POST BODY | PATH_TO_SCAN |
POST BODY example / description | example: "/music/pop/Madonna". Path must be the root or a subfolder of a shared path. |
以下から利用可能: | 10.4.2 |
例
curl -d "PATH_TO_SCAN" -w "%{http_code}\n" -H "api-key: Secret_password" -X POST http://localhost:5001/api/folderscanner/rescanFileOrFolder