---
title: "Get Agent by id"
method: GET
path: "/agents/{id}"
tags: ["Agents"]
---

# Get Agent by id

`GET /agents/{id}`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/agents/{id}`
- Auth: API key in header `Authorization`

Returns Agent info.

## Path parameters

- `id` number, required

## Response `200`

Successful response

- object
  - `id` number, required: Agent id
  - `name` string, required: Agent name
  - `version` string, required: Agent version
  - `deviceid` string, required: Device id
  - `groups` object, required: Array of Agent groups
  - `groups.id` number, required: Group id
  - `tags` object, required: Array of Agent tags
  - `tags.name` string, required: Tag name
  - `tags.value` string, required: Tag value
  - `online` boolean, required: True if Agent is online
  - `uptime` number, required: Uptime in seconds reported by the Agent. 0 if Agent is offline
  - `errors` object, required: Errors list
  - `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.job_id` number: Job id
  - `errors.job_run_id` number: Job run id
  - `errors.folderid` number: Transfer id
  - `status` string, 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_enabled` boolean, required: Is WAN optimization enabled
  - `date_added` number, required: Time when Agent was added (timestamp in seconds)
  - `last_seen` number, required: Last time Agent seen online (timestamp in seconds)
  - `os` string, required: Agent operation system
  - `ip` string, required: Agent ip-address
  - `jobs_count` number, required: Number of jobs for the Agent
  - `cpu_usage` number, required: CPU usage on the Agent
  - `memory_usage` number, required: Memory usage on the Agent
  - `up_speed` number, required: Upload speed by the Agent (Bps)
  - `down_speed` number, required: Download speed by the Agent (Bps)
  - `connections` number, required: Amount of current connections by the Agent
  - `disk_usage` object, required: Amount of disk space available per file system (disk)
  - `disk_usage.path` string, required: Path to file system (disk)
  - `disk_usage.total` number, required: Total file system (disk) space available
  - `disk_usage.free` number, required: Free file system (disk) space available
  - `settings` object, required: Agent settings
  - `settings.folder_storage_path` string, required: Path to folder storage
  - `settings.bandwidth` object, required: Bandwidth scheduler for the Agent
  - `settings.bandwidth.up` number, required: Bandwidth scheduler upload speed limit (KBps). Unlimited value is -1
  - `settings.bandwidth.down` number, required: Bandwidth scheduler download speed limit (KBps). Unlimited value is -1
  - `applied_profile_id` number, required: Applied profile id
  - `applied_schedule_id` number, required: Applied bandwidth schedule id
  - `hostname` string, required: Hostname
  - `os_user` string, required: OS user name
  - `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.

## 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)