machineImagePublished_deploy

POST /users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys

Summary

  • Method: POST
  • Response Code: 201
  • Response Formats: application/xml application/json
  • Since: UForge 3.7.6

Deploy a new machine from an image published to a target environment.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: deployments_access

URI Parameters

  • uid (required): the user name (login name) of the user
  • itid (required): the id of the image
  • aid (required): the id of the appliance
  • pitid (required): the id of the publishImage

HTTP Request Body Parameters

A deployment object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/images/{itid}/pimages/{pitid}/deploys" -X POST \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:deployment xmlns:ns0="http://www.usharesoft.com/uforge">
        <xsi:type></xsi:type>
        <name>My Deployment</name>
        <instances>
                <instance>
                        <cores>1</cores>
                        <memory>1024</memory>
                </instance>
        </instances>
</ns0:deployment>

See also