Tools API

Endpoints under /api/tools, from the com_tools API controllers. Authenticate with an OAuth bearer token or a session cookie; see the developers book for the API basics.

Method	Endpoint	Purpose
GET	/tools/list	Method to get list of tools
GET	/tools/listAll	Method to get list of tools
GET	/tools/output	Grabs the output from a tool session
POST	/tools/run	Runs a rappture job.
GET	/tools/screenshots/{user_id}	Method to take session screenshots for user
GET	/tools/status	Gets the status of the session identified
GET	/tools/{sessionid}/fileshare	Method to setup Windows filesharing connection
GET	/tools/{sessionid}/screenshot	Method to return session screenshot
DELETE	/tools/{session}	Method to stop tool session
GET	/tools/{session}	Method to view tool session
GET	/tools/{session}/unshare	Method to disconnect from shared tool session
GET	/tools/{tool}	Method to get tool information
GET	/tools/{tool}/invoke	Method to invoke new tools session
GET	/tools/{tool}/rappturexml	Method to get the Rappture definition file for a tool
DELETE	/tools/{user_id}	Method to purge users storage
GET	/tools/{user_id}	Method to return users storage results

GET /tools/list

Method to get list of tools

API version 1.0, task list in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
user_id	integer	yes	0	Member identifier

GET /tools/listAll

Method to get list of tools

API version 1.0, task listAll in sessionsv1_0.php.

GET /tools/output

Grabs the output from a tool session

API version 1.0, task output in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
session_num	string	yes	0	a valid hub tool session number
run_file	string	yes	—	the name of the run file that contains the desired output

POST /tools/run

Runs a rappture job.

API version 1.0, task run in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
app	string	yes	—	Name of app installed as a tool in the hub
revision	string	no	default	The specific requested revision of the app
xml	string	yes	—	Content of the driver file that rappture will use to invoke the given app

GET /tools/screenshots/{user_id}

Method to take session screenshots for user

API version 1.0, task screenshots in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
user_id	integer	yes	0	Member identifier

GET /tools/status

Gets the status of the session identified

API version 1.0, task status in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
session_num	string	yes	0	a valid hub tool session number

GET /tools/{sessionid}/fileshare

Method to setup Windows filesharing connection

API version 1.0, task fileshare in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
sessionid	integer	yes	0	Tool session identifier
username	string	no	—	Username
private_ip	string	no	—	Private IP Address
public_ip	string	no	—	Public IP Address

GET /tools/{sessionid}/screenshot

Method to return session screenshot

API version 1.0, task screenshot in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
sessionid	integer	yes	0	Tool session identifier
type	string	no	png	Image format
notfound	integer	no	0	Not found

DELETE /tools/{session}

Method to stop tool session

API version 1.0, task delete in sessionsv1_0.php.

GET /tools/{session}

Method to view tool session

API version 1.0, task read in sessionsv1_0.php.

GET /tools/{session}/unshare

Method to disconnect from shared tool session

API version 1.0, task unshare in sessionsv1_0.php.

GET /tools/{tool}

Method to get tool information

API version 1.0, task info in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
tool	string	yes	—	Tool identifier
tool_version	string	yes	current	Tool version

GET /tools/{tool}/invoke

Method to invoke new tools session

API version 1.0, task invoke in sessionsv1_0.php.

GET /tools/{tool}/rappturexml

Method to get the Rappture definition file for a tool

API version 1.0, task rapptureXML in sessionsv1_0.php.

Parameter	Type	Required	Default	Description
xpath	string	no	—	Traversal selecting desired area(s) of the document

DELETE /tools/{user_id}

Method to purge users storage

API version 1.0, task purge in sessionsv1_0.php.

GET /tools/{user_id}

Method to return users storage results

API version 1.0, task storage in sessionsv1_0.php.