---
title: Agents
summary: Agents allows you to list and retrieve Next-Gen WAF agents deployed in a workspace.
url: https://www.fastly.com/documentation/reference/api/ngwaf/agents
---

Agents allows you to list and retrieve Next-Gen WAF agents deployed in a workspace.

## Data model

| Field | Type | Description |
|-------|------|-------------|
| `agent_active` | boolean | Whether the agent was seen in the past 5 minutes. |
| `agent_args` | string | Command-line arguments the agent was started with. |
| `agent_build_id` | string | Commit SHA of the current agent build. |
| `agent_cgroup` | string | Control group of the agent process. |
| `agent_connections_dropped_count` | integer | Number of connections dropped by the agent. |
| `agent_connections_open_count` | integer | Gauge of simultaneous open connections. |
| `agent_connections_total_count` | integer | Total number of connections handled by the agent. |
| `agent_current_requests` | integer | Number of requests processed in the last reporting interval. |
| `agent_decision_time_50th` | number | Agent decision time in milliseconds at the 50th percentile. |
| `agent_decision_time_95th` | number | Agent decision time in milliseconds at the 95th percentile. |
| `agent_decision_time_99th` | number | Agent decision time in milliseconds at the 99th percentile. |
| `agent_enabled` | boolean | Whether the agent is enabled. |
| `agent_id` | string | Unique ID of the agent. |
| `agent_last_rule_updated_at` | string | Timestamp of last rules update in RFC 3339 format. |
| `agent_last_seen_at` | string | Timestamp when the agent last reported in. |
| `agent_latency_time_50th` | number | Latency time at the 50th percentile in milliseconds. |
| `agent_latency_time_95th` | number | Latency time at the 95th percentile in milliseconds. |
| `agent_latency_time_99th` | number | Latency time at the 99th percentile in milliseconds. |
| `agent_max_procs` | integer | GOMAXPROCS setting for the agent process. |
| `agent_name` | string | Display name of the agent. |
| `agent_pid` | integer | Process ID of the agent. |
| `agent_read_bytes` | integer | Total bytes read by the agent. |
| `agent_rule_update_count` | integer | Counter of rule updates received by the agent. |
| `agent_status` | string | Current status of the agent. |
| `agent_timestamp` | string | The agent's current UTC time. |
| `agent_timezone` | string | Timezone of the agent's host. |
| `agent_timezone_offset` | integer | Timezone offset of the agent's host in seconds. |
| `agent_upload_metadata_failure_count` | integer | Number of consecutive failures sending data to the Fastly platform. |
| `agent_upload_size` | integer | Byte size of the last message uploaded to the Fastly platform. |
| `agent_uptime` | integer | Agent uptime in seconds. |
| `agent_version` | string | Version of the agent software. |
| `agent_versions_behind` | integer | Number of agent releases published since the installed version. |
| `agent_write_bytes` | integer | Total bytes written by the agent. |
| `host_agent_cpu` | number | CPU usage percentage of the agent process on the host. |
| `host_clock_skew` | integer | Number of milliseconds the host clock differs from known correct time. |
| `host_cpu` | number | CPU usage percentage of the host machine. |
| `host_os` | string | Operating system of the agent's host. |
| `host_remote_ip` | string | IP address of the agent's host. |
| `module_detected` | boolean | Whether a web server module has been detected. |
| `module_server` | string | Server software detected by the module. |
| `module_type` | string | Type of the web server module. |
| `module_version` | string | Version of the web server module. |
| `module_versions_behind` | integer | Number of module releases published since the installed version. |
| `runtime_gc_pause_millis` | number | Cumulative garbage collection pause time in milliseconds. |
| `runtime_memory_bytes_used` | integer | Memory consumed by the agent in bytes. |
| `runtime_num_gc` | integer | Counter of garbage collections performed. |
| `runtime_num_goroutines` | integer | Current number of goroutines in the agent process. |

## API endpoints

### List agents

**GET** `/ngwaf/v1/workspaces/{workspace_id}/agents`

List all agents deployed in a workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `workspace_id` | string | path | Yes | The ID of the workspace. |

### Get an agent

**GET** `/ngwaf/v1/workspaces/{workspace_id}/agents/{agent_id}`

Retrieve a specific agent deployed in a workspace.

**Parameters:**

| Name | Type | In | Required | Description |
|------|------|----|---------|--------------|
| `agent_id` | string | path | Yes | The ID of the agent. |
| `workspace_id` | string | path | Yes | The ID of the workspace. |

