VMware Cloud Director API User Operations

VMware Cloud Director API User Operations

VMware Cloud Director API User Operations

User Operations


User Operations (299)

Operation Description Since
GET
GET /apidefinition/{id} 5.1
GET /apidefinition/{id}/files Returns all file descriptors for the API definition. 5.1
GET /apidefinitions Return all API definitions.
POST /catalog/{catalogId}/action/controlAccess Update access control information for a catalog. 9.0
GET /catalog/{catalogId}/controlAccess Retrieve access control information for a catalog. 9.0
GET /catalog/{id} Retrieve a catalog. 0.9
POST /catalog/{id}/action/captureVApp Create a vApp template in this catalog from a vApp. 5.5
POST /catalog/{id}/action/copy Copy a catalog item from one catalog to another. 5.5
POST /catalog/{id}/action/move Move a catalog item from one catalog to another. 5.5
POST /catalog/{id}/action/sync Force sync the catalog to the remote subscribed catalog. 5.5
POST /catalog/{id}/action/upload Upload a vApp template to a catalog 5.5
POST /catalog/{id}/catalogItems Add an item to a catalog. 0.9
GET /catalog/{id}/metadata Retrieve all catalog metadata. 1.5
GET /catalog/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog metadata. 5.1
GET /catalog/{id}/metadata/{key} Retrieve the value of the specified key from catalog metadata. 1.5
GET /catalogItem/{id} Retrieve a catalog item. 0.9
PUT /catalogItem/{id} Modify a catalog item. 0.9
DELETE /catalogItem/{id} Delete a catalog item. 0.9
POST /catalogItem/{id}/action/sync Synchronize a catalog item with its source object. 5.5
GET /catalogItem/{id}/metadata Retrieve all metadata associated with a catalog item. 1.5
POST /catalogItem/{id}/metadata Merge the metadata provided in the request with existing catalog item metadata. 1.5
GET /catalogItem/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog item metadata. 5.1
PUT /catalogItem/{id}/metadata/{domain}/{key} Set the metadata value for the specified key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /catalogItem/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog item metadata. 5.1
GET /catalogItem/{id}/metadata/{key} Retrieve the value of the specified key from catalog item metadata. 1.5
PUT /catalogItem/{id}/metadata/{key} Set the metadata value for the specified key to the value provided, overwriting any existing value. 1.5
DELETE /catalogItem/{id}/metadata/{key} Delete the specified key and its value from catalog item metadata. 1.5
GET /catalogs/query Retrieves a list of Catalogs by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /disk/{id} Retrieve a disk. 5.1
PUT /disk/{id} Update the name, description, iops, size and storage class of a disk. 5.1
DELETE /disk/{id} Delete a disk. 5.1
POST /disk/{id}/action/moveDisk Move a disk to a different Org VDC. 36.0
GET /disk/{id}/attachedVms Retrieve a list of all VMs attached to a disk. 5.1
GET /disk/{id}/metadata Retrieve metadata associated with the disk. 5.1
POST /disk/{id}/metadata Merge the metadata provided in the request with existing metadata. 5.1
GET /disk/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from disk metadata. 5.1
PUT /disk/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
DELETE /disk/{id}/metadata/{domain}/{key} Delete the specified key and its value from disk metadata. 5.1
GET /disk/{id}/metadata/{key} Retrieve the value of the specified key from disk metadata. 5.1
PUT /disk/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
DELETE /disk/{id}/metadata/{key} Delete the specified key and its value from disk metadata. 5.1
GET /disk/{id}/owner Retrieve the owner of a disk. 5.1
PUT /disk/{id}/owner Change the owner of a disk. 5.1
GET /disks/query Retrieves a disk list by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /entity/{id} Redirects to the URL of an entity with the given VCD ID. 1.5
GET /extensibility Retrieve a list of links to API extensibility operations and entities. 5.1
GET /files Return all API definition file descriptors.
GET /media/{id} Retrieve a media object. 0.9
PUT /media/{id} Update the name and description of a media object. 0.9
DELETE /media/{id} Delete a media object. 0.9
POST /media/{id}/action/enableDownload Enable download for the media 5.5
GET /media/{id}/attachedVms Retrieve a list of all the VMs attached to the media. 38.0
GET /media/{id}/metadata Retrieve metadata associated with a media object. 1.5
POST /media/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /media/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from media object metadata. 5.1
PUT /media/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /media/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from media object metadata. 5.1
GET /media/{id}/metadata/{key} Retrieve the value of the specified key from media object metadata. 1.5
PUT /media/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /media/{id}/metadata/{key} Delete the specified key and its value from media object metadata. 1.5
GET /media/{id}/owner Retrieve the owner of a media object. 1.5
GET /mediaList/query Retrieves a media list by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /network/{id} Retrieve an organization network. 0.9
PUT /network/{id}
DELETE /network/{id}
GET /network/{id}/allocatedAddresses Retrieve a list of IP addresses allocated to the network. 5.1
GET /network/{id}/metadata Retrieve metadata associated with the network. 1.5
GET /network/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from network metadata. 5.1
GET /network/{id}/metadata/{key} Retrieve the value of the specified key from network metadata. 1.5
GET /nsxtManagers
POST /nsxtManagers
GET /nsxtManagers/{id}
PUT /nsxtManagers/{id}
DELETE /nsxtManagers/{id}
GET /org Retrieve a list of organizations accessible to you. 0.9
GET /org/{id} Retrieve an organization. 0.9
POST /org/{id}/action/instantiate Instantiates a VDC template. 5.7
POST /org/{id}/catalog/{catalogId}/action/controlAccess Update access control information for a catalog. 0.9
GET /org/{id}/catalog/{catalogId}/controlAccess Retrieve access control information for a catalog. 0.9
GET /org/{id}/metadata Retrieve metadata associated with the organization. 1.5
GET /org/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from organization metadata. 5.1
GET /org/{id}/metadata/{key} Retrieve the value of the specified key from organization metadata. 1.5
GET /org/{id}/metrics/historic Retrieve the all the metrics for a given org for the past 24 hours
POST /org/{id}/metrics/historic Retrieve the metrics for a given org based on the filters provided by the spec
GET /org/{id}/vdcRollup Retrieve the summary of usage and reserve capacity of all OrgVDCs in this org, and, if specified, any associated orgs. 30.0
GET /query REST API General queries handler 1.5
GET /schema
GET /server_status Always returns HTTP 200
GET /service Return all extension services registered with the system.
GET /service/{id} Return the Extension Service API Definition.
GET /service/{id}/apidefinitions Return all Extension Service API Definitions.
GET /session Retrieve a representation of the current session. 1.5
GET /shadowVm/{id} Retrieve a shadow VM.
DELETE /shadowVm/{id} Deletes shadow VM.
GET /site Get the {@link SiteType} that represents this local site.
PUT /site Sets the local site to match what is specified in the {@link SiteType}.
GET /site/associations Get the {@link SiteAssociationsType} for this site.
POST /site/associations Add a new {@link SiteAssociationType} for this site.
PUT /site/associations Update the site's list of associated sites PUT /api/site/associations
GET /site/associations/localAssociationData Get the {@link SiteAssociationsType} for this site.
POST /site/associations/localAssociationData/action/regenerateKeyPair Add a new {@link SiteAssociationType} for this site.
GET /site/associations/{id} Get the {@link SiteAssociationType} for the specified site id.
PUT /site/associations/{id} Adds an association for the specified site.
DELETE /site/associations/{id} Deletes the association for the specified site.
GET /task/operations Returns all task operations with their categories.
GET /task/{id} Retrieve a task. 0.9
PUT /task/{id} Update a task. 5.1
POST /task/{id}/action/cancel Cancel a task. 1.5
GET /tasksList/{id} Retrieve a list of this organization's queued, running, or recently completed tasks. 0.9
POST /tasksList/{id} Post an external task to this organization.
GET /v1.5/schema/{schemaFileName} Retrieve the specified schema definition file from the server.
GET /vApp/{id} Retrieve a vApp or VM. 0.9
PUT /vApp/{id} Modify the name or description of a VM. 0.9
DELETE /vApp/{id} Delete a vApp or VM. 0.9
POST /vApp/{id}/action/bootOptions
POST /vApp/{id}/action/changeReplicationTrackingSettings
POST /vApp/{id}/action/checkCompliance Check storage profile compliance for the specified VM. 5.1
POST /vApp/{id}/action/checkComputePolicyCompliance Check VM's compute policy compliance 33.0
POST /vApp/{id}/action/consolidate Consolidate VM snapshots. 1.5
POST /vApp/{id}/action/controlAccess Update access control information for a vApp. 0.9
POST /vApp/{id}/action/convertAllVAppVmsToStandAloneVms Convert single VM vApp to a stand alone VM. 35.0
POST /vApp/{id}/action/convertStandAloneVmToVApp Convert a stand alone VM into a single VM VApp. 35.0
POST /vApp/{id}/action/convertToReplicationTrackingVm
POST /vApp/{id}/action/createSnapshot Creates new snapshot of a virtual machine or of all the virtual machines in a vApp. 5.1
POST /vApp/{id}/action/customizeAtNextPowerOn Force guest customization on next power on. 5.6
POST /vApp/{id}/action/deploy Deploy a vApp or VM. 0.9
POST /vApp/{id}/action/disableDownload Disable a vApp for download. 5.5
POST /vApp/{id}/action/disableNestedHypervisor Hide hardware-assisted CPU virtualization from guest OS. 5.1
POST /vApp/{id}/action/discardSuspendedState Discard suspended state of a vApp or VM. 0.9
POST /vApp/{id}/action/editTrustedPlatformModule
POST /vApp/{id}/action/enableDownload Enable a vApp for download. 5.5
POST /vApp/{id}/action/enableNestedHypervisor Expose hardware-assisted CPU virtualization to guest OS. 5.1
POST /vApp/{id}/action/enterMaintenanceMode Place the vApp in maintenance mode. 1.5
POST /vApp/{id}/action/exitMaintenanceMode Take the vApp out of maintenance mode. 1.5
POST /vApp/{id}/action/failover Promote a replication tracking VM to a standard VM
POST /vApp/{id}/action/installVMwareTools Install VMware Tools on a running VM. 1.5
POST /vApp/{id}/action/reapplyComputePolicy Reapplies existing vdcComputePolicy to a VM 33.0
POST /vApp/{id}/action/recomposeVApp Recompose a vApp to add or remove VMs. 1.0
POST /vApp/{id}/action/reconfigureVm Updates Vm name, Description, and any or all of the following sections.
  • VirtualHardwareSection
  • OperatingSystemSection
  • NetworkConnectionSection
  • GuestCustomizationSection
Sections not included in the request body will not be updated.		 5.1
POST /vApp/{id}/action/reloadFromVc Reloads VM state from VC. 5.6
POST /vApp/{id}/action/removeAllSnapshots Removes all user created snapshots for a vApp or virtual machine. 5.1
POST /vApp/{id}/action/revertToCurrentSnapshot Reverts a vApp or virtual machine to the current snapshot, if any. 5.1
POST /vApp/{id}/action/undeploy Undeploy a vApp/VM. 0.9
POST /vApp/{id}/action/upgradeHardwareVersion Upgrade the virtual hardware version of a VM to the highest supported virtual hardware version of the vDC that contains it. 1.5
GET /vApp/{id}/bootOptions
GET /vApp/{id}/checkpostcustomizationscript Retrieve the flag value check_post_guest_customization. 13.0
PUT /vApp/{id}/checkpostcustomizationscript Modify the PostGC Status check of a VM. 13.0
GET /vApp/{id}/complianceResult Return the results of the most recent POST /vApp/vm-{id}/action/checkCompliance request to the specified VM. 5.1
GET /vApp/{id}/controlAccess Retrieve access control information for a vApp. 0.9
POST /vApp/{id}/disk/action/attach Attach a disk to a VM. 5.1
POST /vApp/{id}/disk/action/detach Detach a disk from a VM. 5.1
GET /vApp/{id}/guestCustomizationSection Retrieves the guest customization section of a VM. 1.0
PUT /vApp/{id}/guestCustomizationSection Updates the guest customization section of a VM. 1.0
GET /vApp/{id}/guestcustomizationstatus Retrieve status of guest customization for that VM Following are the possible status 0 - PENDING_GC : Guest Customization is either not started or in progress. 13.0
GET /vApp/{id}/leaseSettingsSection Retrieves the lease settings section of a vApp or vApp template 0.9
PUT /vApp/{id}/leaseSettingsSection Updates the lease settings section of a vApp or vApp template. 0.9
POST /vApp/{id}/media/action/ejectMedia Eject virtual media. 0.9
POST /vApp/{id}/media/action/insertMedia Insert virtual media. 0.9
GET /vApp/{id}/metadata Retrieve metadata associated with the vApp or VM. 1.5
POST /vApp/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /vApp/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vApp or VM metadata. 5.1
PUT /vApp/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 5.1
DELETE /vApp/{id}/metadata/{domain}/{key} Delete the specified key and its value from vApp or VM metadata. 5.1
GET /vApp/{id}/metadata/{key} Retrieve the value of the specified key from vApp or VM metadata. 1.5
PUT /vApp/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /vApp/{id}/metadata/{key} Delete the specified key and its value from vApp or VM metadata. 1.5
GET /vApp/{id}/metrics/current Gets the current usage for all available VM metrics.
POST /vApp/{id}/metrics/current Gets the current usage for VM metrics according to the provided spec object.
GET /vApp/{id}/metrics/historic Gets the past 24 hours worth of samples for all available VM metrics.
POST /vApp/{id}/metrics/historic Gets the historic usage for VM metrics according to the provided spec object.
GET /vApp/{id}/networkConfigSection Retrieve the network config section of a vApp or vApp template. 0.9
PUT /vApp/{id}/networkConfigSection Update the network config section of a vApp. 0.9
GET /vApp/{id}/networkConnectionSection Retrieve the network connection section of a VM. 0.9
PUT /vApp/{id}/networkConnectionSection Update the network connection section of a VM. 0.9
GET /vApp/{id}/networkSection Retrieve the network section of a vApp or vApp template. 0.9
GET /vApp/{id}/operatingSystemSection Retrieve the operating system section of a VM. 0.9
PUT /vApp/{id}/operatingSystemSection Update the operating system section of a VM. 0.9
GET /vApp/{id}/ovf Retrieve the OVF descriptor of a vApp directly. 5.1
GET /vApp/{id}/owner Retrieve the owner of a vApp. 1.5
PUT /vApp/{id}/owner Change the owner of a vApp. 1.5
POST /vApp/{id}/power/action/powerOff Power off a vApp or VM. 0.9
POST /vApp/{id}/power/action/powerOn Power on a vApp or VM. 0.9
POST /vApp/{id}/power/action/reboot Reboot a vApp or VM. 0.9
POST /vApp/{id}/power/action/reset Reset a vApp or VM. 0.9
POST /vApp/{id}/power/action/shutdown Shut down a vApp or VM. 0.9
POST /vApp/{id}/power/action/suspend Suspend a vApp or VM. 0.9
GET /vApp/{id}/productSections Retrieve a list of ProductSection elements from a vApp template, vApp, or VM. 1.5
PUT /vApp/{id}/productSections Update all ProductSection elements in a vApp template, vApp, or VM. 1.5
GET /vApp/{id}/question Retrieve a question being asked by a VM. 0.9
POST /vApp/{id}/question/action/answer Answer a question being asked by a VM. 0.9
GET /vApp/{id}/runtimeInfoSection Retrieve the runtime info section of a VM. 1.5
GET /vApp/{id}/screen Retrieves a thumbnail image of a VM console. 0.9
POST /vApp/{id}/screen/action/acquireMksTicket Retrieve a mks ticket that you can use to gain access to the console of a running VM. 5.5
POST /vApp/{id}/screen/action/acquireTicket Retrieve a screen ticket that you can use with the VMRC browser plug-in to gain access to the console of a running VM. 0.9
GET /vApp/{id}/snapshotSection Retrieve SnapshotSection element for a vApp or VM. 5.1
GET /vApp/{id}/startupSection Retrieve the startup section of a vApp. 0.9
PUT /vApp/{id}/startupSection Update the startup section of a vApp. 0.9
GET /vApp/{id}/trustedPlatformModule
GET /vApp/{id}/virtualHardwareSection Retrieve the virtual hardware section of a VM. 0.9
PUT /vApp/{id}/virtualHardwareSection Update the virtual hardware section of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/cpu Retrieve the RASD item that specifies CPU properties of a VM. 0.9
PUT /vApp/{id}/virtualHardwareSection/cpu Update the RASD item that specifies CPU properties of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/disks Retrieve all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
PUT /vApp/{id}/virtualHardwareSection/disks Update all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/media Retrieve all RASD items that specify CD-ROM, DVD, and floppy disk device and controller properties of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/memory Retrieve the RASD item that specifies memory properties of a VM. 0.9
PUT /vApp/{id}/virtualHardwareSection/memory Update the RASD item that specifies memory properties of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/networkCards Retrieve all RASD items that specify network card properties of a VM. 0.9
PUT /vApp/{id}/virtualHardwareSection/networkCards Update all RASD items that specify network card properties of a VM. 0.9
GET /vApp/{id}/virtualHardwareSection/serialPorts Retrieve all RASD items that specify serial port properties of a VM. 1.5
PUT /vApp/{id}/virtualHardwareSection/serialPorts Modifies all RASD items that specify serial port properties of a VM. 1.5
GET /vApp/{id}/vmCapabilities Gets {@link VmCapabilitiesType} for the VM identified by id.
PUT /vApp/{id}/vmCapabilities Updates VM's {@link VmCapabilities}
GET /vAppTemplate/{id} Retrieve a vApp template. 0.9
PUT /vAppTemplate/{id} Update the name, description and gold master of a vApp template. 0.9
DELETE /vAppTemplate/{id} Delete a vApp template. 0.9
POST /vAppTemplate/{id}/action/consolidate Consolidate VM snapshots. 1.5
POST /vAppTemplate/{id}/action/disableDownload Disable a vApp template for download. 0.9
POST /vAppTemplate/{id}/action/enableDownload Enable a vApp template for download 0.9
GET /vAppTemplate/{id}/customizationSection Retrieve the customization section of a vApp template. 1.0
GET /vAppTemplate/{id}/guestCustomizationSection Retrieves the guest customization section of a VM. 1.0
PUT /vAppTemplate/{id}/guestCustomizationSection Updates the guest customization section of a VM. 1.0
GET /vAppTemplate/{id}/leaseSettingsSection Retrieves the lease settings section of a vApp or vApp template 0.9
PUT /vAppTemplate/{id}/leaseSettingsSection Updates the lease settings section of a vApp or vApp template. 0.9
GET /vAppTemplate/{id}/metadata Retrieve metadata associated with the vApp template or VM. 1.5
POST /vAppTemplate/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /vAppTemplate/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from vApp template or VM metadata. 5.1
PUT /vAppTemplate/{id}/metadata/{domain}/{key} Set the value for the specified metadata key in the specified domain to the value provided, overwriting any existing value. 5.1
DELETE /vAppTemplate/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from vApp template or VM metadata. 5.1
GET /vAppTemplate/{id}/metadata/{key} Retrieve the value of the specified key from vApp template or VM metadata. 1.5
PUT /vAppTemplate/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /vAppTemplate/{id}/metadata/{key} Delete the specified key and its value from vApp template or VM metadata. 1.5
GET /vAppTemplate/{id}/networkConfigSection Retrieve the network config section of a vApp or vApp template. 0.9
PUT /vAppTemplate/{id}/networkConfigSection Update the network config section of a vApp. 0.9
GET /vAppTemplate/{id}/networkConnectionSection Retrieve the network connection section of a VM. 0.9
PUT /vAppTemplate/{id}/networkConnectionSection Update the network connection section of a VM. 0.9
GET /vAppTemplate/{id}/networkSection Retrieve the network section of a vApp or vApp template. 0.9
GET /vAppTemplate/{id}/ovf Retrieve the OVF descriptor of a vApp template. 0.9
GET /vAppTemplate/{id}/owner Retrieve the owner of a vApp template. 1.5
PUT /vAppTemplate/{id}/owner Change the owner of a vApp Template. 31.0
GET /vAppTemplate/{id}/productSections Retrieve a list of ProductSection elements from a vApp template, vApp, or VM. 1.5
PUT /vAppTemplate/{id}/productSections Update all ProductSection elements in a vApp template, vApp, or VM. 1.5
GET /vAppTemplate/{id}/shadowVms Retrieve a list of shadow VMs associated with the specified vApp template. 1.5
GET /vAppTemplate/{id}/virtualHardwareSection Retrieve the virtual hardware section of a VM. 0.9
PUT /vAppTemplate/{id}/virtualHardwareSection Update the virtual hardware section of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/cpu Retrieve the RASD item that specifies CPU properties of a VM. 0.9
PUT /vAppTemplate/{id}/virtualHardwareSection/cpu Update the RASD item that specifies CPU properties of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/disks Retrieve all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
PUT /vAppTemplate/{id}/virtualHardwareSection/disks Update all RASD items that specify hard disk and hard disk controller properties of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/media Retrieve all RASD items that specify CD-ROM, DVD, and floppy disk device and controller properties of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/memory Retrieve the RASD item that specifies memory properties of a VM. 0.9
PUT /vAppTemplate/{id}/virtualHardwareSection/memory Update the RASD item that specifies memory properties of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/networkCards Retrieve all RASD items that specify network card properties of a VM. 0.9
PUT /vAppTemplate/{id}/virtualHardwareSection/networkCards Update all RASD items that specify network card properties of a VM. 0.9
GET /vAppTemplate/{id}/virtualHardwareSection/serialPorts Retrieve all RASD items that specify serial port properties of a VM. 1.5
PUT /vAppTemplate/{id}/virtualHardwareSection/serialPorts Modifies all RASD items that specify serial port properties of a VM. 1.5
GET /vAppTemplates/query Retrieves a list of vAppTemplates using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /vApps/query Retrieves a list of vApps by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /vdc/{id} Retrieve a vDC. 0.9
PUT /vdc/{id} Modify the name and/or description of an organization vDC. 5.7
DELETE /vdc/{id} Delete an organization vDC. 5.7
POST /vdc/{id}/action/captureVApp Create a vApp template from a vApp. 0.9
POST /vdc/{id}/action/cloneMedia Create a copy of a media object. 0.9
POST /vdc/{id}/action/cloneVApp Create a copy of a vApp. 0.9
POST /vdc/{id}/action/cloneVAppTemplate Create a copy of a vApp template. 0.9
POST /vdc/{id}/action/composeVApp Compose a vApp from existing virtual machines. 0.9
PUT /vdc/{id}/action/controlAccess Update access control information for a VDC.
POST /vdc/{id}/action/createVm Create a standalone blank VM and nest it under a new auto-nature vApp. 32.0
POST /vdc/{id}/action/instantiateOvf Instantiate a vApp or VM from an OVF 5.5
POST /vdc/{id}/action/instantiateVAppTemplate Create a vApp from a vApp template 0.9
POST /vdc/{id}/action/instantiateVmFromTemplate Create a auto natured vApp from a VM template. 32.0
POST /vdc/{id}/action/moveVApp
GET /vdc/{id}/controlAccess Retrieve access control information for a VDC.
POST /vdc/{id}/disk Create a disk. 5.1
GET /vdc/{id}/metadata Retrieve metadata associated with a vDC. 1.5
GET /vdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from vDC metadata. 5.1
GET /vdc/{id}/metadata/{key} Retrieve the value of the specified key from vDC metadata. 1.5
GET /vdc/{id}/metrics/historic Retrieves the past 24h rolled up metrics for a VDC
POST /vdc/{id}/metrics/historic Retrieves rolled up metrics for a VDC according to the spec
GET /vdc/{id}/vmAffinityRules Retrieves a list of all VM Affinity rules within a given vDC.
POST /vdc/{id}/vmAffinityRules Creates a new VM affinity rule.This operation is asynchronous and returns a task that you can monitor to track the progress of the request.
GET /vdc/{id}/vmAffinityRules/{ruleId} Retrieves the specified VM affinity rule
PUT /vdc/{id}/vmAffinityRules/{ruleId} Updates the specified VM affinity/anti-affinity rule.
DELETE /vdc/{id}/vmAffinityRules/{ruleId} Deletes the specified VM affinity/anti-affinity rule
GET /vdc/{vdcId}/computePolicies Get all vDC compute policies references in given vDC
GET /vdc/{vdcId}/hwv/{hwVersionId} Retrieve a Virtual Hardware Version. 31.0
GET /vdcStorageProfile/{id} Returns storage class referred by the Id.
POST /vdcStorageProfile/{id}/action/makeDefault
GET /vdcStorageProfile/{id}/metadata Retrieve metadata associated with the vDC storage profile.
GET /vdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vDC storage profile metadata.
GET /vdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from vDC storage profile metadata.
GET /vdcTemplate/{id} Retrieve a vDC template. 5.7
GET /versions Retrieve a list of vCloud API versions supported by this system. 1.5
GET /versions/schema/versions.xsd Unauthenticated GET of versions.xsd schema definition file.
GET /vmGroup/name/{groupName}
GET /vmGroups
POST /vmGroups
GET /vms/query Retrieves a list of VMs in lease by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5