Get run Agent
Returns job run status for particular Agent.
Request
- Base URLhttps://localhost:8446/api/v2
- AuthAPI key in header Authorization
Path parameters
Job run id
Agent id
Response
Successful response
Archive size managed by Agent (bytes). Is available for Agents of version 3.5.0 and newer, otherwise is equal to 0. Except for jobs: script
Archive managed by Agent (files). Is available for Agents of version 4.0.0 and newer, otherwise is equal to 0. Except for jobs: script
Agent id
Agent name
Agent version
Applied bandwidth settings
Bandwidth down limit
Bandwidth up limit
Pure data downloaded (bytes). Is equal to 0 for followers. Except for jobs: script
Pure data uploaded (bytes). Is equal to 0 for followers. Except for jobs: script
Agent added to server time
Deduplication speed. Is equal to 0 for followers. Except for jobs: script
Agent pure data download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Download files speed. Is equal to 0 for followers. Except for jobs: script
Agent download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Download bytes percent. Is equal to 100% for followers. Except for jobs: script
Download files percent. Is equal to 100% for followers. Except for jobs: script
Agent duration for job run. Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work
List of errors
Error code (deprecated since 2.9.1)
Error string code
Error message
Transfer id
Estimated time for Agent to complete download (in seconds). Is equal to 0 for followers. Except for jobs: script
Number of completed files. Is equal to 0 for followers. Except for jobs: script
Number of files selected for download. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival
Number of files for the job. Is equal to 0 for followers. Except for jobs: script
Agent finish time for job run (in seconds). Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work
Groups count
Agent hashing speed in files per second. Is equal to 0 for followers. Except for jobs: script
Agent hashing speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Agent host name
Initial syncing state. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival. Allowed values: in progress, completed, paused
Is Agent Reference. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival
Jobs in progress count
Offline Agent last seen time for job run (0 for online Agent).
Agent last synced time (in seconds). Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival
License package name
License type
Agent ip address
Agent maximum download speed in files per second. Is equal to 0 for followers. Except for jobs: script
Agent maximum download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Agent maximum upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Does Agent need a policy update
Is Agent online
Agent os name
Agent user name
Device id
Number of connected peers. Except for jobs: script
Number of connected proxied peers. Except for jobs: script
Agent permissions for the job
Flag indicates that the agent will not propagate deletion to other nodes. Applicable for jobs: sync
Profile name
Does Agent have restricted access
Cluster group name. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script
Cluster group type. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script
Role in group. "Follower" and "Leader" roles are in High Availability groups only. Except for jobs: script
Agent scanned speed in files per second. Is equal to 0 for followers. Except for jobs: script
Deduplicated bytes. Is equal to 0 for followers. Except for jobs: script
Completed files size in bytes. Is equal to 0 for followers. Except for jobs: script
Size of selected files in bytes. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival
Agent's files size in bytes. Is equal to 0 for followers. Except for jobs: script
Agent start time for job run (in seconds). Except for jobs: sync, file_caching, hybrid_work
Job run Agent status
Total tags count on Agent
Archive size (bytes). Is equal to 0 for followers. Is available for Agents of version 3.5.0 and newer, otherwise is equal to 0. Except for jobs: script
Archive (files). Is equal to 0 for followers. Is available for Agents of version 4.0.0 and newer, otherwise is equal to 0. Except for jobs: script
Agent written data/received over network in bytes. Is equal to 0 for followers. Except for jobs: script
Amount of bytes downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script
Amount of files downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script
Amount of bytes uploaded by the Agent. Is equal to 0 for followers. Except for jobs: script
Agent pure data upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Agent upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script
Wan optimization state
Current status of the driver. Present only if installed agent supports driver.
Version of the driver. Present only if installed agent supports driver.
A property indicates that all event have been delivered. Applicable only to finished job runs except for sync, file_caching, hybrid_work
Agent's role.
Cache size limit. Only for agent with role caching_gateway
Hydrated files on agent. Only for agent with role caching_gateway
Hydrated files by file policy. Only for agent with role caching_gateway
Hydrated bytes on agent. Only for agent with role caching_gateway
Hydrated bytes by file policy. Only for agent with role caching_gateway
Pinned files on agent. Only for agent with role caching_gateway
Pinned files by file policy. Only for agent with role caching_gateway
Pinned bytes on agent. Only for agent with role caching_gateway
Pinned bytes by file policy. Only for agent with role caching_gateway
Oldest alive file access time (in seconds). Only for agent with role caching_gateway
Last time cache was filled up (in seconds). Only for agent with role caching_gateway
Excluded bytes on agent by file policy. Only for agent with role caching_gateway
Excluded files on agent by file policy. Only for agent with role caching_gateway
Redownloaded bytes. Only for agent with role caching_gateway
Redownloaded files. Only for agent with role caching_gateway
Redownloaded bytes last week. Only for agent with role caching_gateway
Redownloaded files last week. Only for agent with role caching_gateway
Changes
No recorded changes to this operation across all 1 revision of this API.