API

Garnish API Edpoints #

GET     /api/v1/store/:storename/*path
POST    /api/v1/store/:storename/*path
GET     /api/v1/manifest/v1/*path
POST    /api/v1/manifest/v1/*path

API Authentication #

To authenticate with token based authenticatio set the request header of X-Token to your Garnish API token.

Curl Examples #

Get a specific data record #

curl -H "X-Token: 1234567890" localhost:8080/api/v1/store/test/foo/default | jq

Publish a record #

curl -X POST \
-H 'Content-Type: application/json' \
-d '{"a": "b",  "c": "d"}' \
-H "X-Token: 1234567890" \
localhost:8080/api/v1/store/test/foo/default

Publish a raw file #

Publish localfile named test.txt to the rawdb source at the location of a/b/c/file.txt

curl -XPOST \
--data-binary "@test.txt" \
-s \
-H "X-Token: 1234567890" \
http://localhost:8080/api/v1/store/rawdb/a/b/c/file.txt