The API provides information about the current system, but also a way to interact with nodes.
The API version is part of the requested URL: /api/:version/...
, for now there is only on version v1.0
. Any
other version will generate a Bad Request
.
- Create one node
- method:
POST /api/:version/nodes
- role:
node:api:create
- method:
- Get one node
- method:
GET /api/:version/nodes/:uuid
- role:
node:api:read
- method:
- Alter one node
- method:
PUT /api/:version/nodes/:uuid
- role:
node:api:update
- method:
- Delete one node
- method:
DELETE /api/:version/nodes/:uuid
- role:
node:api:delete
- method:
- Get node revisions
- method:
GET /api/:version/nodes/:uuid/revisions
- role:
node:api:revisions
- method:
- Get one node revision
- method:
GET /api/:version/nodes/:uuid/revisions/:rev
- role:
node:api:revision
- method:
- Move
uuid
as a child ofparentUuid
- method:
PUT /api/:version/nodes/move/:uuid/:parentUuid
- role:
node:api:move
- method:
- List node (see search.md)
- method:
GET /api/:version/nodes
- role:
node:api:list
- method:
- Basic url to return hello
- method:
GET /api/:version/hello
- role:
-
- method:
- Notify subscribers
- method:
PUT /api/:version/notify/:name
- role:
node:api:notify
- method:
- Websocket to retrieve update stream
- method:
WS /api/:version/nodes/stream
- role:
node:api:stream
- method:
Please note: the node:api:master
role will allow any actions to be performed.
GET /:version/handlers/node
: return a list of node handlersGET /:version/handlers/view
: return a list of view node handlersGET /:version/services
: return a list of services
The security is based on the guard module. Please see related documentation.