Runs

Get run Agent

Returns job run status for particular Agent.

get/runs/{id}/agents/{agent_id}

Request

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

Path parameters

idnumber required

Job run id

agent_idnumber required

Agent id

Response

Successful response

agent_archive_sizenumber

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

agent_archive_filesnumber

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_idnumber required

Agent id

agent_namestring required

Agent name

agent_versionstring required

Agent version

bandwidthobject

Applied bandwidth settings

bandwidth.downnumber

Bandwidth down limit

bandwidth.upnumber

Bandwidth up limit

data_transferred_downnumber

Pure data downloaded (bytes). Is equal to 0 for followers. Except for jobs: script

data_transferred_upnumber

Pure data uploaded (bytes). Is equal to 0 for followers. Except for jobs: script

date_addednumber

Agent added to server time

deduplication_speednumber

Deduplication speed. Is equal to 0 for followers. Except for jobs: script

down_data_speednumber

Agent pure data download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

down_files_per_secondnumber

Download files speed. Is equal to 0 for followers. Except for jobs: script

down_speednumber

Agent download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

download_bytes_percentnumber

Download bytes percent. Is equal to 100% for followers. Except for jobs: script

download_files_percentnumber

Download files percent. Is equal to 100% for followers. Except for jobs: script

durationnumber

Agent duration for job run. Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work

errorsobject required

List of errors

errors.codenumber

Error code (deprecated since 2.9.1)

errors.code_strstring required

Error string code

errors.messagestring required

Error message

errors.folderidnumber

Transfer id

etanumber

Estimated time for Agent to complete download (in seconds). Is equal to 0 for followers. Except for jobs: script

files_completednumber

Number of completed files. Is equal to 0 for followers. Except for jobs: script

files_selectednumber

Number of files selected for download. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival

files_totalnumber

Number of files for the job. Is equal to 0 for followers. Except for jobs: script

finish_timenumber

Agent finish time for job run (in seconds). Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work

groups_countnumber

Groups count

hashed_files_speednumber

Agent hashing speed in files per second. Is equal to 0 for followers. Except for jobs: script

hashed_speednumber

Agent hashing speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

hostnamestring required

Agent host name

initial_syncingstring

Initial syncing state. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival. Allowed values: in progress, completed, paused

is_referenceboolean

Is Agent Reference. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival

jobs_in_progressnumber

Jobs in progress count

last_seennumber required

Offline Agent last seen time for job run (0 for online Agent).

last_syncednumber

Agent last synced time (in seconds). Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival

license_packagestring

License package name

license_typenumber

License type

locationstring required

Agent ip address

max_down_files_per_secondnumber

Agent maximum download speed in files per second. Is equal to 0 for followers. Except for jobs: script

max_down_speednumber

Agent maximum download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

max_up_speednumber

Agent maximum upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

needs_updateboolean

Does Agent need a policy update

onlineboolean required

Is Agent online

osstring required

Agent os name

os_userstring required

Agent user name

peer_idstring

Device id

peers_countnumber

Number of connected peers. Except for jobs: script

peers_count_proxiednumber

Number of connected proxied peers. Except for jobs: script

permissionstring required

Agent permissions for the job

non_deletingboolean

Flag indicates that the agent will not propagate deletion to other nodes. Applicable for jobs: sync

profile_namestring

Profile name

restricted_accessboolean

Does Agent have restricted access

cluster_namestring

Cluster group name. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script

cluster_typestring

Cluster group type. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script

role_in_clusterstring

Role in group. "Follower" and "Leader" roles are in High Availability groups only. Except for jobs: script

scanned_files_speednumber

Agent scanned speed in files per second. Is equal to 0 for followers. Except for jobs: script

size_deduplicatednumber

Deduplicated bytes. Is equal to 0 for followers. Except for jobs: script

size_completednumber

Completed files size in bytes. Is equal to 0 for followers. Except for jobs: script

size_selectednumber

Size of selected files in bytes. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival

size_totalnumber

Agent's files size in bytes. Is equal to 0 for followers. Except for jobs: script

start_timenumber

Agent start time for job run (in seconds). Except for jobs: sync, file_caching, hybrid_work

statusstring required

Job run Agent status

tags_countnumber required

Total tags count on Agent

total_archive_sizenumber

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

total_archive_filesnumber

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

traffic_optimization_in_bytesnumber

Agent written data/received over network in bytes. Is equal to 0 for followers. Except for jobs: script

transferred_downnumber

Amount of bytes downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script

transferred_files_downnumber

Amount of files downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script

transferred_upnumber

Amount of bytes uploaded by the Agent. Is equal to 0 for followers. Except for jobs: script

up_data_speednumber

Agent pure data upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

up_speednumber

Agent upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script

wan_optimizationboolean

Wan optimization state

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.

event_logs_completeboolean

A property indicates that all event have been delivered. Applicable only to finished job runs except for sync, file_caching, hybrid_work

rolestring required

Agent's role.

cache_size_limitnumber

Cache size limit. Only for agent with role caching_gateway

hydrated_filesnumber

Hydrated files on agent. Only for agent with role caching_gateway

hydrated_files_totalnumber

Hydrated files by file policy. Only for agent with role caching_gateway

hydrated_bytesnumber

Hydrated bytes on agent. Only for agent with role caching_gateway

hydrated_bytes_totalnumber

Hydrated bytes by file policy. Only for agent with role caching_gateway

pinned_filesnumber

Pinned files on agent. Only for agent with role caching_gateway

pinned_files_totalnumber

Pinned files by file policy. Only for agent with role caching_gateway

pinned_bytesnumber

Pinned bytes on agent. Only for agent with role caching_gateway

pinned_bytes_totalnumber

Pinned bytes by file policy. Only for agent with role caching_gateway

oldest_alive_file_access_timenumber

Oldest alive file access time (in seconds). Only for agent with role caching_gateway

cache_filled_up_last_timenumber

Last time cache was filled up (in seconds). Only for agent with role caching_gateway

excluded_bytesnumber

Excluded bytes on agent by file policy. Only for agent with role caching_gateway

excluded_filesnumber

Excluded files on agent by file policy. Only for agent with role caching_gateway

redownloaded_bytesnumber

Redownloaded bytes. Only for agent with role caching_gateway

redownloaded_filesnumber

Redownloaded files. Only for agent with role caching_gateway

redownloaded_bytes_last_weeknumber

Redownloaded bytes last week. Only for agent with role caching_gateway

redownloaded_files_last_weeknumber

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.