--- title: "Get run Agent" method: GET path: "/runs/{id}/agents/{agent_id}" tags: ["Runs"] --- # Get run Agent `GET /runs/{id}/agents/{agent_id}` ## Request - Base URL: `https://localhost:8446/api/v2` - URL: `https://localhost:8446/api/v2/runs/{id}/agents/{agent_id}` - Auth: API key in header `Authorization` Returns job run status for particular Agent. ## Path parameters - `id` number, required - `agent_id` number, required ## Response `200` Successful response - object - `agent_archive_size` number: 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_files` number: 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` number, required: Agent id - `agent_name` string, required: Agent name - `agent_version` string, required: Agent version - `bandwidth` object: Applied bandwidth settings - `bandwidth.down` number: Bandwidth down limit - `bandwidth.up` number: Bandwidth up limit - `data_transferred_down` number: Pure data downloaded (bytes). Is equal to 0 for followers. Except for jobs: script - `data_transferred_up` number: Pure data uploaded (bytes). Is equal to 0 for followers. Except for jobs: script - `date_added` number: Agent added to server time - `deduplication_speed` number: Deduplication speed. Is equal to 0 for followers. Except for jobs: script - `down_data_speed` number: Agent pure data download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `down_files_per_second` number: Download files speed. Is equal to 0 for followers. Except for jobs: script - `down_speed` number: Agent download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `download_bytes_percent` number: Download bytes percent. Is equal to 100% for followers. Except for jobs: script - `download_files_percent` number: Download files percent. Is equal to 100% for followers. Except for jobs: script - `duration` number: Agent duration for job run. Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work - `errors` object, required: List of errors - `errors.code` number: Error code (deprecated since 2.9.1) - `errors.code_str` string, required: Error string code - `errors.message` string, required: Error message - `errors.folderid` number: Transfer id - `eta` number: Estimated time for Agent to complete download (in seconds). Is equal to 0 for followers. Except for jobs: script - `files_completed` number: Number of completed files. Is equal to 0 for followers. Except for jobs: script - `files_selected` number: Number of files selected for download. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival - `files_total` number: Number of files for the job. Is equal to 0 for followers. Except for jobs: script - `finish_time` number: Agent finish time for job run (in seconds). Is equal to 0 for followers. Except for jobs: sync, file_caching, hybrid_work - `groups_count` number: Groups count - `hashed_files_speed` number: Agent hashing speed in files per second. Is equal to 0 for followers. Except for jobs: script - `hashed_speed` number: Agent hashing speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `hostname` string, required: Agent host name - `initial_syncing` string: Initial syncing state. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival. Allowed values: in progress, completed, paused - `is_reference` boolean: Is Agent Reference. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival - `jobs_in_progress` number: Jobs in progress count - `last_seen` number, required: Offline Agent last seen time for job run (0 for online Agent). - `last_synced` number: Agent last synced time (in seconds). Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival - `license_package` string: License package name - `license_type` number: License type - `location` string, required: Agent ip address - `max_down_files_per_second` number: Agent maximum download speed in files per second. Is equal to 0 for followers. Except for jobs: script - `max_down_speed` number: Agent maximum download speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `max_up_speed` number: Agent maximum upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `needs_update` boolean: Does Agent need a policy update - `online` boolean, required: Is Agent online - `os` string, required: Agent os name - `os_user` string, required: Agent user name - `peer_id` string: Device id - `peers_count` number: Number of connected peers. Except for jobs: script - `peers_count_proxied` number: Number of connected proxied peers. Except for jobs: script - `permission` string, required: Agent permissions for the job - `non_deleting` boolean: Flag indicates that the agent will not propagate deletion to other nodes. Applicable for jobs: sync - `profile_name` string: Profile name - `restricted_access` boolean: Does Agent have restricted access - `cluster_name` string: Cluster group name. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script - `cluster_type` string: Cluster group type. Will be returned in case Agent is in High Availability or Gateway Scaleout group. Except for jobs: script - `role_in_cluster` string: Role in group. "Follower" and "Leader" roles are in High Availability groups only. Except for jobs: script - `scanned_files_speed` number: Agent scanned speed in files per second. Is equal to 0 for followers. Except for jobs: script - `size_deduplicated` number: Deduplicated bytes. Is equal to 0 for followers. Except for jobs: script - `size_completed` number: Completed files size in bytes. Is equal to 0 for followers. Except for jobs: script - `size_selected` number: Size of selected files in bytes. Is equal to 0 for followers. Except for jobs: distribution, script, consolidation, storage_tiering_and_archival - `size_total` number: Agent's files size in bytes. Is equal to 0 for followers. Except for jobs: script - `start_time` number: Agent start time for job run (in seconds). Except for jobs: sync, file_caching, hybrid_work - `status` string, required: Job run Agent status - `tags_count` number, required: Total tags count on Agent - `total_archive_size` number: 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_files` number: 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_bytes` number: Agent written data/received over network in bytes. Is equal to 0 for followers. Except for jobs: script - `transferred_down` number: Amount of bytes downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script - `transferred_files_down` number: Amount of files downloaded by the Agent. Is equal to 0 for followers. Except for jobs: script - `transferred_up` number: Amount of bytes uploaded by the Agent. Is equal to 0 for followers. Except for jobs: script - `up_data_speed` number: Agent pure data upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `up_speed` number: Agent upload speed in bytes per second. Is equal to 0 for followers. Except for jobs: script - `wan_optimization` boolean: Wan optimization state - `driver_status` string: Current status of the driver. Present only if installed agent supports driver. - `driver_version` string: Version of the driver. Present only if installed agent supports driver. - `event_logs_complete` boolean: A property indicates that all event have been delivered. Applicable only to finished job runs except for sync, file_caching, hybrid_work - `role` string, required: Agent's role. - `cache_size_limit` number: Cache size limit. Only for agent with role caching_gateway - `hydrated_files` number: Hydrated files on agent. Only for agent with role caching_gateway - `hydrated_files_total` number: Hydrated files by file policy. Only for agent with role caching_gateway - `hydrated_bytes` number: Hydrated bytes on agent. Only for agent with role caching_gateway - `hydrated_bytes_total` number: Hydrated bytes by file policy. Only for agent with role caching_gateway - `pinned_files` number: Pinned files on agent. Only for agent with role caching_gateway - `pinned_files_total` number: Pinned files by file policy. Only for agent with role caching_gateway - `pinned_bytes` number: Pinned bytes on agent. Only for agent with role caching_gateway - `pinned_bytes_total` number: Pinned bytes by file policy. Only for agent with role caching_gateway - `oldest_alive_file_access_time` number: Oldest alive file access time (in seconds). Only for agent with role caching_gateway - `cache_filled_up_last_time` number: Last time cache was filled up (in seconds). Only for agent with role caching_gateway - `excluded_bytes` number: Excluded bytes on agent by file policy. Only for agent with role caching_gateway - `excluded_files` number: Excluded files on agent by file policy. Only for agent with role caching_gateway - `redownloaded_bytes` number: Redownloaded bytes. Only for agent with role caching_gateway - `redownloaded_files` number: Redownloaded files. Only for agent with role caching_gateway - `redownloaded_bytes_last_week` number: Redownloaded bytes last week. Only for agent with role caching_gateway - `redownloaded_files_last_week` number: Redownloaded files last week. Only for agent with role caching_gateway ## Other responses - `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned. --- [API](https://skmtc.dev/resilio/apis/resilio-api.md) - [All operations](https://skmtc.dev/resilio/apis/resilio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/resilio/apis/resilio-api/revisions/ca39130a395e?raw)