Discover

Get Started

Developers

Industries

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:

text
1
Download Installer → Install & Register Agent → Device Appears in List → Verify Connection Status

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

bash
1
2
3
curl "https://exacoola.innorix.com/api/device?page=1&size=20" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "x-workspace-id: <WORKSPACE_ID>"

Query parameters:

ParameterTypeDescription
pageintegerPage number
sizeintegerNumber of results per page
deviceGroupIdstringDevice Group ID
searchKeywordstringSearch keyword
sortstringSort order (for example, field:asc)

Response:

json
1
2
3
4
5
6
7
8
9
10
11
{ "status_code": 200, "message": "success", "data": { "items": [ { "deviceId": "dev_a1", "name": "seoul-node-01", "os": "linux", "status": "online" }, { "deviceId": "dev_b2", "name": "hanoi-node-02", "os": "windows", "status": "offline" } ], "total": 2 } }

Check Connection Status & Device Details

PurposeMethod · Endpoint
Check connection statusGET /api/device/connectivity/{deviceId}
Get Device detailsGET /api/device/{device_id}/detail
Update Device informationPATCH /api/device/{device_id}
Update AgentPATCH /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.

PurposeMethod · Endpoint
Create folderPOST /api/explorer/createFolder/{deviceId}
RenamePOST /api/explorer/renameFile/{deviceId}
CopyPOST /api/explorer/copyFile/{deviceId}
DeletePOST /api/explorer/removeFile/{deviceId}
Move (Cut)POST /api/explorer/cutFile/{deviceId}
Cancel browsingPOST /api/explorer/cancelSearch/{deviceId}

Create FolderPOST /api/explorer/createFolder/{deviceId}

bash
1
2
3
4
5
curl -X POST https://exacoola.innorix.com/api/explorer/createFolder/dev_a1 \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "x-workspace-id: <WORKSPACE_ID>" \ -H "Content-Type: application/json" \ -d '{ "path": "/data/export/new-folder", "uuid": "" }'

RenamePOST /api/explorer/renameFile/{deviceId}

bash
1
2
3
4
5
curl -X POST https://exacoola.innorix.com/api/explorer/renameFile/dev_a1 \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "x-workspace-id: <WORKSPACE_ID>" \ -H "Content-Type: application/json" \ -d '{ "name": "report_final.csv", "path": "/data/export/report.csv", "uuid": "" }'

CopyPOST /api/explorer/copyFile/{deviceId}

bash
1
2
3
4
5
curl -X POST https://exacoola.innorix.com/api/explorer/copyFile/dev_a1 \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "x-workspace-id: <WORKSPACE_ID>" \ -H "Content-Type: application/json" \ -d '{ "path": "/data/backup", "overwrite": false, "uuid": "", "listFiles": ["/data/export/report.csv"] }'

DeletePOST /api/explorer/removeFile/{deviceId}

bash
1
2
3
4
5
curl -X POST https://exacoola.innorix.com/api/explorer/removeFile/dev_a1 \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "x-workspace-id: <WORKSPACE_ID>" \ -H "Content-Type: application/json" \ -d '{ "listFiles": ["/data/export/old.csv"], "uuid": "" }'