Update the docs
This commit is contained in:
parent
751b814a60
commit
1798cf7fd6
17
README.md
17
README.md
|
@ -44,13 +44,28 @@ HTTP API
|
||||||
*PUT /api/v1/machine/:id*
|
*PUT /api/v1/machine/:id*
|
||||||
|
|
||||||
Create a new machine or update an existing machine. Params:
|
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
|
- machine_spec: serialized json object describing the machine. See the 'spec' key of example/ubuntu.json
|
||||||
|
|
||||||
*DELETE /api/v1/machine/:id*
|
*DELETE /api/v1/machine/:id*
|
||||||
|
|
||||||
Delete a machine give its 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*
|
*GET /api/v1/disk/:id*
|
||||||
|
|
||||||
List all disks or a specific disk if passed
|
List all disks or a specific disk if passed
|
||||||
|
|
Loading…
Reference in New Issue