This document describes API operations and arguments for BoxGrinder REST.
Output formats
There are several output formats:
- .yaml or HTTP Header: Accept: text/yaml
- .xml or HTTP Header: Accept: text/xml
- .json or HTTP Header: Accept: application/json
Operations
Appliance operations
URI | Method | Description | Arguments | Return |
---|
/api/appliances | GET | Gets list of all appliances. | | A list of Appliance objects is returned. |
POST | Creates new appliance. | | An Appliance object is returned. |
/api/appliances/:id | GET | Shows selected appliance. | | An Appliance object is returned. |
DELETE | Deletes appliance. | | An Appliance object is returned with state REMOVED. |
Image operations
URI | Method | Description | Arguments | Return |
---|
/api/images | GET | Gets list of all images. | | A list of Image objects is returned. |
POST | Creates new base image for selected appliance. | - appliance_id – appliance id.
- arch – architecture (i386 or x86_64)
| An Image object is returned. |
/api/images/:id | GET | Shows selected image. | | An Image object is returned. |
DELETE | Deletes image. | | An Image object is returned with state REMOVED. |
/api/images/:id/convert | POST | Converts selected image to selected type. | - id – image id.
- platform – selected virtualization/cloud platform: vmware, ec2
| An Image object is returned. |
/api/images/:id/deliver | POST | Delivers image using selected delivery method. | - id – image id.
- type – delivery type, see delivery plugins types.
| |
An Image object is returned. |
|
Node operations
URI | Method | Description | Arguments | Return |
---|
/api/nodes | GET | Gets list of all nodes. | | A list of Node objects is returned. |
/api/nodes/:id | GET | Shows selected node. | | A Node object is returned. |
Comments