xor-freenet / restfreenet Goto Github PK

##Freenet Rest plugin

This plugin exposes freenet functions via a REST API.

The API is accessible under http://:/rest/

Currently the following functions are supported:

• Generation of SSK or USK key pair: GET http://{freenet host}:{freenet port}/rest/keygen/{keytype}[?filename={filename}&version={version}]

  Returns 200 response with a JSON object containing an InsertURI, requestURI pair of type {keytype} as data, or an error code with text error description on failure.

  If {filename} is provided a URI pair for inserting and requesting the specific filename is returned.

  If {filename} and {version} are provided a URI pair for inserting and requesting the specific filename and version is returned.

  e.g. GET http://localhost:8888/rest/keygen/usk?filename=hello.txt&version=3

• Insert data: POST http://{freenet host}:{freenet port}/rest/insert/{insertURI}[?priority={priority num}&realtime={0|1}

  Inserts the data sent as request content to provided insertURI.

  If priority number is provided the priority of the insert is set to that value. Defualt is 1 (Interactive).

  If realtime boolean value is provided realtime for insert is set respectively. Default is false.

  Returns 200 response with a json object containing the request URI of inserted data on success, or an error code with text error description on failure.

  e.g. POST http://localhost:8888/rest/insert/USK@GHe[...]PO/HelloWorld.txt/0?priority=1&realtime=0

Current version 0.1

Konstantinos Togias [email protected]

restFreenet is under the GPL, version 2 or later - see LICENSE.