REresilio
Agents

Get Agent by id

Returns Agent info.

get/agents/{id}

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Path parameters

idnumber required

Agent id

Response

Successful response

idnumber required

Agent id

namestring required

Agent name

versionstring required

Agent version

deviceidstring required

Device id

groupsobject required

Array of Agent groups

groups.idnumber required

Group id

tagsobject required

Array of Agent tags

tags.namestring required

Tag name

tags.valuestring required

Tag value

onlineboolean required

True if Agent is online

uptimenumber required

Uptime in seconds reported by the Agent. 0 if Agent is offline

errorsobject required

Errors list

errors.codenumber

Error code (deprecated since 2.9.1)

errors.code_strstring required

Error string code

errors.messagestring required

Error message

errors.job_idnumber

Job id

errors.job_run_idnumber

Job run id

errors.folderidnumber

Transfer id

statusstring required

Agent status. Possible values: unlicensed - Agent doesn't have a valid license error - Agent has an error warning - Agent has a warning synced - Agent's jobs are synced inprogress - Agent has jobs in progress offline - Agent is offline paused - Agent is paused restartRequired - Agent restart is required

wan_enabledboolean required

Is WAN optimization enabled

date_addednumber required

Time when Agent was added (timestamp in seconds)

last_seennumber required

Last time Agent seen online (timestamp in seconds)

osstring required

Agent operation system

ipstring required

Agent ip-address

jobs_countnumber required

Number of jobs for the Agent

cpu_usagenumber required

CPU usage on the Agent

memory_usagenumber required

Memory usage on the Agent

up_speednumber required

Upload speed by the Agent (Bps)

down_speednumber required

Download speed by the Agent (Bps)

connectionsnumber required

Amount of current connections by the Agent

disk_usageobject required

Amount of disk space available per file system (disk)

disk_usage.pathstring required

Path to file system (disk)

disk_usage.totalnumber required

Total file system (disk) space available

disk_usage.freenumber required

Free file system (disk) space available

settingsobject required

Agent settings

settings.folder_storage_pathstring required

Path to folder storage

settings.bandwidthobject required

Bandwidth scheduler for the Agent

settings.bandwidth.upnumber required

Bandwidth scheduler upload speed limit (KBps). Unlimited value is -1

settings.bandwidth.downnumber required

Bandwidth scheduler download speed limit (KBps). Unlimited value is -1

applied_profile_idnumber required

Applied profile id

applied_schedule_idnumber required

Applied bandwidth schedule id

hostnamestring required

Hostname

os_userstring required

OS user name

driver_statusstring

Current status of the driver. Present only if installed agent supports driver.

driver_versionstring

Version of the driver. Present only if installed agent supports driver.

Changes

No recorded changes to this operation across all 1 revision of this API.