|
Home Frames |
|
|
|
|
Operations (329)
| 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 |
| GET /admin/ | Retrieves the top level entity for the Admin API. | 0.9 |
| GET /admin/catalog/{id} | Retrieves a catalog. | 0.9 |
| PUT /admin/catalog/{id} | Modifies a catalog. | 0.9 |
| DELETE /admin/catalog/{id} | Deletes a catalog. | 0.9 |
| POST /admin/catalog/{id}/action/publish | Publish a catalog. | 1.0 |
| GET /admin/catalog/{id}/metadata | Returns the metadata associated with the catalog. | 1.5 |
| POST /admin/catalog/{id}/metadata | Merges the metadata for a catalog with the information provided. | 1.5 |
| GET /admin/catalog/{id}/metadata/{key} | Returns the metadata associated with the catalog for the specified key. | 1.5 |
| PUT /admin/catalog/{id}/metadata/{key} | Sets the metadata for the particular key for the catalog to the value provided. | 1.5 |
| DELETE /admin/catalog/{id}/metadata/{key} | Deletes the metadata for the particular key for the catalog | 1.5 |
| GET /admin/catalog/{id}/owner | Returns owner of a catalog. | 1.5 |
| PUT /admin/catalog/{id}/owner | Changes owner for catalog. | 1.5 |
| GET /admin/group/{id} | Retrieves a group. | 0.9 |
| PUT /admin/group/{id} | Modifies 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} | Gets admin representation of network. | 0.9 |
| PUT /admin/network/{id} | Modifies an org network. | 0.9 |
| DELETE /admin/network/{id} | Deletes a network. | 0.9 |
| POST /admin/network/{id}/action/reset | Reset(undeploy & redeploy) networking services on a logical network. | 1.5 |
| POST /admin/network/{id}/action/syncSyslogServerSettings | Synchronize syslog server settings of a logical network with system defaults Synchronize operation can be performed on: - routed organization network - routed/fenced vApp networks | 1.5 |
| GET /admin/network/{id}/metadata | Returns the metadata associated with the network. | 1.5 |
| POST /admin/network/{id}/metadata | Merges the metadata for a network with the information provided. | 1.5 |
| GET /admin/network/{id}/metadata/{key} | Returns the metadata associated with the network for the specified key. | 1.5 |
| PUT /admin/network/{id}/metadata/{key} | Sets the metadata for the particular key for the network to the value provided. | 1.5 |
| DELETE /admin/network/{id}/metadata/{key} | Deletes the metadata for the particular key for the network | 1.5 |
| GET /admin/org/{id} | Retrieves an admin view of an organization. | 0.9 |
| PUT /admin/org/{id} | Modifies an admin organization. | 0.9 |
| DELETE /admin/org/{id} | Deletes an admin organization. | 0.9 |
| POST /admin/org/{id}/action/disable | Disables an organization. | 1.0 |
| POST /admin/org/{id}/action/enable | Enables an admin organization If the organization was disabled this action enables it. | 1.0 |
| POST /admin/org/{id}/catalogs | Creates a catalog in an organization. | 0.9 |
| POST /admin/org/{id}/groups | Imports a group in an organization. | 0.9 |
| GET /admin/org/{id}/metadata | Returns the metadata associated with the organization. | 1.5 |
| POST /admin/org/{id}/metadata | Merges the metadata for a organization with the information provided. | 1.5 |
| GET /admin/org/{id}/metadata/{key} | Returns the metadata associated with the organization for the specified key. | 1.5 |
| PUT /admin/org/{id}/metadata/{key} | Sets the metadata for the particular key for the organization to the value provided. | 1.5 |
| DELETE /admin/org/{id}/metadata/{key} | Deletes the metadata for the particular key for the organization | 1.5 |
| POST /admin/org/{id}/networks | Creates a network in an organization. | 0.9 |
| GET /admin/org/{id}/settings | Gets organizational settings for this organization. | |
| PUT /admin/org/{id}/settings | Updates organizational settings for this organization. | |
| GET /admin/org/{id}/settings/email | Retrieves email settings for an organization. | 1.5 |
| PUT /admin/org/{id}/settings/email | Updates email policy settings for organization. | 1.5 |
| GET /admin/org/{id}/settings/general | Gets general organization settings. | 1.5 |
| PUT /admin/org/{id}/settings/general | Updates general organization settings. | 1.5 |
| GET /admin/org/{id}/settings/ldap | Retrieves LDAP settings for an organization. | 1.5 |
| PUT /admin/org/{id}/settings/ldap | Updates LDAP settings for an organization. | 1.5 |
| GET /admin/org/{id}/settings/passwordPolicy | Retrieves password policy settings for an organization. | 1.5 |
| PUT /admin/org/{id}/settings/passwordPolicy | Updates password policy settings for organization. | 1.5 |
| GET /admin/org/{id}/settings/vAppLeaseSettings | Gets organization resource cleanup settings on the level of vApp. | 1.5 |
| PUT /admin/org/{id}/settings/vAppLeaseSettings | Updates organization resource cleanup settings on the level of vApp. | 1.5 |
| GET /admin/org/{id}/settings/vAppTemplateLeaseSettings | Retrieves expiration and storage policy for vApp templates in an organization. | 1.5 |
| PUT /admin/org/{id}/settings/vAppTemplateLeaseSettings | Updates vApp template policy settings for organization. | 1.5 |
| POST /admin/org/{id}/users | Creates or imports a user in an organization. | 0.9 |
| POST /admin/org/{id}/vdcs | Creates a virtual data center in an organization. | 0.9 |
| POST /admin/orgs | Creates an organization. | 0.9 |
| 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} | Get the representation of the Provider VDC. | 0.9 |
| GET /admin/providervdc/{id}/metadata | Returns the metadata associated with the provider vDC. | 1.5 |
| POST /admin/providervdc/{id}/metadata | Merges the metadata for a provider vDC with the information provided. | 1.5 |
| GET /admin/providervdc/{id}/metadata/{key} | Returns the metadata associated with the vDC for the specified key. | 1.5 |
| PUT /admin/providervdc/{id}/metadata/{key} | Sets the metadata for the particular key for the provider vDC to the value provided. | 1.5 |
| DELETE /admin/providervdc/{id}/metadata/{key} | Deletes the metadata for the particular key for the provider vDC | 1.5 |
| GET /admin/providervdc/{id}/vdcReferences | Retrieves all org vDCs for given provider vDC. | 1.0 |
| GET /admin/right/{id} | Retrieves a right. | 0.9 |
| 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} | Retrieves a role. | 0.9 |
| PUT /admin/role/{id} | Modifies a role. | 0.9 |
| DELETE /admin/role/{id} | Deletes a role. | 0.9 |
| POST /admin/roles | Creates a role. | 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 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/user/{id} | Retrieves a user. | 0.9 |
| PUT /admin/user/{id} | Modifies a user. | 0.9 |
| DELETE /admin/user/{id} | Deletes a user. | 0.9 |
| POST /admin/user/{id}/action/unlock | Unlocks a user. | 1.5 |
| 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} | Retrieves an admin view of virtual data center. | 0.9 |
| PUT /admin/vdc/{id} | Modifies a Virtual Data Center. | 0.9 |
| DELETE /admin/vdc/{id} | Deletes a Virtual Data Center. | 0.9 |
| POST /admin/vdc/{id}/action/disable | Disables a Virtual Data Center. | 1.0 |
| POST /admin/vdc/{id}/action/enable | Enables a Virtual Data Center. | 1.0 |
| GET /admin/vdc/{id}/metadata | Returns the metadata associated with the vDC. | 1.5 |
| POST /admin/vdc/{id}/metadata | Merges the metadata for a vDC with the information provided. | 1.5 |
| GET /admin/vdc/{id}/metadata/{key} | Returns the metadata associated with the vDC for the specified key. | 1.5 |
| PUT /admin/vdc/{id}/metadata/{key} | Sets the metadata for the particular key for the vDC to the value provided. | 1.5 |
| DELETE /admin/vdc/{id}/metadata/{key} | Deletes the metadata for the particular key for the vDC | 1.5 |
| 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 | Get various links to access extension API. | 1.0 |
| POST /admin/extension/action/registervimserver | Register a vSphere server and shield manager. | 0.9 |
| GET /admin/extension/blockingTask/{id} | Gets the representation of a task extension request. | 1.5 |
| POST /admin/extension/blockingTask/{id}/action/abort | This operation:
|
1.5 |
| POST /admin/extension/blockingTask/{id}/action/fail | This operation:
|
1.5 |
| POST /admin/extension/blockingTask/{id}/action/resume | Resumes request and continues with executing underlying operation. | 1.5 |
| POST /admin/extension/blockingTask/{id}/action/updateProgress | This operation updates:
|
1.5 |
| GET /admin/extension/blockingTasks | Returns task extension requests that have already been processed or are currently active. | 1.5 |
| GET /admin/extension/datastore/{id} | Gets the representation of a datastore. | 1.5 |
| PUT /admin/extension/datastore/{id} | Updates the datastore. | 1.5 |
| DELETE /admin/extension/datastore/{id} | Removes the datastore. | 1.5 |
| POST /admin/extension/datastore/{id}/action/disable | Disables the datastore. | 1.5 |
| POST /admin/extension/datastore/{id}/action/enable | Enables the datastore. | 1.5 |
| GET /admin/extension/datastores | Get a list of all datastores. | 1.5 |
| GET /admin/extension/datastores/query | Get a list of all datastores by using RETS API General QueryHandler. | 1.5 |
| GET /admin/extension/externalNetworkReferences | Get list of external network references. | 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} | Gets an extension view of external network. | 1.0 |
| PUT /admin/extension/externalnet/{id} | Modifies an external network. | 1.0 |
| DELETE /admin/extension/externalnet/{id} | Deletes an external network. | 1.0 |
| POST /admin/extension/externalnets | Creates an external network. | 1.0 |
| GET /admin/extension/host/{id} | Gets a host. | 1.0 |
| POST /admin/extension/host/{id}/action/disable | Disables a host. | 0.9 |
| POST /admin/extension/host/{id}/action/enable | Enables a host. | 0.9 |
| POST /admin/extension/host/{id}/action/prepare | Prepares a host. | 0.9 |
| POST /admin/extension/host/{id}/action/repair | Repairs a host. | 1.0 |
| POST /admin/extension/host/{id}/action/unprepare | Unprepares a host. | 0.9 |
| POST /admin/extension/host/{id}/action/upgrade | Upgrades the host agent. | 1.0 |
| GET /admin/extension/hostReferences | Get list of host references. | 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/licensing/report/{id} | Gets a licensing report. | 1.0 |
| GET /admin/extension/licensing/reports | Lists the licensing reports. | 1.0 |
| GET /admin/extension/networkPool/{id} | Gets a network pool. | 0.9 |
| PUT /admin/extension/networkPool/{id} | Modifies a network pool. | 0.9 |
| DELETE /admin/extension/networkPool/{id} | Deletes a network pool. | 0.9 |
| GET /admin/extension/networkPoolReferences | Get list of network pool references. | 1.0 |
| GET /admin/extension/networkPoolReferences/query | Get list of network pools by using REST API general QueryHandler. | 1.5 |
| POST /admin/extension/networkPools | Creates a network pool. | 0.9 |
| 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 | Get list of provider vDC references. | 1.0 |
| GET /admin/extension/providerVdcReferences/query | Get list of provider vDCs by using REST API general QueryHandler. | 1.5 |
| GET /admin/extension/providervdc/{id} | Gets an extension representation of provider vDC. | 0.9 |
| PUT /admin/extension/providervdc/{id} | Modifies a provider vDC. | 0.9 |
| DELETE /admin/extension/providervdc/{id} | Deletes a provider vDC. | 0.9 |
| POST /admin/extension/providervdc/{id}/action/disable | Disables a provider vDC. | 0.9 |
| POST /admin/extension/providervdc/{id}/action/enable | Enables a provider vDC. | 0.9 |
| POST /admin/extension/providervdc/{id}/action/updateResourcePools | Update backing resource pools for provider vdc | 1.5 |
| GET /admin/extension/providervdc/{id}/resourcePools | Retrieve provider vdc resource pools | 1.5 |
| POST /admin/extension/providervdcs | Creates a provider vDC. | 0.9 |
| POST /admin/extension/resourcePool/{id}/action/disable | Disable Provider VDC resource pool | 1.5 |
| POST /admin/extension/resourcePool/{id}/action/enable | Enable Provider VDC resource pool | 1.5 |
| GET /admin/extension/settings | Retrieves the {@link SystemSettings}. | 1.5 |
| PUT /admin/extension/settings | Updates the {@link SystemSettings}. | 1.5 |
| GET /admin/extension/settings/amqp | Retrieves the {@link AmqpSettings}. | 1.5 |
| PUT /admin/extension/settings/amqp | Updates the {@link AmqpSettings}. | 1.5 |
| POST /admin/extension/settings/amqp/action/test | Test AMQP settings. | 1.5 |
| GET /admin/extension/settings/blockingTask | Returns global task extensions settings. | 1.5 |
| PUT /admin/extension/settings/blockingTask | Updates global task extensions settings. | 1.5 |
| GET /admin/extension/settings/blockingTask/operations | Gets task operations which are enabled for extension. | 1.5 |
| PUT /admin/extension/settings/blockingTask/operations | Updates the task operations which are enabled for extension. | 1.5 |
| GET /admin/extension/settings/branding | Retrieves the {@link BrandingSettings}. | 1.5 |
| PUT /admin/extension/settings/branding | Updates the {@link BrandingSettings}. | 1.5 |
| GET /admin/extension/settings/email | Retrieves the {@link EmailSettings}. | 1.5 |
| PUT /admin/extension/settings/email | Updates the {@link EmailSettings}. | 1.5 |
| GET /admin/extension/settings/general | Retrieves the {@link GeneralSettings}. | 1.5 |
| PUT /admin/extension/settings/general | Updates the {@link GeneralSettings}. | 1.5 |
| GET /admin/extension/settings/ldapSettings | Retrieves the {@link LdapSpec}. | 1.5 |
| PUT /admin/extension/settings/ldapSettings | Updates the {@link LdapSpec}. | 1.5 |
| GET /admin/extension/settings/license | Retrieves the {@link LicenseSpec}. | 1.5 |
| PUT /admin/extension/settings/license | Updates the {@link LicenseSpec}. | 1.5 |
| GET /admin/extension/settings/notifications | Retrieves the Notifications settings. | 1.5 |
| PUT /admin/extension/settings/notifications | Updates the Notifications settings. | 1.5 |
| GET /admin/extension/settings/passwordPolicy | Retrieves the {@link SystemPasswordPolicySettings}. | 1.5 |
| PUT /admin/extension/settings/passwordPolicy | Updates the {@link SystemPasswordPolicySettings}. | 1.5 |
| GET /admin/extension/uberAdminSettings | Retrieves the {@link UberAdminSettings}. | 1.5 |
| PUT /admin/extension/uberAdminSettings | Updates the {@link UberAdminSettings}. | 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 | Retrieves resource pools associated with an organization VDC | 1.5 |
| GET /admin/extension/vimServer/{id} | Gets a vSphere server. | 0.9 |
| PUT /admin/extension/vimServer/{id} | Modifies a vSphere server. | 0.9 |
| POST /admin/extension/vimServer/{id}/action/forcevimserverreconnect | Forces a vSphere server to reconnect. | 1.0 |
| POST /admin/extension/vimServer/{id}/action/unregister | Unregisters a vSphere server. | 0.9 |
| GET /admin/extension/vimServer/{id}/hostReferences | Gets all the hosts attached to VC with @param id | 1.5 |
| POST /admin/extension/vimServer/{id}/importMedia | Import media from vSphere Supported media types are ISO and FLOPPY The returned media entity will contain a task of importing process. | 1.5 |
| POST /admin/extension/vimServer/{id}/importVmAsVApp | Imports a vSphere server VM as vApp. | 1.0 |
| POST /admin/extension/vimServer/{id}/importVmAsVAppTemplate | Imports a vSphere server VM as vApp template. | 1.0 |
| POST /admin/extension/vimServer/{id}/importVmIntoExistingVApp | Imports a vSphere server VM into an existing vApp. | 1.5 |
| GET /admin/extension/vimServer/{id}/networks | Gets all the networks available to VC with @param id | 1.5 |
| GET /admin/extension/vimServer/{id}/resourcePoolList | Lists free resource pools in a vSphere server. | 1.0 |
| GET /admin/extension/vimServer/{id}/vmsList | Lists available VMs for import from a vSphere server. | 1.0 |
| GET /admin/extension/vimServerReferences | Get list of vSphere server references. | 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 |
| Top of page | ||||
|
Home Frames |
|
|
|
|