From 1798cf7fd6bd30baba5a8fd785d19af13ae71d3f Mon Sep 17 00:00:00 2001 From: dave Date: Thu, 23 Feb 2017 20:43:46 -0800 Subject: [PATCH] Update the docs --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a12d616..a5fd82c 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,28 @@ HTTP API *PUT /api/v1/machine/:id* Create a new machine or update an existing machine. Params: - - machine_id: alphanumeric name for the name + - machine_id: alphanumeric name for the machine - machine_spec: serialized json object describing the machine. See the 'spec' key of example/ubuntu.json *DELETE /api/v1/machine/:id* Delete a machine give its id +*GET /api/v1/machine/:id/property/:property* + + Get the current value of a machine's property + +*PUT /api/v1/machine/:id/property/:property* + + Create or update a machine's property. Params: + - machine_id: alphanumeric name for the name + - property: name of the property to modify or create + - value: serialized json object to set as the value + +*DELETE /api/v1/machine/:id/property/:property* + + Remove a property from a machine + *GET /api/v1/disk/:id* List all disks or a specific disk if passed