Confirmed users
133
edits
Security/Projects/Minion/PluginService: Difference between revisions
Jump to navigation
Jump to search
Security/Projects/Minion/PluginService (view source)
Revision as of 13:30, 23 October 2012
, 23 October 2012→API
(→API) |
(→API) |
||
| Line 15: | Line 15: | ||
==API== | ==API== | ||
This is at a very early stage, so is still fairly fluid. | This is at a very early stage, so is still fairly fluid. | ||
{| border="1" cellpadding="1" | {| border="1" cellpadding="1" | ||
|- | |- | ||
| Line 29: | Line 30: | ||
| PUT || /session/create/<plugin_name> || create_session(plugin_name) || Create a session with the specified plugin || {'message': "Created new session for plugin 'TemplatePlugin'", 'session': '8db4b299106ea496c862ab3dff710155'} | | PUT || /session/create/<plugin_name> || create_session(plugin_name) || Create a session with the specified plugin || {'message': "Created new session for plugin 'TemplatePlugin'", 'session': '8db4b299106ea496c862ab3dff710155'} | ||
|- | |- | ||
| PUT || /session/<session>/value?key=<key>&value=<value | | PUT || /session/<session>/value?key=<key>&value=<value> || set_session_value(session, key, value) || Sets a session value || None | ||
|- | |- | ||
| DELETE || /session/<session> || terminate_session(session) || Terminates the specified session | | DELETE || /session/<session> || terminate_session(session) || Terminates the specified session || {'message': 'Session terminated', 'session': '9ba4c151b3f20690390e39bc3c3b98ae'} | ||
|- | |- | ||
| GET || /session/<session>/ | | GET || /session/<session>/status || get_session_status(session) || Get the status of the specified session || {'status': 'PENDING', 'message': 'Plugin is pending execution.', 'success': True} | ||
|- | |- | ||
| GET || /session/<session>/ | | GET || /session/<session>/states || get_session_states(session) || Returns the valid states the specified session can be set to || ['START'] | ||
|- | |- | ||
| | | POST ||"/session/<session>/state/<state> || set_session_states(session, state) || Sets the session state - used for starting, stopping etc || {'status': 'RUNNING', 'message': 'Plugin started: Execution is in progress.', 'success': True} | ||
|- | |- | ||
| GET || /session/<session>/results || get_session_results(session) || Returns the session results (which can be incomplete) | {'issues': [ <issues - defn TBA> ]} | |||
| GET || /session/<session>/results | |||
|} | |} | ||