Skip to content

Latest commit

 

History

History
88 lines (67 loc) · 2.42 KB

machineImagePublished_deploy.rst

File metadata and controls

88 lines (67 loc) · 2.42 KB
Raw

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-object
  • itid (required): the id of the image-object
  • aid (required): the id of the appliance-object
  • pitid (required): the id of the publishimage-object

HTTP Request Body Parameters

A deployment-object 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>
  • appliance-object
  • applianceImage-publish
  • deployment-object
  • machineImageGeneration-cancel
  • machineImagePublish-cancel
  • machineImagePublishedStatus-get
  • machineImagePublishedStatus-getAll
  • machineImagePublished-delete
  • machineImagePublished-deleteAll
  • machineImagePublished-deploy
  • machineImagePublished-download
  • machineImagePublished-get
  • machineImagePublished-getAll
  • machineImageStatus-get
  • machineImageStatus-getAll
  • machineImage-delete
  • machineImage-deleteAll
  • machineImage-download
  • machineImage-downloadFile
  • machineImage-generate
  • machineImage-get
  • machineImage-getAll
  • machineImage-publish
  • machineImage-regenerate
  • publishimage-object