Mutation

rename_agent

Updates the name for an existing agent machine.

Arguments

input: RenameAgentInput!

The fields used to specify which agent machine you want to rename and the new name that you want to assign.


Input Fields

id(ID!)
The unique identifier of the agent machine that you want to rename.
name(String!)
The new name for the agent machine. This is the name that is displayed in the Burp Suite Enterprise Edition web UI.

Return Fields

agent(Agent)
The updated agent machine.

Example

Query
mutation RenameAgent($input: RenameAgentInput!) {
  rename_agent(input: $input) {
    agent {
      id
      max_concurrent_scans
      name
      enabled
    }
  }
}
Variables
{
  "input": {
    "id": "4",
    "name": "Agent 007"
  }
}