API Reference

All endpoints are organized by resource. Refer to the Swagger documentation to view and test request parameters, request bodies, and response schemas. The base URL is https://app.innorix.com.

Auth

MethodEndpointDescription
POST/api/auth/api-keysGenerate API key for the authenticated user
DELETE/api/auth/api-keysRevoke an API key
POST/api/auth/loginUser login
POST/api/auth/logoutLogout user
GET/api/auth/meGet current authenticated user
PATCH/api/auth/meUpdate user account information
POST/api/auth/tokenRefresh the current session token (deprecated alias)
POST/api/auth/token/refreshRefresh the current session token

Device

MethodEndpointDescription
GET/api/devicesGet a list of devices
GET/api/devices/resolveResolve deviceId by name / IP / MAC / host
GET/api/devices/{deviceId}Get a device detail by ID
PATCH/api/devices/{deviceId}Update device information
DELETE/api/devices/{deviceId}Delete a device by ID
GET/api/devices/{deviceId}/connectivityGet status connectivity of device
GET/api/devices/{deviceId}/path-statsGet total file count and total size on a path
POST/api/devices/{deviceId}/restartRestart a device
POST/api/devices/{deviceId}/update-agentUpdate agent of device

Device Files

MethodEndpointDescription
GET/api/devices/{deviceId}/filesList a device folder (non-streaming)
POST/api/devices/{deviceId}/files/copyCopy files on a device
POST/api/devices/{deviceId}/files/deleteRemove files on a device
POST/api/devices/{deviceId}/files/foldersCreate a folder on a device
POST/api/devices/{deviceId}/files/moveMove (cut) files on a device
POST/api/devices/{deviceId}/files/renameRename a file on a device
POST/api/devices/{deviceId}/files/searchStream file or folder search results from a device
POST/api/devices/{deviceId}/files/search/cancelCancel a file search operation on a device

Device Groups

MethodEndpointDescription
GET/api/device-groupsGet all device groups

Hot Folder

MethodEndpointDescription
PATCH/api/hot-folder-groups/{groupId}Update hot folder group
DELETE/api/hot-folder-groups/{groupId}Delete hot folder group
GET/api/hot-foldersGet all hot folders
POST/api/hot-foldersCreate a new hot folder
POST/api/hot-folders/bulk-deleteDelete hot folders
GET/api/hot-folders/{hotFolderId}Get a hot folder by ID
PATCH/api/hot-folders/{hotFolderId}Update a hot folder
DELETE/api/hot-folders/{hotFolderId}Delete a hot folder

Transfer

MethodEndpointDescription
POST/api/transfers/bulk-cancelCancel multiple transfers
POST/api/transfers/manualCreate manual transfer
POST/api/transfers/validate-pathValidate transfer path
GET/api/transfers/{monitorId}/automation-detailGet transfer detail with automation data by monitorId
POST/api/transfers/{monitorId}/cancelCancel a transfer
GET/api/transfers/{monitorId}/filesGet a list of transfer files by transfer ID
POST/api/transfers/{monitorId}/pausePause a transfer
PATCH/api/transfers/{monitorId}/priorityUpdate the priority of a transfer in the queue
POST/api/transfers/{monitorId}/replayReplay a previous transfer
GET/api/transfers/{monitorId}/replay-dataGet replay configuration of a previous transfer
POST/api/transfers/{monitorId}/resumeResume a transfer
POST/api/transfers/{monitorId}/retryRetry failed transfer files
GET/api/transfers/{monitorId}/verificationGet the integrity verification result of a transfer
POST/api/transfers/{monitorId}/verificationStart integrity verification of a completed transfer

Transfer History

MethodEndpointDescription
GET/api/transfer-history/exportExport transfer history as CSV
GET/api/transfer-history/{monitorId}Get a transfer history detail by ID

Automation

MethodEndpointDescription
GET/api/automation-details/{detailId}/next-schedulesGet next schedules by automation detail
GET/api/automationsGet a list of automations
POST/api/automationsCreate Automation
GET/api/automations/{automationId}Get a automation detail by ID
PATCH/api/automations/{automationId}Update Automation
DELETE/api/automations/{automationId}Delete automation by ID
GET/api/automations/{automationId}/detailsGet automation details by automationId with transfer percent and device osType
POST/api/automations/{automationId}/pausepause automation

Automation Component

MethodEndpointDescription
POST/api/automation-componentsCreate automation component
GET/api/automation-components/{componentId}Get automation component by ID
PATCH/api/automation-components/{componentId}Update automation component
DELETE/api/automation-components/{componentId}Delete automation component
GET/api/automation-details/{detailId}/componentsGet automation component by automation detail ID

Integration

MethodEndpointDescription
GET/api/integrationsList all configured integrations
POST/api/integrationsCreate a new integration
GET/api/integrations/rules/{type}Get specific integration rule by type
PATCH/api/integrations/{integrationId}Update an integration
DELETE/api/integrations/{integrationId}Delete an integration