API Reference
All endpoints are organized by resource. Refer to the Swagger documentation to view and test request parameters, request bodies, and response schemas.
Auth
| Method | Endpoint | Description |
|---|
| POST | /api/auth/login | User login |
| POST | /api/auth/generate-key | Generate API Key |
| GET | /api/auth/logout | Logout |
| GET | /api/auth/get-token | Get Access Token |
| PUT | /api/auth/update-account | Update Account Information |
| GET | /api/auth/me | Get Current User |
| GET | /api/auth/authenticators | Get Authentication Methods |
| POST | /api/auth/login-device/check | Check Login Device |
Health Check
| Method | Endpoint | Description |
|---|
| GET | /healthCheck/ | System Health Check |
| GET | /healthCheck/redis | Redis Health |
| GET | /healthCheck/mysql | MySQL Health |
| GET | /healthCheck/storage | Storage Health |
License
| Method | Endpoint | Description |
|---|
| GET | /api/license/get-license-info | Get License Information |
Device
| Method | Endpoint | Description |
|---|
| GET | /api/device | List Devices |
| POST | /api/device/add | Connect Storage (Object Storage such as S3) |
| POST | /api/device/install | Download Installer |
| POST | /api/device/validate-device-before-install | Validate Before Installation |
| POST | /api/device/checkOutbound | Check Outbound Connectivity |
| POST | /api/device/checkConnection | Check Connection |
| POST | /api/device/invite-user-to-device | Invite User |
| POST | /api/device/share-device-by-mail | Share Device via Email |
| GET | /api/device/get-device-share-list | Get Shared Device List |
| GET | /api/device/connectivity/{deviceId} | Get Connection Status |
| GET | /api/device/{device_id}/detail | Get Device Details |
| GET | /api/device/exist-automation/{deviceId} | Check Automation Usage |
| GET | /api/device/total-file-and-size-on-path/{deviceId} | Get File Count & Size |
| GET | /api/device/hyperlink | Get Hyperlink |
| POST | /api/device/checkHyperlinkInfo | Check Hyperlink Information |
| POST | /api/device/setHyperlink | Configure Hyperlink |
| GET | /api/device/scenario-speed | Get Scenario Speed |
| GET | /api/device/get-user-path-permission | Get Path Permissions |
| GET | /api/device/{deviceId}/registered-users | List Registered Users |
| DELETE | /api/device/{deviceId}/registered-users/{userId} | Remove Registered User |
| PATCH | /api/device/restart/{deviceId} | Restart Device |
| PATCH | /api/device/updateAgent/{deviceId} | Update Agent |
| PATCH | /api/device/{device_id} | Update Device Information |
| DELETE | /api/device/{device_id} | Delete Device |
Groups
| Method | Endpoint | Description |
|---|
| GET | /api/group | List Groups |
| POST | /api/group | Create Group |
| POST | /api/group/moveDevice | Move Device |
| PATCH | /api/group/{groupId} | Update Group |
| DELETE | /api/group/{groupId} | Delete Group |
Data Set (Hot Folder)
| Method | Endpoint | Description |
|---|
| GET | /api/hot-folder | List Data Sets |
| POST | /api/hot-folder | Create Data Set |
| GET | /api/hot-folder/{id} | Get Data Set |
| PATCH | /api/hot-folder/{id} | Update Data Set |
| DELETE | /api/hot-folder/{id} | Delete Data Set |
| PUT | /api/hot-folder/group/{groupId} | Assign Group |
| DELETE | /api/hot-folder/group/{groupId} | Remove Group |
| DELETE | /api/hot-folder/delete-many | Delete Multiple Data Sets |
File Explorer
| Method | Endpoint | Description |
|---|
| POST | /api/explorer/fileSearchV1/{deviceId} | Browse Path |
| POST | /api/explorer/fileSearchV3/{deviceId} | Browse Path |
| POST | /api/explorer/createFolder/{deviceId} | Create Folder |
| POST | /api/explorer/removeFile/{deviceId} | Delete File |
| POST | /api/explorer/renameFile/{deviceId} | Rename |
| POST | /api/explorer/copyFile/{deviceId} | Copy |
| POST | /api/explorer/cutFile/{deviceId} | Move (Cut) |
| POST | /api/explorer/cancelSearch/{deviceId} | Cancel Browsing |
Transfer
| Method | Endpoint | Description |
|---|
| POST | /api/transfer | Create Transfer |
| POST | /api/transfer/manualTransfer | Create One-Time Transfer |
| GET | /api/transfer/{id}/get-files | Get Transfer File List |
| GET | /api/transfer/total-folder/{monitorId} | Get Total Folder Count |
| GET | /api/transfer/recursive-file-by-folder/{monitorId} | Get Recursive Files |
| GET | /api/transfer/{monitorId}/automation-detail | Get Automation Details |
| POST | /api/transfer/{monitorId}/replay | Replay Transfer |
| PATCH | /api/transfer/queue-priority/{monitorId} | Update Queue Priority |
| PATCH | /api/transfer/pause/{monitorId} | Pause Transfer |
| PATCH | /api/transfer/cancel/{monitorId} | Cancel Transfer |
| PATCH | /api/transfer/resume/{monitorId} | Resume Transfer |
| POST | /api/transfer/retry-failed-files | Retry Failed Files |
| POST | /api/transfer/check-queue | Check Queue |
| POST | /api/transfer/validation/path | Validate Path |
| POST | /api/transfer/scenario-speed | Get Scenario Speed |
| GET | /api/transfer/{id}/status | Get Transfer Status |
| GET | /api/transfer/{device}/status | Get Device Transfer Status |
Automation
| Method | Endpoint | Description |
|---|
| POST | /api/automation | Create Automation |
| GET | /api/automation | List Automations |
| GET | /api/automation/{automationId} | Get Automation |
| GET | /api/automation/{automationId}/details | Get Automation Details |
| PATCH | /api/automation/{automationId} | Update Automation |
| DELETE | /api/automation/{automationId} | Delete Automation |
| POST | /api/automation/checkValidDevicePath | Validate Device Path |
| GET | /api/automation/generateAutomationName | Generate Automation Name |
| GET | /api/automation/next-schedule/{automationDetailId} | Get Next Schedule |
| PATCH | /api/automation/next-schedule/{automationDetailId} | Update Next Schedule |
| POST | /api/automation/pause | Pause Automation |
Flow (Automation Component)
| Method | Endpoint | Description |
|---|
| POST | /api/automation-component | Create Flow |
| GET | /api/automation-component | List Flows |
| GET | /api/automation-component/{componentId} | Get Flow |
| GET | /api/automation-component/automation-detail/{automationDetailId} | Get by Automation Detail |
| PATCH | /api/automation-component/{componentId} | Update Flow |
| DELETE | /api/automation-component/{componentId} | Delete Flow |
Monitoring (Transfer History)
| Method | Endpoint | Description |
|---|
| GET | /api/transfer-history | List Transfer History |
| GET | /api/transfer-history/{id}/detail | Get Transfer Details |
| GET | /api/transfer-history/{id}/get-files | Get File List |
| GET | /api/transfer-history/{monitorId}/automation-detail | Get Automation Details |
| GET | /api/transfer-history/{monitorId}/files-recursive | Get Recursive File List |
| GET | /api/transfer-history/export-csv | Export CSV |
Policy & Permission
| Method | Endpoint | Description |
|---|
| GET | /api/policy-management | List Policies |
| PUT | /api/policy-management/{policyManagementId} | Update Policy |
| GET | /api/policy-management/{policyManagementId}/restricted-file | Get Restricted Files |
| GET | /api/policy-management/{policyManagementId}/user-access | Get User Access |
| POST | /api/policy-management/{policyManagementId}/user-access | Add User Access |
| PUT | /api/policy-management/{policyManagementId}/user-access | Update User Access |
| DELETE | /api/policy-management/{policyManagementId}/user-access | Remove User Access |
| GET | /api/policy-management/{policyManagementId}/user-access/search | Search User Access |
| POST | /api/permission/path | Create Path Permission |
| PATCH | /api/permission/path/{pathId} | Update Path Permission |
| PATCH | /api/permission/path/{pathId}/permission | Update Permission |
| DELETE | /api/permission/path/{pathId} | Delete Path Permission |
Security Policy
| Method | Endpoint | Description |
|---|
| GET | /api/security-policy | Get Security Policy |
| POST | /api/security-policy | Create Security Policy |
| PUT | /api/security-policy | Update Security Policy |
| POST | /api/security-policy/check-transfer-valid | Validate Transfer |
Integration
| Method | Endpoint | Description |
|---|
| GET | /api/integration | List Integrations |
| POST | /api/integration | Create Integration |
| PUT | /api/integration/{id} | Update Integration |
| DELETE | /api/integration/{id} | Delete Integration |
| GET | /api/integration/rules/{type} | Get Rules by Type |
Access History
| Method | Endpoint | Description |
|---|
| GET | /api/access-history | Get Access History |
| GET | /api/access-history/export-csv | Export CSV |
Notification
| Method | Endpoint | Description |
|---|
| GET | /api/notification | List Notifications |
User
| Method | Endpoint | Description |
|---|
| GET | /api/user/me | Get My Profile |
| GET | /api/user/get-by-workspace/{workSpaceId} | List Workspace Users |
| GET | /api/user/search-user-by-workspace/{workSpaceId} | Search Users |
| GET | /api/user/sub-user | List Sub Users |
| GET | /api/user/sub-user/{userId} | Get Sub User |
| POST | /api/user/sub-user/update-sub-user | Update Sub User |
| DELETE | /api/user/remove-sub-user | Remove Sub User |
Workspace
| Method | Endpoint | Description |
|---|
| POST | /api/workSpace | Create Workspace |
| GET | /api/workSpace/{workSpaceId} | Get Workspace |
| PUT | /api/workSpace/{workSpaceId} | Update Workspace |
| DELETE | /api/workSpace/{workSpaceId} | Delete Workspace |
| POST | /api/workSpace/user/{workSpaceId} | Add User |
| GET | /api/workSpace/switch/{workSpaceId} | Switch Workspace |
| PATCH | /api/workSpace/update-permission/{workSpaceId} | Update Permissions |
| DELETE | /api/workSpace/remove-user/{workSpaceId} | Remove User |
| PATCH | /api/workSpace/leave/{workSpaceId} | Leave Workspace |
