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.
|
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 |