Provisioning requests add vApp templates and media to a a catalog. You can also use provisioning requests to copy, move, rename, download, and delete these objects.

API-URL is a URL of the form https://vcloud.example.com/api.

id is a unique identifier in the form of a UUID, as defined by RFC 4122.

Important

Request URLs are always available in Link elements contained by the representation of the object on which they operate. URL forms shown here are for reference purposes only. Although URLs have a well-known syntax and a well-understood interpretation, a client should treat vCloud API request URLs as opaque strings. The rules that govern how the server constructs these strings might change in future releases.

This summary may not cover all requests in this category. For the complete list of requests, along with detailed information about input and output types, see the Operations lists in the schema reference.

Summary of Provisioning Requests

Operation

Request

Request Body

Response

Upload OVF to a catalog create a vApp template.

POST API-URL/catalog/id/ action/upload

UploadVAppTemplateParams

CatalogItem

Enable a vApp for download.

POST API-URL/vApp/id/action/enableDownload

None

Task

Disable a vApp for download.

POST API-URL/vApp/id/action/disableDownload

None

Task

Enable a vApp template for download.

POST API-URL/vAppTemplate/ vAppTemplate-id/action/enableDownload

None

Task

Disable a vApp template for download.

POST API-URL/vAppTemplate/ vAppTemplate-id/action/disableDownload

None

204 No Content

Download a vApp or vApp template as an OVF package.

GET download-URL

None

Depends on file type.

Upload a media image to a catalog.

POST API-URL/catalog/id/action/upload

Media

Media

Move a catalog item.

POST API-URL/catalogItem/id/ action/move

CopyOrMoveCatalogItemParams

Task

Copy a catalog item.

POST API-URL/catalogItem/id/ action/copy

CopyOrMoveCatalogItemParams

Task

Synchronize a catalog with its remote source.

POST API-URL/catalog/id/ action/sync

None

Task

Synchronize a catalog item with its remote source.

POST API-URL/catalogItemid/ action/sync

None

Task

Change the name or description of a vApp template.

PUT API-URL/vAppTemplate/vappTemplate-id

VAppTemplate

Task

Change the name or description of a media image.

PUT API-URL/media/id

Media

Task

Delete a vApp template, vApp, or media image.

DELETE object-URL

None

Task

Synchronize a catalog with its external source.

POST API-URL/catalog/id/action/sync

None

Task

Synchronize a catalog item with its external source.

POST API-URL/catalogItem/id/action/sync

None

Task

Remove an item from a catalog.

DELETE API-URL/ catalog/id/catalogItem/id

None

204 No content

Control access to catalogs.

POST API-URL/catalog/id/action/controlAccess

ControlAccessParams

ControlAccessParams

Retrieve the owner of a media object.

GET API-URL/media/id/owner

None

Owner

Retrieve the owner of a vApp template.

GET API-URL/vAppTemplate/vappTemplate-id/owner

None

Owner

Retrieve the owner of a vApp.

GET API-URL/vApp/id/owner

None

Owner

Update the owner of a vApp.

PUT API-URL/vApp/id/owner

Owner

204 No Content

Create an independent disk in a VDC.

POST API-URL/vdc/id/ disk

DiskCreateParams

Disk

Retrieve properties of an independent disk.

GET API-URL/disk/id

None

Disk

Update an independent disk in a VDC.

POST API-URL/disk/id

Disk

Disk

Retrieve a list of all virtual machines attached to an independent disk.

GET API-URL/disk/id/attachedVms

None

Vms

Delete an independent disk.

DELETE API-URL/disk/id

None

Task