The REST APIs provide programmatic access to read and write YAKjs data. Responses are in JSON format and a status code 200 will be returned on success.
The latest major version of the API is v1.
To use the API you need to build a HTTP request using
This example uses the linux command line tool curl
to get the help
store item.
$ curl http://localhost:8790/v1/storeItems/help
For PUT
and POST
HTPP request the body shall contain a JSON object.
This example sends a POST request to add a new value to the internal store.
$ curl -X POST -H "Content-Type: application/json" -d '{"storeItem": {"key": "hello", "value": "YAKjs"}}' http://localhost:8790/v1/storeItems
Below are some pages that will help you get going with the REST APIs