REST API¶
Fastr includes a webapp and a REST API. This section contains a listing of all REST paths. The full documentation is available via swagger with the paths /swagger.json for the schema or /api/doc/ for the swagger UI.
Quick reference¶
-
GET
/api/networks
¶ Get a list of the networks
-
GET
/api/tools
¶ Get a list of all Tools known to the server
-
POST
/api/runs
¶ Create a new Network run and start execution
-
GET
/api/runs
¶ Get a list of all Network runs on the server
-
GET
/api/doc/
¶ Override this method to customize the documentation page
-
GET
/swagger.json
¶ Render the Swagger specifications as JSON
-
GET
/api/tools/
(id)/
(version)¶ Get a Tool json description from the server
-
GET
/api/runs/
(id)/status
¶ Get the status of a Network Run on the server
-
GET
/api/networks/
(id)¶ Get a Network json description from the server
-
GET
/api/tools/
(id)¶ Get a Tool json description from the server
-
DELETE
/api/runs/
(id)¶ Abort a Network run and stop all associated execution
-
GET
/api/runs/
(id)¶ Get information about a Network run
-
GET
/swaggerui/
(path: filename)¶ Function used internally to send static files from the static folder to the browser.
New in version 0.5.
-
GET
/static/
(path: filename)¶ Function used internally to send static files from the static folder to the browser.
New in version 0.5.