getBrokerMinions

Description

Retrieves the list of active minions currently connected to the Master.

Remarks

Minions are worker threads that are capable of performing a single task at a time. For a single connected worker module, there may be many minion connections, depending on licensing.

Note: Some minions may include additional information when they register, which is visible in the reply.

Example

Request

{}

Reply

{
  "minions" : [
    {
      "MinionID" : "minion-broker4099D",
      "version" : "1.33.7"
    },
    {
      "MinionID" : "minion-persist5391A",
      "version" : "1.33.7"
    },
    {
      "MinionID" : "minion-someRandomMinion7AJ12",
      "version" : "1.33.7",
      "additional" : {
        "happiness" : "very"
      }
    }
  ]
}

Request Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object"
}

Reply Schema

{
  "$schema":"http://json-schema.org/draft-04/schema#",
  "type":"object",
  "required":[
    "minions"
  ],
  "properties":{
    "minions":{
      "type":"array",
      "items":{
        "type":"object",
        "required":[
          "MinionID",
          "version"
        ],
        "properties":{
          "MinionID":{
            "type":"string",
            "minLength":1
          },
          "version":{
            "type":"string"
          },
          "additional":{
            "type":"object"
          }
        }
      }
    }
  }
}