Connect Devices
File Transfers take place between connected Devices. Connect your Devices, verify their connection status, and update the Agent when needed.
Typical onboarding flow:
Download the Installer
POST /api/device/install — Download the Agent installer
Download the Agent installer for the target operating system. Once the installed Agent connects to the server, the Device will appear in the Device list.
List Devices
GET /api/device — Retrieve all Devices
Query parameters:
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number |
size | integer | Number of results per page |
deviceGroupId | string | Device Group ID |
searchKeyword | string | Search keyword |
sort | string | Sort order (for example, field:asc) |
Response:
Check Connection Status & Device Details
| Purpose | Method · Endpoint |
|---|---|
| Check connection status | GET /api/device/connectivity/{deviceId} |
| Get Device details | GET /api/device/{device_id}/detail |
| Update Device information | PATCH /api/device/{device_id} |
| Update Agent | PATCH /api/device/updateAgent/{deviceId} |
File Management (Explorer)
Manage files and folders on a Device remotely. uuid is an identifier used to group the same Explorer session.
| Purpose | Method · Endpoint |
|---|---|
| Create folder | POST /api/explorer/createFolder/{deviceId} |
| Rename | POST /api/explorer/renameFile/{deviceId} |
| Copy | POST /api/explorer/copyFile/{deviceId} |
| Delete | POST /api/explorer/removeFile/{deviceId} |
| Move (Cut) | POST /api/explorer/cutFile/{deviceId} |
| Cancel browsing | POST /api/explorer/cancelSearch/{deviceId} |
Create Folder — POST /api/explorer/createFolder/{deviceId}
Rename — POST /api/explorer/renameFile/{deviceId}
Copy — POST /api/explorer/copyFile/{deviceId}
Delete — POST /api/explorer/removeFile/{deviceId}