Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 1.9 KB

scanPublishedImage_deploy.rst

File metadata and controls

73 lines (52 loc) · 1.9 KB
Raw

scanPublishedImage_deploy

POST /users/{uid}/scannedinstances/{siid}/scans/{sid}/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
  • siid (required): the id of the scannedinstance-object
  • itid (required): the id of the image-object
  • pitid (required): the id of the publishimage-object
  • sid (required): the id of the scan-object

HTTP Request Body Parameters

A deployment-object object

Example Request

curl "https://uforge.example.com/api/users/{uid}/scannedinstances/{siid}/scans/{sid}/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>
  • deployment-object
  • image-object
  • machinescan-api-resources
  • machinescaninstance-api-resources
  • publishimage-object
  • scan-object
  • scanImage-generate
  • scannedinstance-object
  • user-object