Engine Admin
Engine Admin APIs provide administrative access to Engines on a Broker. They are listed in the following table.
| Method | Method Type | Description |
|---|---|---|
| available | GET | Retrieves whether the methods are available. Returns true if the method is available and false if the method is not available. |
| all-engine-info | GET | Retrieves information about all Engines logged in to the Broker. |
| busy-engine-count | GET | Retrieves the total number of Engines logged in to the Broker and are currently executing a task. |
| engine-count | GET | Retrieves the total number of Engines logged in to the Broker. |
| engine-ids | GET | Retrieves the list of Engine IDs logged in to the Broker. |
| engine-info | GET | Retrieves information about a given Engine. |
| engine-info-by-properties | POST | Retrieves information about the Engines logged in to the Broker that match the Engine Property. |
| kill-engine | PUT | Logs out a given Engine from the Broker. |
| kill-all-engines | PUT | Logs out all the Engines from the Broker. |
| log-url-list | GET | Retrieves the log file URLs on a given Engine when the Engine logging is enabled on the Server. |
| parked-engines | GET | Retrieves the list of Engine IDs that have the parked flag set to true. |
| park-engines | POST | Sets Engine's parked flag to true for passed Engine IDs. |
| selected-engine-info | POST | Retrieves information, which includes all instances for the given IDs, about the given Engines logged in to the Broker. |
| unpark-engines | POST | Sets the Engine's parked flag to false for passed Engine IDs. |