Confirmed users
133
edits
(→API) |
(→API) |
||
Line 17: | Line 17: | ||
{| border="1" cellpadding="1" | {| border="1" cellpadding="1" | ||
|- | |- | ||
! Op !! URL !! Method !! Notes | ! Op !! URL !! Method !! Notes || Example response | ||
|- | |- | ||
| GET || /info || get_info || Get info about the PluginService (name/host and version) | | GET || /info || get_info || Get info about the PluginService (name/host and version) || {'version': 1, 'name': '127.0.0.1'} | ||
|- | |- | ||
| GET || /plugins | | GET || /plugins || get_plugins || List all of the Get info about the PluginService (name/host and version) || {'plugins': [{'version': 1, 'type': 'WebApp', 'plugin': 'TemplatePlugin'}]} | ||
|- | |- | ||
| GET || /plugin/<plugin_name>/template || get_plugin_template(plugin_name) || Get the plugin template (which defines what params it needs/supports) | | GET || /plugin/<plugin_name>/template || get_plugin_template(plugin_name) || Get the plugin template (which defines what params it needs/supports) || {'template': {'target': {'type': 'url', 'required': True, 'is_list': True}}, 'safechecks': {'type': 'bool', 'value': True}} | ||
|- | |- | ||
| GET || /sessions || get_sessions() || Returns a list of all of the current sessions | | GET || /sessions || get_sessions() || Returns a list of all of the current sessions || {'sessions': {'8db4b299106ea496c862ab3dff710155': {'status': {'status': 'PENDING', 'message': 'Plugin is pending execution.', 'success': True}, 'plugin_name': 'TemplatePlugin'}}} | ||
|- | |- | ||
| PUT || /session/create/<plugin_name> || create_session(plugin_name) || Create a session with the specified plugin | | 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> <b>TODO</b> || | | PUT || /session/<session>/value?key=<key>&value=<value> <b>TODO</b> || set_session_value(session, key, value) || Sets a session value | ||
|- | |- | ||
| DELETE || /session/<session> || terminate_session(session) || Terminates the specified session | | DELETE || /session/<session> || terminate_session(session) || Terminates the specified session |