Engine Daemon Admin
Engine Daemon Admin APIs provide administrative access to the Engine Daemons on a Director. 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-daemon-info | GET | Retrieves information about all the Engine Daemons logged in to the Director. |
| all-enabled | PUT | Sets whether all Engine Daemons can run Engines. |
| all-start-mode | PUT | Sets whether all the Engines have to be started manually or automatically. |
| configuration | PUT | Sets the configuration to run on the Engines. |
| configuration-by-properties | POST | Sets the configuration to run on the Engines that match the Engine Daemon Property. |
| default-properties | GET | Retrieves the names and descriptions from the default Engine Property list. |
| default-property | PUT | Creates a new default Engine Property and its description. |
| default-property | DELETE | Removes the default property. |
| directors | PUT | Sets the primary and secondary Directors for the Daemons, overriding the values in the configuration. |
| directors-by-properties | POST | Sets the Primary Director and Secondary Director for Engine Daemons that match the Engine Daemon Property. |
| enabled | PUT | Sets whether the Engine Daemon can run Engines. |
| enabled-by-properties | POST | Sets whether the Engine Daemon that matches the Engine Daemon Property can run engines. |
| engine-daemon-count | GET | Retrieves the total number of Engine Daemons logged in to the Director. |
| engine-daemon-ids | GET | Retrieves the list of Engine Daemon IDs logged in to the Director. |
| engine-daemon-info | GET | Retrieves information about the given Engine Daemon logged in to the Director. |
| engine-daemon-info-by-properties | POST | Retrieves information about all the Engine Daemons logged in to the Director that match the Engine Daemon Property. |
| instances | PUT | Sets the number of Engine instances to run, overriding the value in the configuration. |
| instances-by-properties | POST | Sets the number of Engine instances to run for Engine Daemon that match the Engine Daemon Properties. |
| log-url-list | GET | Retrieves the log file URLs from the given Engine Daemon when Engine Logging is enabled on the Server. |
| property | PUT | Sets a property on the Engine Daemon. |
| property | DELETE | Removes a property from the Engine Daemon. |
| property-by-properties | POST | Sets a property on Engine Daemons that match the Engine Daemon Properties. |
| property-by-properties | DELETE | Removes a property on Engine Daemons that match the Engine Daemon Properties. |
| purge-engine-daemons | PUT | Removes specified offline Engine Daemons. |
| purge-all-engine-daemons | PUT | Removes all the offline Engine Daemons. |
| restart-engine-daemon | PUT | Forces the Engine Daemon to log off and restart. |
| restart-engine-daemon-by-properties | POST | Forces Engine Daemons that match the Engine Daemon Properties to log out and restart. |
| selected-engine-daemon-info | POST | Retrieves information about a given Engine Daemon logged in to the Director. |
| start-mode | PUT | Sets whether the Engine Daemons have to be started manually or automatically. |
| start-mode-by-properties | POST | Sets whether the Engine Daemons have to be started manually or automatically based on the Engine Daemon Properties. |
Related information
REST API Reference
availableall-engine-daemon-infoall-enabledall-start-modeconfigurationconfiguration-by-propertiesdefault-propertiesdefault-propertydefault-propertydirectorsdirectors-by-propertiesenabledenabled-by-propertiesengine-daemon-countengine-daemon-idsengine-daemon-infoengine-daemon-info-by-propertiesinstancesinstances-by-propertieslog-url-listpropertypropertyproperty-by-propertiesproperty-by-propertiespurge-engine-daemonspurge-all-engine-daemonsrestart-engine-daemonrestart-engine-daemon-by-propertiesselected-engine-daemon-infostart-modestart-mode-by-properties