Mutation

enable_agent

Enables or disables an existing agent machine. An agent machine but be enabled in order to run scans. While disabled, it will be skipped when new scans are distributed among your pool of agent machines.

Arguments

input: EnableAgentInput!

The fields used to enable or disable an agent machine.


Input Fields

id(ID!)
The unique identifier of the agent that you want to enable or disable.
enabled(Boolean!)
Determines whether this agent is currently enabled and, therefore, can be used to run scans. While disabled, it will be skipped when new scans are distributed among your pool of agent machines.

Return Fields

agent(Agent)
The updated agent machine.

Example

Query
mutation EnableAgent($input: EnableAgentInput!) {
  enable_agent(input: $input) {
    agent {
      id
      max_concurrent_scans
      name
      enabled
    }
  }
}
Variables
{
  "input": {
    "id": "4",
    "enabled": true
  }
}