BoxGrinder REST | API

    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

    URIMethodDescriptionArgumentsReturn
    /api/appliancesGETGets list of all appliances.A list of Appliance objects is returned.
    POSTCreates new appliance.An Appliance object is returned.
    /api/appliances/:idGETShows selected appliance.
    • id – appliance id.
    An Appliance object is returned.
    DELETEDeletes appliance.
    • id – appliance id.
    An Appliance object is returned with state REMOVED.

    Image operations

    URIMethodDescriptionArgumentsReturn
    /api/imagesGETGets list of all images.A list of Image objects is returned.
    POSTCreates new base image for selected appliance.
    • appliance_id – appliance id.
    • arch – architecture (i386 or x86_64)
    An Image object is returned.
    /api/images/:idGETShows selected image.
    • id – image id.
    An Image object is returned.
    DELETEDeletes image.
    • id – image id.
    An Image object is returned with state REMOVED.
    /api/images/:id/convertPOSTConverts selected image to selected type.
      • id – image id.
      • platform – selected virtualization/cloud platform: vmware, ec2
      An Image object is returned.
      /api/images/:id/deliverPOSTDelivers image using selected delivery method.
      • id – image id.
      • type – delivery type, see delivery plugins types.
      An Image object is  returned.

      Node operations

      URIMethodDescriptionArgumentsReturn
      /api/nodesGETGets list of all nodes.A list of Node objects is returned.
      /api/nodes/:idGETShows  selected node.
      • id – node  id.
      A Node object is  returned.