Ephemeral API

Ephemeral API

This is the final Ephemeral API documentation for 1.0

Ephemerals operate a bit differently than the standard primitives in Noah. See Using Ephemeral nodes for more detailed information.

/ephemerals/some/path/to/object

• GET: returns the value stored at the provided path with a Content Type of application/octet

  • payload: none
  • success: 200
  • failure: 404
  • error: 500

• PUT: stores the provided data at the provided path up to 512 bytes in size

  • payload: any data up to 512 bytes in size

  • success: 200

      {
        "action":"create",
        "result":"success",
        "id":"someid",
        "path":"/my/node/path",
        "data":"mydatavalue"
      }
    

  • failure: 404

  • error: 500

• POST: not supported.

• DELETE: delete the value stored at the given path as well as the path itself

  • payload: none

  • success: 200

      {
        "action":"delete",
        "result":"success",
        "id":"someid",
        "path":"/my/node/path",
      }
    

  • failure: 404

  • error: 500