The following JSON-RPC methods are supported (try these using the AgentApi test page):
- agentCanRun(machineName, jobType, canRun)
- Updates agent can run record in DB. Pass jobType=0 and canRun=false to remove all records for the machine
- agentIsRunning(machineName, jobIds)
- Updates list of job ids this particular agent is currently executing
- agentNames()
- Returns list of agents (machines)
- agentStatus(machineName)
- Fetches agent's status from the central DB
- combinedAgentStatus()
- Fetches all agents statuses from the central DB
- numberOfRunningAgents()
- Returns number of running agents according to DB
- system.about()
- Returns a summary about the server implementation for display purposes.
- system.listMethods()
- Returns an array of method names implemented by this service.
- system.version()
- Returns the version server implementation using the major, minor, build and revision format.
- updateAgentStatus(machineName, isRunning, message, version)
- Updates agent's status in the central DB
- version()
- Returns current API version.
- whatCanAgentRun(machineName)
- Returns list of jobs the agent on given machine can run
The following method(s) of this service are marked as idempotent and therefore safe for use with HTTP GET:
- agentCanRun
- agentIsRunning
- agentNames
- agentStatus
- combinedAgentStatus
- numberOfRunningAgents
- system.about
- system.listMethods
- system.version
- updateAgentStatus
- version
- whatCanAgentRun