vCloud API Operations

Operations


Operations (757)

Operation Description Since
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, and storage class of a disk. 5.1
DELETE /disk/{id} Delete a disk. 5.1
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 /hwv/{id} Retrieve a Virtual Hardware Version. 29.0
GET /login Login with HTTP GET request. 0.9
POST /login Login with HTTP POST request. 0.9
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}/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 /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
DELETE /session Delete the current session. 1.5
POST /sessions Log in and create a Session object. 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 /supportedSystemsInfo List operating systems available for use on virtual machines owned by this organization. 5.1
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/checkCompliance Check storage profile compliance for the specified VM. 5.1
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/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/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/installVMwareTools Install VMware Tools on a running VM. 1.5
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/relocate Relocate a VM to a different datastore. 1.5
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}/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
POST /vAppTemplate/{id}/action/relocate Relocate a VM to a different datastore. 1.5
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/uploadVAppTemplate Upload an OVF package to create a vApp template 0.9
GET /vdc/{id}/controlAccess Retrieve access control information for a VDC.
POST /vdc/{id}/disk Create a disk. 5.1
POST /vdc/{id}/media Upload a media image 0.9
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.
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 /vdcTemplates Retrieve a list of vDC templates accessible to you. 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
GET /admin/ Retrieve an administrative view of a cloud. 0.9
POST /admin/catalog/probeRemoteLibrary Test the library subscription settings to make sure the remote endpoint exists, the password matches (if set), and the SSL certificate is trusted (if necessary). 31.0
GET /admin/catalog/{id} Retrieve a catalog. 0.9
PUT /admin/catalog/{id} Update the name or description of a catalog. 0.9
DELETE /admin/catalog/{id} Delete a catalog.
POST /admin/catalog/{id}/action/publish Publish a catalog. 1.0
POST /admin/catalog/{id}/action/publishToExternalOrganizations Publish a catalog to external orgs. 5.5
POST /admin/catalog/{id}/action/subscribeToExternalCatalog Subscribe to an external catalog. 5.5
GET /admin/catalog/{id}/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/catalog/{id}/extension Creates a Selector Extension. 16.0
GET /admin/catalog/{id}/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/catalog/{id}/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/catalog/{id}/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/catalog/{id}/metadata Retrieve metadata associated with the catalog. 1.5
POST /admin/catalog/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/catalog/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from catalog metadata. 5.1
PUT /admin/catalog/{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 /admin/catalog/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from catalog metadata. 5.1
GET /admin/catalog/{id}/metadata/{key} Retrieve the value of the specified key from catalog metadata. 1.5
PUT /admin/catalog/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/catalog/{id}/metadata/{key} Delete the specified key and its value from catalog metadata. 1.5
GET /admin/catalog/{id}/owner Retrieve the owner of a catalog. 1.5
PUT /admin/catalog/{id}/owner Update the owner of a catalog. 1.5
GET /admin/catalogs/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/catalogs/extension Creates a Selector Extension. 16.0
GET /admin/catalogs/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/catalogs/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/catalogs/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/edgeGateway/{id} Retrieve an edge gateway 5.1
PUT /admin/edgeGateway/{id} Update an edge gateway 5.1
DELETE /admin/edgeGateway/{id} Delete an edge gateway. 5.1
POST /admin/edgeGateway/{id}/action/configureServices Update edgeGateway configuration. 5.1
POST /admin/edgeGateway/{id}/action/configureSyslogServerSettings Configure Syslog server settings for the org vdc edge gateway 5.11
POST /admin/edgeGateway/{id}/action/convertToAdvancedGateway Mark a gateway as an advanced gateway. 27.0
POST /admin/edgeGateway/{id}/action/disableDistributedRouting Disable distributed routing for a gateway 29.0
POST /admin/edgeGateway/{id}/action/enableDistributedRouting Enable distributed routing for a gateway 29.0
POST /admin/edgeGateway/{id}/action/modifyFormFactor Modify edgeGateway form factor. 11.0
POST /admin/edgeGateway/{id}/action/reapplyServices Reapply services on an edgeGateway. 5.1
POST /admin/edgeGateway/{id}/action/redeploy Redeploy edgeGateway. 5.1
POST /admin/edgeGateway/{id}/action/syncSyslogServerSettings Synchronize syslog server settings on an edgeGateway. 5.1
PUT /admin/edgeGateway/{id}/action/updateProperties Endpoint for just updating gateway properties by themselves.
POST /admin/edgeGateway/{id}/action/upgradeConfig Upgrades the edge gateway appliance size. 5.1
GET /admin/event/{id} Returns event with specified ID. 5.6
GET /admin/group/{id} Retrieve a group. 0.9
PUT /admin/group/{id} Update the name or description of a group. 0.9
DELETE /admin/group/{id} Deletes a group. 0.9
GET /admin/groups/query Retrieves a list of groups for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/network/{id} Retrieve an administrative view of a network. 0.9
PUT /admin/network/{id} Update an organization network. 5.1
DELETE /admin/network/{id} Delete a network. 0.9
POST /admin/network/{id}/action/convertToDistributedInterface Convert org vdc network to a distributed interface

This operation is valid for internal org vdc routed networks that are subinterfaces or internal.

29.0
POST /admin/network/{id}/action/convertToInternalInterface Convert org vdc network to an interface

This operation is valid for internal org vdc routed networks that are subinterfaces

27.0
POST /admin/network/{id}/action/convertToSubInterface Convert org vdc network to an sub interface

This operation is valid for internal org vdc routed networks

27.0
POST /admin/network/{id}/action/reset Reset networking services on a network. 1.5
POST /admin/network/{id}/action/syncSyslogServerSettings Synchronize syslog server settings for a network. 1.5
GET /admin/network/{id}/allocatedAddresses Retrieve the list of IP addresses allocated to the network. 5.1
GET /admin/network/{id}/metadata Retrieve metadata associated with the network. 1.5
POST /admin/network/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/network/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from network metadata. 5.1
PUT /admin/network/{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 /admin/network/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from network metadata. 5.1
GET /admin/network/{id}/metadata/{key} Retrieve the value of the specified key from network metadata. 1.5
PUT /admin/network/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/network/{id}/metadata/{key} Delete the specified key and its value from network metadata. 1.5
GET /admin/org/{id} Retrieve an administrative view of an organization. 0.9
PUT /admin/org/{id} Update an organization. 0.9
DELETE /admin/org/{id} Delete an organization. 0.9
POST /admin/org/{id}/action/disable Disable an organization. 1.0
POST /admin/org/{id}/action/enable Enable an organization. 1.0
GET /admin/org/{id}/associations Retrieves the complete list of Organizations associated with this organization 29.0
POST /admin/org/{id}/associations Adds a new member to this organization's associations 29.0
PUT /admin/org/{id}/associations Replaces the organization's current list of association members with the specified list of members

If the list is empty, all existing members will be deleted.

29.0
GET /admin/org/{id}/associations/localAssociationData Gets the associaiton data for a given local org.
POST /admin/org/{id}/associations/localAssociationData/action/regenerateKeyPair Regenerates an org's key pair for associations
GET /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} Retrieves a specific member from the organization's associations as identified by identifier included in the request 29.0
PUT /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} Update an organization association 29.0
DELETE /admin/org/{id}/associations/{remoteSiteId}/{remoteOrgId} Removes the specified member from this organization's associations. 29.0
POST /admin/org/{id}/catalogs Create a catalog. 0.9
POST /admin/org/{id}/events Post an external event to the system. 5.1
GET /admin/org/{id}/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/org/{id}/extension Creates a Selector Extension. 16.0
GET /admin/org/{id}/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/org/{id}/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/org/{id}/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
POST /admin/org/{id}/groups Import a group from the LDAP directory service. 0.9
GET /admin/org/{id}/metadata Retrieve metadata associated with the organization. 1.5
POST /admin/org/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/org/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from organization metadata . 5.1
PUT /admin/org/{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 /admin/org/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from organization metadata. 5.1
GET /admin/org/{id}/metadata/{key} Retrieve the value of the specified key from organization metadata. 1.5
PUT /admin/org/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/org/{id}/metadata/{key} Delete the specified key and its value from organization metadata. 1.5
POST /admin/org/{id}/networks Create an organization network. 0.9
GET /admin/org/{id}/settings Retrieve settings for this organization.
PUT /admin/org/{id}/settings Updates settings for this organization.
GET /admin/org/{id}/settings/email Retrieve organization email settings. 1.5
PUT /admin/org/{id}/settings/email Update organization email settings. 1.5
GET /admin/org/{id}/settings/federation Retrieve other organization settings. 1.5
PUT /admin/org/{id}/settings/federation Update other organization settings. 1.5
POST /admin/org/{id}/settings/federation/action/regenerateFederationCertificate Regenerates the certificates used to establish trust between an organization and its identity provider 5.6
GET /admin/org/{id}/settings/general Retrieve other organization settings. 1.5
PUT /admin/org/{id}/settings/general Update other organization settings. 1.5
GET /admin/org/{id}/settings/guestPersonalizationSettings Retrieve organization defaults for guest personalization settings. 5.1
PUT /admin/org/{id}/settings/guestPersonalizationSettings Update organization defaults for guest personalization settings. 5.1
GET /admin/org/{id}/settings/ldap Retrieve organization LDAP settings. 1.5
PUT /admin/org/{id}/settings/ldap Update organization LDAP settings. 1.5
POST /admin/org/{id}/settings/ldap/action/resetLdapCertificate Resets organization LDAP SSL certificate. 5.1
POST /admin/org/{id}/settings/ldap/action/resetLdapKeyStore Resets organization LDAP keystore. 5.1
POST /admin/org/{id}/settings/ldap/action/resetLdapSspiKeytab Resets organization LDAP SSPI keytab. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapCertificate Updates organization LDAP SSL certificate. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapKeyStore Updates organization LDAP keystore. 5.1
POST /admin/org/{id}/settings/ldap/action/updateLdapSspiKeytab Updates organization LDAP SSPI keytab. 5.1
GET /admin/org/{id}/settings/oauth Retrieve organization OAuth settings.
PUT /admin/org/{id}/settings/oauth Update organization OAuth settings.
DELETE /admin/org/{id}/settings/oauth Remove OAuth settings from an organization. 32.0
GET /admin/org/{id}/settings/operationLimitsSettings Retrieve organization defaults for guest personalization settings. 5.1
PUT /admin/org/{id}/settings/operationLimitsSettings Update organization operation limits settings.
GET /admin/org/{id}/settings/passwordPolicy Retrieve organization password policy settings. 1.5
PUT /admin/org/{id}/settings/passwordPolicy Update organization password policy settings. 1.5
GET /admin/org/{id}/settings/vAppLeaseSettings Retrieve organization vApp lease settings. 1.5
PUT /admin/org/{id}/settings/vAppLeaseSettings Update organization vApp lease settings. 1.5
POST /admin/org/{id}/settings/vAppLeaseSettings/action/expireVAppsRuntimeLease
POST /admin/org/{id}/settings/vAppLeaseSettings/action/expireVAppsStorageLease
GET /admin/org/{id}/settings/vAppTemplateLeaseSettings Retrieve organization vApp template lease settings. 1.5
PUT /admin/org/{id}/settings/vAppTemplateLeaseSettings Update organization vApp template lease settings. 1.5
POST /admin/org/{id}/settings/vAppTemplateLeaseSettings/action/expireVAppTemplatesStorageLease
POST /admin/org/{id}/users Create or import a user. 0.9
POST /admin/org/{id}/vdcs Create an organization VDC. 0.9
POST /admin/org/{id}/vdcsparams Creates an organization vDC. 5.1
GET /admin/org/{orgId}/right/{id} Retrieves right in the context of an organization
DELETE /admin/org/{orgId}/right/{id} Unlink a right from an organization
GET /admin/org/{orgId}/rights Retrieve rights for an organization
POST /admin/org/{orgId}/rights Add rights to an organization
PUT /admin/org/{orgId}/rights Modify rights for an organization
DELETE /admin/org/{orgId}/rights Remove all rights from an organization
GET /admin/org/{orgId}/role/{id} Retrieve a role. 0.9
PUT /admin/org/{orgId}/role/{id} Update a role. 0.9
DELETE /admin/org/{orgId}/role/{id} Delete a role. 0.9
POST /admin/org/{orgId}/role/{id}/action/relinkToTemplate Relink a role to the template specified by its defaultRoleId.
POST /admin/org/{orgId}/role/{id}/action/unlinkFromTemplate Unlink a role from the template specified by its defaultRoleId.
POST /admin/org/{orgId}/roles Creates a role or optionally creates a role template along with role instances based on the template for a sys-admin client at API version < 27 0.9
GET /admin/org/{orgId}/roles/query Retrieves a list of roles in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
POST /admin/orgs Create an organization. 0.9
GET /admin/orgs/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/orgs/extension Creates a Selector Extension. 16.0
GET /admin/orgs/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/orgs/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/orgs/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/orgs/query Retrieves a list of organizations by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/providervdc/{id} Retrieve a provider vDC. 0.9
GET /admin/providervdc/{id}/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/providervdc/{id}/extension Creates a Selector Extension. 16.0
GET /admin/providervdc/{id}/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/providervdc/{id}/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/providervdc/{id}/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/providervdc/{id}/metadata Retrieve metadata associated with the provider vDC. 1.5
POST /admin/providervdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/providervdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from provider vDC metadata. 5.1
PUT /admin/providervdc/{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 /admin/providervdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from provider vDC metadata. 5.1
GET /admin/providervdc/{id}/metadata/{key} Retrieve the value of the specified key from provider vDC metadata. 1.5
PUT /admin/providervdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/providervdc/{id}/metadata/{key} Delete the specified key and its value from provider vDC metadata. 1.5
GET /admin/providervdc/{id}/vdcReferences Retrieve a list of organization vDCs supported by a given provider vDC. 1.0
GET /admin/providervdc/{pvdcId}/hwv/{hwVersionId} Retrieve a Virtual Hardware Version. 31.0
GET /admin/providervdcs/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/providervdcs/extension Creates a Selector Extension. 16.0
GET /admin/providervdcs/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/providervdcs/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/providervdcs/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/pvdcStorageProfile/{id} Retrieve provider vDC storage profile details.
GET /admin/pvdcStorageProfile/{id}/metadata Retrieve metadata associated with the Provider VDC Storage Profile. 5.1
POST /admin/pvdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
GET /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata. 5.1
PUT /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/pvdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
GET /admin/pvdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from Provider VDC Storage Profile metadata.
PUT /admin/pvdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/pvdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from Provider VDC Storage Profile metadata.
GET /admin/right/{id} Retrieves a right. 0.9
PUT /admin/right/{id} Updates a right. 5.1
DELETE /admin/right/{id} Deletes a right. 5.1
GET /admin/rights/query Retrieves a list of rights in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/role/{id} Retrieve a role. 0.9
PUT /admin/role/{id} Update a role. 0.9
DELETE /admin/role/{id} Delete a role. 0.9
POST /admin/role/{id}/action/relinkToTemplate Relink a role to the template specified by its defaultRoleId.
POST /admin/role/{id}/action/unlinkFromTemplate Unlink a role from the template specified by its defaultRoleId.
POST /admin/roles Creates a role or optionally creates a role template along with role instances based on the template for a sys-admin client at API version < 27 0.9
GET /admin/roles/query Retrieves a list of roles in the cloud by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/strandedUsers/query Retrieves a list of stranded users by using REST API general QueryHandler. 1.5
GET /admin/user/{id} Retrieve a user. 0.9
PUT /admin/user/{id} Update a user. 0.9
DELETE /admin/user/{id} Delete a user. 0.9
POST /admin/user/{id}/action/takeOwnership Transfer ownership of this user's vApps, media, and catalogs to the caller. 5.6
POST /admin/user/{id}/action/unlock Unlock a user. 1.5
POST /admin/user/{id}/entityRights Queries user privileges on a set of entities 5.1
GET /admin/user/{id}/grantedRights Queries user granted privileges 5.1
GET /admin/users/query Retrieves a list of users for organization the org admin belongs to by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/vdc/{id} Retrieve the admin view of an organization vDC. 0.9
PUT /admin/vdc/{id} Modify an organization vDC. 0.9
DELETE /admin/vdc/{id} Delete an organization vDC. 0.9
POST /admin/vdc/{id}/action/disable Disable an organization vDC. 1.0
POST /admin/vdc/{id}/action/enable Enable an organization vDC. 1.0
POST /admin/vdc/{id}/action/registerVApp Create a vApp based on a set of .vmx files and resource mappings 5.5
GET /admin/vdc/{id}/edgeGateways List all gateways for this Org vDC. 5.1
POST /admin/vdc/{id}/edgeGateways Create an edge gateway. 5.1
GET /admin/vdc/{id}/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/vdc/{id}/extension Creates a Selector Extension. 16.0
GET /admin/vdc/{id}/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/vdc/{id}/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/vdc/{id}/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/vdc/{id}/metadata Retrieve metadata associated with the virtual datacenter. 1.5
POST /admin/vdc/{id}/metadata Merge the metadata provided in the request with existing metadata. 1.5
GET /admin/vdc/{id}/metadata/{domain}/{key} Retrieve the value of the specified key in the specified domain from virtual datacenter metadata. 5.1
PUT /admin/vdc/{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 /admin/vdc/{id}/metadata/{domain}/{key} Delete the specified key in the specified domain and its value from virtual datacenter metadata. 5.1
GET /admin/vdc/{id}/metadata/{key} Retrieve the value of the specified key from virtual datacenter metadata. 1.5
PUT /admin/vdc/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value. 1.5
DELETE /admin/vdc/{id}/metadata/{key} Delete the specified key and its value from virtual datacenter metadata. 1.5
GET /admin/vdc/{id}/networks List all networks for this Org vDC. 5.1
POST /admin/vdc/{id}/networks Create an Org vDC network. 5.1
POST /admin/vdc/{id}/vdcStorageProfiles Add or remove virtual datacenter storage classes.
GET /admin/vdc/{vdcId}/computePolicies Get all vDC compute policies references in given vDC
PUT /admin/vdc/{vdcId}/computePolicies Update vDC compute policies given vDC
GET /admin/vdcStorageProfile/{id} Returns the representation of a vDC storage profile
PUT /admin/vdcStorageProfile/{id} Updates a single storage profile with user supplied data
GET /admin/vdcStorageProfile/{id}/metadata Retrieve metadata associated with the vDC storage profile.
POST /admin/vdcStorageProfile/{id}/metadata Merge the metadata provided in the request with existing metadata.
GET /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Retrieve the value of the specified key from vDC storage profile metadata.
PUT /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/vdcStorageProfile/{id}/metadata/{domain}/{key} Delete the specified key and its value from vDC storage profile metadata.
GET /admin/vdcStorageProfile/{id}/metadata/{key} Retrieve the value of the specified key from vDC storage profile metadata.
PUT /admin/vdcStorageProfile/{id}/metadata/{key} Set the value for the specified metadata key to the value provided, overwriting any existing value.
DELETE /admin/vdcStorageProfile/{id}/metadata/{key} Delete the specified key and its value from vDC storage profile metadata.
GET /admin/vdcs/extension Displays a list of Selector Extensions that are associated with a selector. 16.0
POST /admin/vdcs/extension Creates a Selector Extension. 16.0
GET /admin/vdcs/extension/{selectorExtensionId} Retrieves a Selector Extension. 16.0
PUT /admin/vdcs/extension/{selectorExtensionId} Updates a Selector Extension. 16.0
DELETE /admin/vdcs/extension/{selectorExtensionId} Deletes a Selector Extension. 16.0
GET /admin/vdcs/query Retrieves a list of vdcs in the organization; If filter is provided it will be applied to the corresponding result set. 1.5
GET /admin/extension Retrieve a list of extension objects and operations. 1.0
POST /admin/extension/action/migrateTenant Initiate relocation of all entities for a given org (tenant). 29.0
POST /admin/extension/action/registervimserver Register a vCenter server and vShield manager. 0.9
GET /admin/extension/blockingTask/{id} Retrieve the representation of a blocking task. 1.5
POST /admin/extension/blockingTask/{id}/action/abort Abort a blocking task. 1.5
POST /admin/extension/blockingTask/{id}/action/fail Fail a blocking task. 1.5
POST /admin/extension/blockingTask/{id}/action/resume Resume a blocking task. 1.5
POST /admin/extension/blockingTask/{id}/action/updateProgress Extend the expiration timeout of an active task. 1.5
GET /admin/extension/blockingTasks Retrieve a list of active or recently completed blocking task requests. 1.5
GET /admin/extension/datastore/{id} Retrieve a datastore. 1.5
PUT /admin/extension/datastore/{id} Update datastore properties, including name, description, and low disk space thresholds. 1.5
POST /admin/extension/datastore/{id}/action/disable Disable a datastore. 1.5
POST /admin/extension/datastore/{id}/action/enable Enable a datastore. 1.5
GET /admin/extension/datastores Retrieve a list of references to datastores in the system. 1.5
GET /admin/extension/datastores/query Get a list of all datastores by using REST API General QueryHandler. 1.5
GET /admin/extension/externalNetworkReferences Retrieve a list of references to exernal networks in the system. 1.0
GET /admin/extension/externalNetworkReferences/query Get list of external networks by using REST API general QueryHandler. 1.5
GET /admin/extension/externalnet/{id} Retrieve a system administrator view of an external network. 1.0
PUT /admin/extension/externalnet/{id} Update an external network. 1.0
DELETE /admin/extension/externalnet/{id} Delete an external network. 1.0
POST /admin/extension/externalnets Create an external network. 1.0
GET /admin/extension/host/{id} Retrieve a host. 1.0
POST /admin/extension/host/{id}/action/disable Disable a host. 0.9
POST /admin/extension/host/{id}/action/enable Enable a host. 0.9
POST /admin/extension/host/{id}/action/prepare Prepare a host. 0.9
POST /admin/extension/host/{id}/action/repair Repair a host. 1.0
POST /admin/extension/host/{id}/action/unprepare Unprepare a host. 0.9
POST /admin/extension/host/{id}/action/upgrade Upgrade the vCloud Director host agent on a host after you have upgraded vCloud Director software. 1.0
GET /admin/extension/hostGroup/{groupId} Retrieves the host group by Id 27.0
GET /admin/extension/hostReferences Retrieve a list of references to ESX/ESXi hosts attached to the system. 1.0
GET /admin/extension/hostReferences/query Get list of hosts by using REST API general QueryHAndler; This is read only list of host references and is not bound to specific states. 1.5
GET /admin/extension/namedVmGroupReferences Gets all references to named VM groups.
GET /admin/extension/networkPool/{id} Retrieve a network pool. 0.9
PUT /admin/extension/networkPool/{id} Update a network pool. 0.9
DELETE /admin/extension/networkPool/{id} Delete a network pool. 0.9
POST /admin/extension/networkPool/{id}/action/repair Repair a network pool. 32.0
POST /admin/extension/networkPool/{id}/action/sync Sync a network pool. 32.0
GET /admin/extension/networkPool/{id}/vendorServices Retrieve services associated with this network pool 5.1
GET /admin/extension/networkPoolReferences Retrieve a list of references to network pools in the system. 1.0
GET /admin/extension/networkPoolReferences/query Get list of network pools by using REST API general QueryHandler. 1.5
POST /admin/extension/networkPools Create a network pool. 0.9
GET /admin/extension/nsxtManagers Retrieve an existing NSX-T Manager. 31.0
POST /admin/extension/nsxtManagers Register an NSX-T Manager. 31.0
GET /admin/extension/nsxtManagers/{id} Retrieve the representation of a registered NSX-T manager. 31.0
PUT /admin/extension/nsxtManagers/{id} Update an existing NSX-T Manager. 31.0
DELETE /admin/extension/nsxtManagers/{id} Delete an existing NSX-T Manager. 31.0
GET /admin/extension/object Displays the list of currently registered object extensions 16.0
POST /admin/extension/object Registers a new object extension 16.0
GET /admin/extension/object/{id} Retrieves a registered object extension. 16.0
PUT /admin/extension/object/{id} Updates a registered object extension. 16.0
DELETE /admin/extension/object/{id} Deletes a registered object extension with specified ID. 16.0
GET /admin/extension/object/{id}/selectorExtensions Displays a list of all selector extensions of a registered object extension. 16.0
GET /admin/extension/orgNetworks/query Get list of Organization Networks for the system by using REST API general QueryHandler. 1.5
GET /admin/extension/orgVdcs/query Get list of all Organization Vdcs in the system by using REST API general QueryHandler. 1.5
GET /admin/extension/providerVdcReferences Retrieve a list of references to provider vDCs in the system. 1.0
GET /admin/extension/providerVdcReferences/query Get list of provider vDCs by using REST API general QueryHandler. 5.1
GET /admin/extension/providervdc/{id} Retrieve a system administrator view of a provider vDC. 0.9
PUT /admin/extension/providervdc/{id} Update a provider vDC. 0.9
DELETE /admin/extension/providervdc/{id} Delete a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/disable Disable a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/enable Enable a provider vDC. 0.9
POST /admin/extension/providervdc/{id}/action/merge Merge provider vDCs. 5.1
POST /admin/extension/providervdc/{id}/action/updateResourcePools Add or remove provider vDC resource pools. 1.5
GET /admin/extension/providervdc/{id}/availableStorageProfiles Retrieve a list of storage classes that can be added to the specified provider vDC. 5.1
GET /admin/extension/providervdc/{id}/discoverResourcePools Get direct children resource pools of Provider VDC that are valid candidates for creating a new VDC 22.0
GET /admin/extension/providervdc/{id}/discoverResourcePools/{parent_rp_moref} Get direct children resource pools of {parent_rp_moref} nested under the Provider VDC which are valid candidates for creating a new VDC. 22.0
GET /admin/extension/providervdc/{id}/resourcePools Retrieve a provider vDC resource pool set. 1.5
POST /admin/extension/providervdc/{id}/storageProfiles Update storage classes of a provider vDC. 5.1
POST /admin/extension/providervdcs Create a provider vDC. 0.9
POST /admin/extension/providervdcsparams Create a provider vDC. 5.1
GET /admin/extension/pvdcStorageProfile/{id} Retrieve provider vDC storage profile details.
PUT /admin/extension/pvdcStorageProfile/{id} Update a provider vDC storage profile

You can update a storage profile to enable or disable it.

POST /admin/extension/resourcePool/{id}/action/disable Disable a provider vDC resource pool. 1.5
POST /admin/extension/resourcePool/{id}/action/enable Enable a provider VDC resource pool 1.5
POST /admin/extension/resourcePool/{id}/action/migrateVms Migrate one or more virtual machines to a different resource pool. 5.1
GET /admin/extension/resourcePool/{id}/vmList List all VMs using this resource pool. 5.1
GET /admin/extension/resourcePool/{rpId}/hostGroups List all HostGroups within this resource pool. 27.0
GET /admin/extension/resourcePool/{rpId}/rules List all VmHostAffinityRules within this resource pool. 27.0
POST /admin/extension/resourcePool/{rpId}/rules Create VM Affinity Rules within this resource pool.
GET /admin/extension/resourcePool/{rpId}/vmGroup/name/{groupName} Gets {@link JAXBElement} with given VM group name.
GET /admin/extension/resourcePool/{rpId}/vmGroups List all VmGroups within this resource pool. 27.0
POST /admin/extension/resourcePool/{rpId}/vmGroups Create VM group within this resource pool.
GET /admin/extension/rule/{ruleId} Retrieves the specified VM Host affinity rule
DELETE /admin/extension/rule/{ruleId} Deletes the specified VM Host affinity rule.
POST /admin/extension/rule/{ruleId}/action/disable Disables the specified VM Host affinity rule.
POST /admin/extension/rule/{ruleId}/action/enable Enables the specified VM Host affinity rule.
POST /admin/extension/rule/{ruleId}/action/makeMandatory Make specified VM Host affinity rule mandatory.
POST /admin/extension/rule/{ruleId}/action/makeOptional Make the specified VM Host affinity optional.
GET /admin/extension/service Retrieves a list of extension service operations. 5.1
POST /admin/extension/service Creates service. 5.1
GET /admin/extension/service/aclrule/{id} Retrieve (GET) ACL rule
DELETE /admin/extension/service/aclrule/{id} Delete (DELETE) ACL rule
POST /admin/extension/service/action/clearunusedlocalizationbundles Cleanup for unused external localization resources. 5.1
POST /admin/extension/service/action/clearunusedrights Clears all the rights that are not associated with a role or acl rule and which extension service is already deleted. 5.1
GET /admin/extension/service/apidefinition/{id} Retrieve API definition. 5.1
DELETE /admin/extension/service/apidefinition/{id} Deletes API definition. 5.1
GET /admin/extension/service/apidefinition/{id}/files Returns all file descriptors for the API definition. 5.1
POST /admin/extension/service/apidefinition/{id}/files Creates file descriptor. 5.1
GET /admin/extension/service/apifilter/{id} Retrieves API filter.
DELETE /admin/extension/service/apifilter/{id} Deletes API filter.
POST /admin/extension/service/authorizationcheck Checks user authorization for all services with enabled authorization, URL and request verb. 5.1
GET /admin/extension/service/file/{id} Retrieve a file descriptor 5.1
DELETE /admin/extension/service/file/{id} Deletes file descriptor. 5.1
GET /admin/extension/service/link/{id} Retrieves service link.
DELETE /admin/extension/service/link/{id} Deletes service link.
POST /admin/extension/service/localizationbundles Initiates localization bundle upload. 5.1
GET /admin/extension/service/query Return the System Administrator representation of all extension services registered with the system.
GET /admin/extension/service/resourceclass/{id} Retrieve (GET) resource class info
DELETE /admin/extension/service/resourceclass/{id} Deletes (DELETE) resource class
GET /admin/extension/service/resourceclass/{id}/resourceclassactions List registered resource class actions for extension service.
POST /admin/extension/service/resourceclass/{id}/resourceclassactions Registers resource class action for extension service.
GET /admin/extension/service/resourceclass/{id}/serviceresources List registered service resources for extension service.
POST /admin/extension/service/resourceclass/{id}/serviceresources Registers service resource for extension service.
GET /admin/extension/service/resourceclassaction/{id} Retrieve (GET) resource class action info
DELETE /admin/extension/service/resourceclassaction/{id} Deletes (DELETE) resource class action
GET /admin/extension/service/resourceclassaction/{id}/aclrules List registered resource class ACL rule for extension service.
POST /admin/extension/service/resourceclassaction/{id}/aclrules Registers resource class ACL rule for extension service.
GET /admin/extension/service/serviceresource/{id} Retrieve (GET) service resource
DELETE /admin/extension/service/serviceresource/{id} Delete (DELETE) service resource
GET /admin/extension/service/{id} Gives information about a concrete extension service. 5.1
PUT /admin/extension/service/{id} Updates already registered service. 5.1
DELETE /admin/extension/service/{id} Deletes registered service. 5.1
GET /admin/extension/service/{id}/apidefinitions Returns the API definitions registered by this service. 5.1
POST /admin/extension/service/{id}/apidefinitions Creates API definition. 5.1
GET /admin/extension/service/{id}/apifilters Returns the API filters registered by this service. 5.1
POST /admin/extension/service/{id}/apifilters Creates API filter. 5.1
POST /admin/extension/service/{id}/authorizationcheck Checks user authorization for service, URL and request verb. 5.1
GET /admin/extension/service/{id}/links Returns the links registered by this service. 5.1
POST /admin/extension/service/{id}/links Create service link.
GET /admin/extension/service/{id}/resourceclasses List registered resource classes for extension service.
POST /admin/extension/service/{id}/resourceclasses Registers resource class for extension service.
GET /admin/extension/service/{id}/rights Gives the rights registered by this extension service. 5.1
POST /admin/extension/service/{id}/rights Registers right to the rights managed by this extension service. 5.1
GET /admin/extension/settings Retrieve system settings. 1.5
PUT /admin/extension/settings Update system settings. 1.5
GET /admin/extension/settings/amqp Retrieve system AMQP settings. 1.5
PUT /admin/extension/settings/amqp Update system AMQP settings. 1.5
POST /admin/extension/settings/amqp/action/resetAmqpCertificate Resets AMQP certificate. 5.1
POST /admin/extension/settings/amqp/action/resetAmqpTruststore Resets AMQP truststore. 5.1
POST /admin/extension/settings/amqp/action/test Validate provisional AMQP settings. 1.5
POST /admin/extension/settings/amqp/action/updateAmqpCertificate Updates AMQP certificate. 5.1
POST /admin/extension/settings/amqp/action/updateAmqpTruststore Updates AMQP trust store. 5.1
GET /admin/extension/settings/blockingTask Retrieve system blocking task settings. 1.5
PUT /admin/extension/settings/blockingTask Update system blocking task settings. 1.5
GET /admin/extension/settings/blockingTask/operations Retrieve a list of operations that are configured as blocking tasks. 1.5
PUT /admin/extension/settings/blockingTask/operations Update the list of operations that are configured as blocking tasks. 1.5
GET /admin/extension/settings/branding Retrieve system branding settings. 1.5
PUT /admin/extension/settings/branding Update system branding settings. 1.5
GET /admin/extension/settings/catalog Retrieve vCloud Director catalog setting details. 5.5
PUT /admin/extension/settings/catalog Update catalog settings details. 5.5
GET /admin/extension/settings/cpom Retrieve the system-level settings for CPoM.
PUT /admin/extension/settings/cpom Update CPoM settings.
GET /admin/extension/settings/email Retrieve system email settings. 1.5
PUT /admin/extension/settings/email Update system email settings. 1.5
GET /admin/extension/settings/general Retrieve other system settings. 1.5
PUT /admin/extension/settings/general Update other system settings. 1.5
POST /admin/extension/settings/general/action/resetVcTrustsore Resets vCenter trust store. 5.1
POST /admin/extension/settings/general/action/updateVcTrustsore Updates vCenter trust store. 5.1
GET /admin/extension/settings/kerberosSettings Retrieve system Kerberos settings. 5.1
PUT /admin/extension/settings/kerberosSettings Update system Kerberos settings. 5.1
GET /admin/extension/settings/ldapSettings Retrieve system LDAP settings. 1.5
PUT /admin/extension/settings/ldapSettings Update system LDAP settings. 1.5
POST /admin/extension/settings/ldapSettings/action/resetLdapCertificate Resets system LDAP SSL certificate. 5.1
POST /admin/extension/settings/ldapSettings/action/resetLdapKeyStore Resets system LDAP keystore. 5.1
POST /admin/extension/settings/ldapSettings/action/resetLdapSspiKeytab Resets system LDAP SSPI key tab. 5.1
POST /admin/extension/settings/ldapSettings/action/updateLdapCertificate Updates system LDAP SSL certificate. 5.1
POST /admin/extension/settings/ldapSettings/action/updateLdapKeyStore Updates system LDAP keystore. 5.1
POST /admin/extension/settings/ldapSettings/action/updateLdapSspiKeytab Updates system LDAP SSPI key tab. 5.1
GET /admin/extension/settings/license Retrieve vCloud Director software license details. 1.5
PUT /admin/extension/settings/license Update vCloud Director software license details. 1.5
GET /admin/extension/settings/lookupService Retrieve settings that describe how vCloud Director connects to a vSphere lookup service. 5.1
PUT /admin/extension/settings/lookupService Register / unregister Lookup Service to / from vCD. 5.1
GET /admin/extension/settings/notifications Retrieve system AMQP notifications settings. 1.5
PUT /admin/extension/settings/notifications Update system AMQP notifications settings. 1.5
GET /admin/extension/settings/operationLimitsSettings Retrieves the system wide defaults for tenant throttling
PUT /admin/extension/settings/operationLimitsSettings Update catalog settings details.
GET /admin/extension/settings/passwordPolicy Retrieve system password policy settings. 1.5
PUT /admin/extension/settings/passwordPolicy Update system password policy settings. 1.5
GET /admin/extension/strandedItem/{id} Gets the representation of a strandedItem. 5.1
DELETE /admin/extension/strandedItem/{id} Removes stranded item. 5.1
POST /admin/extension/strandedItem/{id}/action/forceDelete Removes stranded item and its children 5.1
DELETE /admin/extension/strandedItems Removes all stranded items. 5.1
GET /admin/extension/strandedItems/query Get list of all stranded items in the system by using REST API general QueryHandler. 1.5
GET /admin/extension/vapps/query Get list of all vApps in the system by using REST API general QueryHandler. 1.5
GET /admin/extension/vdc/{id}/resourcePools Retrieve resource pools associated with an organization VDC 1.5
GET /admin/extension/vdcTemplate/{id} Retrieve a vDC template. 5.7
PUT /admin/extension/vdcTemplate/{id} Update a vDC template. 5.7
DELETE /admin/extension/vdcTemplate/{id} Delete a vDC template. 5.7
PUT /admin/extension/vdcTemplate/{id}/action/controlAccess Update access control information for a VDC template. 5.7
GET /admin/extension/vdcTemplate/{id}/controlAccess Retrieve access control information for a VDC template. 5.7
GET /admin/extension/vdcTemplateReferences Retrieve a list of all VDC templates. 5.7
POST /admin/extension/vdcTemplates Create a VDC template. 5.7
GET /admin/extension/vimServer/{id} Retrieve the representation of a registered vCenter server. 0.9
PUT /admin/extension/vimServer/{id} Update the representation of a registered vCenter server. 0.9
POST /admin/extension/vimServer/{id}/action/forcevimserverreconnect Force vCloud Director to reconnect to a registered vCenter server. 1.0
POST /admin/extension/vimServer/{id}/action/refresh Refresh vCenter server. 5.1
POST /admin/extension/vimServer/{id}/action/refreshStorageProfiles Refresh Storage Classes data from a registered vCenter server. 5.1
POST /admin/extension/vimServer/{id}/action/unregister Unregister a vCenter server. 0.9
GET /admin/extension/vimServer/{id}/hostReferences Retrieve the list of ESX/ESXi hosts in the cloud. 1.5
POST /admin/extension/vimServer/{id}/importMedia Import media from vCenter. 1.5
POST /admin/extension/vimServer/{id}/importVm Import a virtual machine from vCenter. 30.0
POST /admin/extension/vimServer/{id}/importVmAsVApp Import a virtual machine from vCenter as a vCloud Director vApp. 1.0
POST /admin/extension/vimServer/{id}/importVmAsVAppTemplate Import a virtual machine from vCenter as a vCloud Director vApp template. 1.0
POST /admin/extension/vimServer/{id}/importVmIntoExistingVApp Import a virtual machine from vCenter into an existing vCloud Director vApp. 1.5
GET /admin/extension/vimServer/{id}/networks Retrieve a list of available vCenter networks and portgroups. 1.5
GET /admin/extension/vimServer/{id}/resourcePoolList Retrieve a list of unused resource pools from a vCenter server. 1.0
GET /admin/extension/vimServer/{id}/storageProfiles Retrieve all storage profiles in the VIM server 5.1
GET /admin/extension/vimServer/{id}/vmsList Retrieve a list of virtual machines that can be imported from a registered vCenter server. 1.0
GET /admin/extension/vimServer/{id}/{vimObjType}/{vimObjMoref}/vSphereWebClientUrl Retrieve the vSphere URL of an object. 5.1
GET /admin/extension/vimServerReferences Retrieve a list of references to vCenter servers attached to the system. 1.0
GET /admin/extension/vimServerReferences/query Get list of vSphere servers by using REST API general QueryHandler; This is read only list of vim servers and is not bound to specific states. 1.5
GET /admin/extension/vmGroup/name/{groupName}
POST /admin/extension/vmGroup/name/{groupName}/action/addVms Adds virtual machines to the specified VM group.
POST /admin/extension/vmGroup/name/{groupName}/action/removeVms Removes virtual machines from the specified VM group.
GET /admin/extension/vmGroup/name/{groupName}/vmsList Get all VMs from all clusters in given VM group.
GET /admin/extension/vmGroup/{groupId} Retrieves the vm group by Id 27.0
DELETE /admin/extension/vmGroup/{groupId} Delete the specified VM group 27.0
GET /admin/extension/vmGroup/{groupId}/vmsList Enumerate the properties of the specified VM group 27.0
GET /admin/extension/vmGroups/name/{groupName}
GET /admin/extension/vsm/{id} Retrieve vShield Manager configuration details, including administrator credentials. 5.1
PUT /admin/extension/vsm/{id} Update vShield Manager configuration details, including administrator credentials. 5.1