Object

Agent

A virtual or physical machine that you have configured for use as an agent machine in Burp Suite Enterprise Edition. Agent machines are the machines on which your scans run. All new agent machines must be authorized before they can communicate with the Enterprise server and run scans.

Fields

id(): ID
The unique identifier of the agent machine.
machine_id(): ID
The unique identifier of the machine that you have configured for use as an agent machine.
current_scan_count(): Int
The number of scans that are currently running on this agent machine.
ip(): String
The IP address of the machine that is configured for use as an agent machine.
name(): String!
The name of the agent machine. This is the name that is displayed on the Burp Suite Enterprise Edition web UI.
state(): String
The health status of the agent machine, as shown on the Burp Suite Enterprise Edition web UI.
error(): AgentError
An error that has occurred on the agent machine.
enabled(): Boolean
Indicates whether this agent machine is currently enabled and, therefore, allowed to run scans. While a machine is disabled, it will be skipped when new scans are distributed among your pool of agent machines.
max_concurrent_scans(): Int
The maximum number of scans that are allowed to run on this machine at the same time.

Example

Query
query agent($id: ID!) {
   agent(id: $id) {
     id
     name
     state
     enabled
   }
}
Variables
{
  "id": "1"
}
Result
{
  "data": {
    "agent": {
      "id": "1",
      "name": "agent #1",
      "state": "LicensedState",
      "enabled": true
    }
  }
}