|
Home Frames |
|
|
|
|
User Operations (148)
| Operation | Description | Since |
|---|---|---|
| GET /catalog/{id} | Retrieves a catalog. | 0.9 |
| POST /catalog/{id}/catalogItems | Creates a catalog item in a catalog. | 0.9 |
| GET /catalog/{id}/metadata | Returns the metadata associated with the catalog. | 1.5 |
| GET /catalog/{id}/metadata/{key} | Returns the metadata associated with the catalog for the specified key. | 1.5 |
| GET /catalogItem/{id} | Retrieves a catalog item. | 0.9 |
| PUT /catalogItem/{id} | Modifies a catalog item. | 0.9 |
| DELETE /catalogItem/{id} | Deletes a catalog item. | 0.9 |
| GET /catalogItem/{id}/metadata | Returns the metadata associated with the catalog item. | 1.5 |
| POST /catalogItem/{id}/metadata | Merges the metadata for a catalog item with the information provided. | 1.5 |
| GET /catalogItem/{id}/metadata/{key} | Returns the metadata associated with the catalog item for the specified key. | 1.5 |
| PUT /catalogItem/{id}/metadata/{key} | Sets the metadata for the particular key for the catalog item to the value provided. | 1.5 |
| DELETE /catalogItem/{id}/metadata/{key} | Deletes the metadata for the particular key for the catalog item | 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 /entity/{id} | Redirects to the URL of an entity with the given VCD ID. | 1.5 |
| GET /login | Login with HTTP GET request. (same as POST, implemented for convenience) You should provide only an authorization header in format: Authorization: |
0.9 |
| POST /login | Login with HTTP POST request. | 0.9 |
| GET /media/{id} | Retrieves a media. | 0.9 |
| PUT /media/{id} | Updates the name/description of a media. | 0.9 |
| DELETE /media/{id} | Deletes a media. | 0.9 |
| GET /media/{id}/metadata | Returns the metadata associated with the media. | 1.5 |
| POST /media/{id}/metadata | Merges the metadata for a media with the information provided. | 1.5 |
| GET /media/{id}/metadata/{key} | Returns the metadata associated with the media for the specified key. | 1.5 |
| PUT /media/{id}/metadata/{key} | Sets the metadata for the particular key for the media to the value provided. | 1.5 |
| DELETE /media/{id}/metadata/{key} | Deletes the metadata for the particular key for the media | 1.5 |
| GET /media/{id}/owner | Retrieves media owner | 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} | Retrieves an organization network. | 0.9 |
| GET /network/{id}/metadata | Returns the metadata associated with the network. | 1.5 |
| GET /network/{id}/metadata/{key} | Returns the metadata associated with the network for the specified key. | 1.5 |
| GET /org | Retrieves a list of organizations. | 0.9 |
| GET /org/{id} | Retrieves an organization. | 0.9 |
| POST /org/{id}/catalog/{catalogId}/action/controlAccess | Modifies a catalog control access. | 0.9 |
| GET /org/{id}/catalog/{catalogId}/controlAccess | Retrieves the catalog control access information. | 0.9 |
| GET /org/{id}/metadata | Returns the metadata associated with the organization. | 1.5 |
| GET /org/{id}/metadata/{key} | Returns the metadata associated with the organization for the specified key. | 1.5 |
| GET /query | REST API General queries handler | 1.5 |
| GET /schema/{schemaFileName} | Retrieves an xml schema | |
| GET /session | Returns a representation of the current session that can serve as a single entry point to the system, as it provides user, admin, and extension (sysadmin) entry links depending on the privileges of the current user. | 1.5 |
| DELETE /session | ||
| POST /sessions | Login with HTTP POST request. | 1.5 |
| GET /task/{id} | Retrieves a task. | 0.9 |
| POST /task/{id}/action/cancel | Cancel a task. | 1.5 |
| GET /tasksList/{id} | Retrieves a list of tasks bound to an organization. | 0.9 |
| GET /vApp/{id} | Retrieves a vApp/VM. | 0.9 |
| PUT /vApp/{id} | Modifies the name/description of a vApp/VM. | 0.9 |
| DELETE /vApp/{id} | Deletes a vApp/VM. | 0.9 |
| POST /vApp/{id}/action/consolidate | Consolidates a vm. | 1.5 |
| POST /vApp/{id}/action/controlAccess | Modifies the control access of a vApp. | 0.9 |
| POST /vApp/{id}/action/deploy | Deploys a vApp/VM. | 0.9 |
| POST /vApp/{id}/action/discardSuspendedState | Discard suspended state of a vApp/VM. | 0.9 |
| POST /vApp/{id}/action/enterMaintenanceMode | Place the vApp into maintenance mode. | 1.5 |
| POST /vApp/{id}/action/exitMaintenanceMode | Take the vApp out of maintenance mode. | 1.5 |
| POST /vApp/{id}/action/installVMwareTools | Installs VMware tools to the virtual machine. | v1.5 |
| POST /vApp/{id}/action/recomposeVApp | Recompose a vApp by removing its own VMs and/or adding new ones from other vApps or vApp templates. | 1.0 |
| POST /vApp/{id}/action/relocate | Relocates a vm. | 1.5 |
| POST /vApp/{id}/action/undeploy | Undeploy a vApp/VM. | 0.9 |
| POST /vApp/{id}/action/upgradeHardwareVersion | Upgrade virtual hardware version of a VM to the highest supported virtual hardware version of provider vDC where the VM locates | 1.5 |
| GET /vApp/{id}/controlAccess | Retrieves the control access information for a vApp. | 0.9 |
| GET /vApp/{id}/guestCustomizationSection | Retrieves the guest customization section of a VM. | 1.0 |
| PUT /vApp/{id}/guestCustomizationSection | Modifies the guest customization options of a VM. | 1.0 |
| GET /vApp/{id}/leaseSettingsSection | Retrieves the lease settings section of a vApp or vApp template | 0.9 |
| PUT /vApp/{id}/leaseSettingsSection | Modifies the lease settings section of a vApp or vApp template. | 0.9 |
| POST /vApp/{id}/media/action/ejectMedia | Ejects a media from a VM. | 0.9 |
| POST /vApp/{id}/media/action/insertMedia | Inserts a media into a VM. | 0.9 |
| GET /vApp/{id}/metadata | Returns the metadata associated with the vApp/vm. | 1.5 |
| POST /vApp/{id}/metadata | Merges the metadata for a vApp/vm with the information provided. | 1.5 |
| GET /vApp/{id}/metadata/{key} | Returns the metadata associated with the vApp/vm for the specified key. | 1.5 |
| PUT /vApp/{id}/metadata/{key} | Sets the metadata for the particular key for the vApp/vm to the value provided. | 1.5 |
| DELETE /vApp/{id}/metadata/{key} | Deletes the metadata for the particular key for the vApp/vm | 1.5 |
| GET /vApp/{id}/networkConfigSection | Retrieves the network config section of a vApp or vApp template. | 0.9 |
| PUT /vApp/{id}/networkConfigSection | Modifies the network config section of a vApp. | 0.9 |
| GET /vApp/{id}/networkConnectionSection | Retrieves the network connection section of a VM. | 0.9 |
| PUT /vApp/{id}/networkConnectionSection | Modifies the network connection section of a VM. | 0.9 |
| GET /vApp/{id}/networkSection | Retrieves the network section of a vApp or vApp template. | 0.9 |
| GET /vApp/{id}/operatingSystemSection | Retrieves the operating system section of a VM. | 0.9 |
| PUT /vApp/{id}/operatingSystemSection | Modifies the operating system section of a VM. | 0.9 |
| GET /vApp/{id}/owner | Retrieves the owner of a vApp. | 1.5 |
| PUT /vApp/{id}/owner | Changes VApp owner. | 1.5 |
| POST /vApp/{id}/power/action/powerOff | Powers off a vApp/VM. | 0.9 |
| POST /vApp/{id}/power/action/powerOn | Powers on a vApp/VM. | 0.9 |
| POST /vApp/{id}/power/action/reboot | Reboots a vApp/VM. | 0.9 |
| POST /vApp/{id}/power/action/reset | Resets a vApp/VM. | 0.9 |
| POST /vApp/{id}/power/action/shutdown | Shutdowns a vApp/VM. | 0.9 |
| POST /vApp/{id}/power/action/suspend | Suspends a vApp/VM. | 0.9 |
| GET /vApp/{id}/productSections | Retrieves VAppTemplate/VM product sections | 1.5 |
| PUT /vApp/{id}/productSections | Modifies the product section information of a vApp/VM | 1.5 |
| GET /vApp/{id}/question | Retrieves a pending question for a VM. | 0.9 |
| POST /vApp/{id}/question/action/answer | Answer on a pending question. | 0.9 |
| GET /vApp/{id}/runtimeInfoSection | Retrieves the runtime info section of a VM. | 1.5 |
| GET /vApp/{id}/screen | Retrieves the thumbnail of the screen of a VM. | 0.9 |
| POST /vApp/{id}/screen/action/acquireTicket | Retrieve a screen ticket for remote console connection to a VM. | 0.9 |
| GET /vApp/{id}/startupSection | Retrieves the startup section of a vApp. | 0.9 |
| PUT /vApp/{id}/startupSection | Modifies the startup section of a vApp. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection | Retrieves the virtual hardware section of a VM. | 0.9 |
| PUT /vApp/{id}/virtualHardwareSection | Modifies the virtual hardware section of a VM. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/cpu | Retrieves the RASD item that contains CPU information from virtual hardware section of a VM. | 0.9 |
| PUT /vApp/{id}/virtualHardwareSection/cpu | Modifies the CPU properties in virtual hardware section of a VM. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/disks | Retrieves a list of RASD items for disks from virtual hardware section of a VM. | 0.9 |
| PUT /vApp/{id}/virtualHardwareSection/disks | Modifies the disks list in virtual hardware section of a VM. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/media | Retrieves the list of RASD items that represents the floppies and CD/DVD drives in a VM. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/memory | Retrieves the RASD item that contains memory information from virtual hardware section of a VM. | 0.9 |
| PUT /vApp/{id}/virtualHardwareSection/memory | Modifies the memory properties in virtual hardware section of a VM | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/networkCards | Retrieves a list of RASD items of network cards from virtual hardware section of a VM. | 0.9 |
| PUT /vApp/{id}/virtualHardwareSection/networkCards | Modifies the network cards list in virtual hardware section of a VM. | 0.9 |
| GET /vApp/{id}/virtualHardwareSection/serialPorts | Retrieves a list of RASD items of serial ports from virtual hardware section of a VM. | 1.5 |
| PUT /vApp/{id}/virtualHardwareSection/serialPorts | Modifies the serial ports list in virtual hardware section of a VM. | 1.5 |
| GET /vAppTemplate/{id} | Retrieves a vApp template (can be used also to retrieve a VM from a vAppTemplate). | 0.9 |
| PUT /vAppTemplate/{id} | Modifies only the name/description of a vApp template. | 0.9 |
| DELETE /vAppTemplate/{id} | Deletes a vApp template. | 0.9 |
| POST /vAppTemplate/{id}/action/consolidate | Consolidates a vm. | 1.5 |
| POST /vAppTemplate/{id}/action/disableDownload | Disables the download link to the ovf of a vApp template. | 0.9 |
| POST /vAppTemplate/{id}/action/enableDownload | Enables downloading of the ovf of a vApp template. | 0.9 |
| POST /vAppTemplate/{id}/action/relocate | Relocates a vm. | 1.5 |
| GET /vAppTemplate/{id}/customizationSection | Retrieves the customization section of a vApp template. | 1.0 |
| PUT /vAppTemplate/{id}/customizationSection | Modifies the vApp template customization information. | 1.0 |
| GET /vAppTemplate/{id}/guestCustomizationSection | Retrieves the guest customization section of a VM. | 1.0 |
| PUT /vAppTemplate/{id}/guestCustomizationSection | Modifies the guest customization options 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 | Modifies the lease settings section of a vApp or vApp template. | 0.9 |
| GET /vAppTemplate/{id}/metadata | Returns the metadata associated with the vApp template/vm. | 1.5 |
| POST /vAppTemplate/{id}/metadata | Merges the metadata for a vApp Template with the information provided. | 1.5 |
| GET /vAppTemplate/{id}/metadata/{key} | Returns the metadata associated with the vApp Template/vm for the specified key. | 1.5 |
| PUT /vAppTemplate/{id}/metadata/{key} | Sets the metadata for the particular key for the vApp Template to the value provided. | 1.5 |
| DELETE /vAppTemplate/{id}/metadata/{key} | Deletes the metadata for the particular key for the vApp Template | 1.5 |
| GET /vAppTemplate/{id}/networkConfigSection | Retrieves the network config section of a vApp or vApp template. | 0.9 |
| PUT /vAppTemplate/{id}/networkConfigSection | Modifies the network config section of a vApp. | 0.9 |
| GET /vAppTemplate/{id}/networkConnectionSection | Retrieves the network connection section of a VM. | 0.9 |
| PUT /vAppTemplate/{id}/networkConnectionSection | Modifies the network connection section of a VM. | 0.9 |
| GET /vAppTemplate/{id}/networkSection | Retrieves the network section of a vApp or vApp template. | 0.9 |
| GET /vAppTemplate/{id}/ovf | Retrieves an OVF descriptor of a vApp template. | 0.9 |
| GET /vAppTemplate/{id}/owner | Retrieves vApp template owner. | 1.5 |
| GET /vAppTemplate/{id}/productSections | Retrieves VAppTemplate/VM product sections | 1.5 |
| PUT /vAppTemplate/{id}/productSections | Modifies the product section information of a vApp/VM | 1.5 |
| GET /vAppTemplate/{id}/shadowVms | ||
| 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 in lease by using REST API general QueryHandler; If filter is provided it will be applied to the corresponding result set. | 1.5 |
| GET /vdc/{id} | Retrieves a virtual data center. | 0.9 |
| POST /vdc/{id}/action/captureVApp | Captures a vApp into vApp template. | 0.9 |
| POST /vdc/{id}/action/cloneMedia | Clones a media into new one. | 0.9 |
| POST /vdc/{id}/action/cloneVApp | Clones a vApp into new one. | 0.9 |
| POST /vdc/{id}/action/cloneVAppTemplate | Clones a vApp template into new one. | 0.9 |
| POST /vdc/{id}/action/composeVApp | Composes a new vApp using VMs from other vApps or vApp templates. | 0.9 |
| POST /vdc/{id}/action/instantiateVAppTemplate | Instantiate a vApp template into a new vApp. | 0.9 |
| POST /vdc/{id}/action/uploadVAppTemplate | Uploading vApp template to a vDC. | 0.9 |
| POST /vdc/{id}/media | Creates a media (and present upload link for the floppy/iso file). | 0.9 |
| GET /vdc/{id}/metadata | Returns the metadata associated with the vDC. | 1.5 |
| GET /vdc/{id}/metadata/{key} | Returns the metadata associated with the vDC for the specified key. | 1.5 |
| 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 |
| Top of page | ||||
|
Home Frames |
|
|
|
|