Skip to content

restful_api.md

Latest commit

 

History

History
59 lines (47 loc) · 1.9 KB

restful_api.md

File metadata and controls

59 lines (47 loc) · 1.9 KB

Restful API

The API provides information about the current system, but also a way to interact with nodes.

Version

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.

Node API

  • Create one node
    • method: POST /api/:version/nodes
    • role: node:api:create
  • Get one node
    • method: GET /api/:version/nodes/:uuid
    • role: node:api:read
  • Alter one node
    • method: PUT /api/:version/nodes/:uuid
    • role: node:api:update
  • Delete one node
    • method: DELETE /api/:version/nodes/:uuid
    • role: node:api:delete
  • Get node revisions
    • method: GET /api/:version/nodes/:uuid/revisions
    • role: node:api:revisions
  • Get one node revision
    • method: GET /api/:version/nodes/:uuid/revisions/:rev
    • role: node:api:revision
  • Move uuid as a child of parentUuid
    • method: PUT /api/:version/nodes/move/:uuid/:parentUuid
    • role: node:api:move
  • List node (see search.md)
    • method: GET /api/:version/nodes
    • role: node:api:list
  • Basic url to return hello
    • method: GET /api/:version/hello
    • role: -
  • Notify subscribers
    • method: PUT /api/:version/notify/:name
    • role: node:api:notify
  • Websocket to retrieve update stream
    • method: WS /api/:version/nodes/stream
    • role: node:api:stream

Please note: the node:api:master role will allow any actions to be performed.

Instrospection API

  • GET /:version/handlers/node: return a list of node handlers
  • GET /:version/handlers/view: return a list of view node handlers
  • GET /:version/services: return a list of services

Security

The security is based on the guard module. Please see related documentation.