Esx REST APIs Operations Index
All available Esx REST APIs Operations
Hcl
Compatibility Data
GET
Get Hcl Compatibility Data Status
Provides information about the compatibility data located on the vCenter Appliance.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.HardwareCompatibility.Read.
POST
Download Hcl Compatibility Data Async
Replaces the local compatibility data with the latest version found from VMware official source.
Hosts Compatibility Report
POST
Create Host Compatibility Report Async
Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
GET
Get Host Hcl Compatibility Report
Returns the last generated hardware compatibility report for the given host.
Hosts
Settings
Clusters Depot Overrides
POST
Add Cluster Depot Overrides
Adds a new depot override to the list of currently configured depot overrides for a given cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.
GET
Get Cluster Depot Overrides
Returns the information about currently configured depot overrides for a given cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
POST
Remove Cluster Depot Overrides
Removes a depot override from the list of currently configured depot overrides for a given cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.
Clusters Software
POST
Apply Cluster Software Async
Applies the desired software document associated with the given cluster to hosts within the cluster. If commit field is set, it implies the minimum commit that the Software.apply operation should use, however if subsequent commits have been made to the desired state document the apply operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
POST
Check Cluster Software Async
Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If commit field is set it implies the minimum commit that the check operation should use, however if subsequent commits have been made to the desired state document the check operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
POST
Export Cluster Software
Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
GET
Get Cluster Software
Returns the complete desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
POST
Scan Cluster Software Async
Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Clusters Enablement Software
POST
Check Cluster Enablement Software Async
Checks the possibility to manage the cluster with a single software specification.
PUT
Set Cluster Enablement Software Async
Enables the feature which manages the cluster with a single software specification.
GET
Get Cluster Enablement Software
Returns whether the given cluster is managed with a single software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
Clusters Policies Apply
GET
Get Cluster Policies Apply
Returns the configured policy that has been set for the cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
PUT
Set Cluster Policies Apply
This API will set the configured policy specification for the cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.
Clusters Software Commits
GET
Get Cluster Commit Software
Returns the information about a specific commit.
Clusters Software Components
GET
Get Cluster Component Software
Returns the component version for the given component in the desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
GET
List Cluster Software Components
Returns a list of components in the desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Clusters Software Drafts
POST
Commit Cluster Draft Async
Commits the specified draft as the desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
POST
Create Cluster Software Drafts
Creates a new software draft from the desired document. It will be deleted, when the draft is committed successfully. If a desired document is missing, then this operation will create an empty draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
List Cluster Software Drafts
Returns information about the software drafts for the specified cluster that match the Drafts.FilterSpec.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
DELETE
Delete Cluster Draft Software
Deletes the software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
Get Cluster Draft Software
Returns the information about given software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
POST
Import Software Spec Cluster Software Drafts
Imports the desired software specification as a new draft. If a desired document is missing, then this operation will create an empty draft except when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION, then NotFound error is reported. In addition, the exisiting draft will be overwritten when the source type is of either LATEST_RECOMMENDATION or CURRENT_SERIES_RECOMMENDATION.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
POST
Scan Cluster Draft Async
Scans all the hosts in the cluster against the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
POST
Validate Cluster Draft Async
Validates the software draft. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Clusters Software Effective Components
GET
List Cluster Software Effective Components
Returns the effective components for the cluster.
Clusters Software Recommendations
POST
Generate Cluster Software Recommendations Async
Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
GET
Get Cluster Software Recommendations
Returns Information about the most recent recommendation generation result.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Clusters Software Solutions
DELETE
Delete Cluster Solution Async
Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
PUT
Set Cluster Solution Async
Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
GET
Get Cluster Solution Software
Returns components registered for the given solution in the desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
GET
List Cluster Software Solutions
Returns all solutions in the desired software specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Clusters Software Drafts Software Add On
DELETE
Delete Cluster Draft Software Add On
Deletes the desired OEM add-on specification in the software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
Get Cluster Draft Software Add On
Returns the OEM add-on specification in a software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
PUT
Set Cluster Draft Software Add On
Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Clusters Software Drafts Software Base Image
GET
Get Cluster Draft Software Base Image
Returns the base-image specification in a software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
PUT
Set Cluster Draft Software Base Image
Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Clusters Software Drafts Software Components
DELETE
Delete Cluster Draft Component Software
Deletes the given component from the software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
Get Cluster Draft Component Software
Returns the component version for the given component in the software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
PUT
Set Cluster Draft Component Software
Set the component version for a given component in the software draft. This will overwrite any existing version for the given component.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
List Cluster Draft Software Components
Returns the components that comprise the software draft.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
PATCH
Update Cluster Draft Software Components
Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Clusters Software Drafts Software Effective Components
GET
List Cluster Draft Software Effective Components
Returns the components that comprise the desired software state of the cluster.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Clusters Software Drafts Software Hardware Support
DELETE
Delete Cluster Draft Software Hardware Support
Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
GET
Get Cluster Draft Software Hardware Support
Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
PUT
Set Cluster Draft Software Hardware Support
Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSoftwareSpecification.Write.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.
Clusters Software Reports Hardware Compatibility
POST
Check Cluster Reports Hardware Compatibility Async
Initiates a Cluster HCL Validation check for a given cluster. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
GET
Get Cluster Software Reports Hardware Compatibility
Returns the HCL validation check summary.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.HardwareCompatibility.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.
Clusters Software Reports Hardware Compatibility Details
GET
Get Cluster Software Reports Hardware Compatibility Details
Returns the HCL validation check detailed results.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.HardwareCompatibility.Read.
- The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.
Defaults Clusters Policies Apply
GET
Get Defaults Clusters Policies Apply
Returns the configured policy that has been set.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
PUT
Set Defaults Clusters Policies Apply
This API will set the configured policy specification.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
Defaults Clusters Policies Apply Effective
GET
Get Clusters Policies Apply Effective
Returns the effective apply policy based on system defaults and what has been configured.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depot Content Base Images
GET
List Depot Content Base Images
Returns a list of currently available base-images in the depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depot Content Add Ons Versions
GET
Get Name Version Add Ons
Returns information about a given OEM add-on version in the depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depot Content Base Images Versions
GET
Get Version Base Images
Returns information about a given base-image version in the depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depot Content Components Versions
GET
Get Name Version Components
Returns information about a given component version in the depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depots Offline
POST
Create From Host Depots Offline Async
Extract the current software specification applied to the host and import it into the depot. Returns details about the current software specification applied to the host. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
POST
Create Depots Offline Async
Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no offline depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
DELETE
Delete Depot Offline
The task-based Offline.delete operation removes content of an imported offline depot from vLCM completely. Note: The non task-based Offline.delete operation has been deprecated. It deletes only the record of depot from the list of imported offline software depots, instead of removing the depot's content from vLCM.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
GET
Get Depot Offline
Gets the information about an imported offline software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
DELETE
Delete Depot Offline Async
The task-based Offline.delete operation removes content of an imported offline depot from vLCM completely. Note: The non task-based Offline.delete operation has been deprecated. It deletes only the record of depot from the list of imported offline software depots, instead of removing the depot's content from vLCM.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
GET
List Depots Offline
Returns currently imported offline software depots.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Depots Online
POST
Create Depots Online
Adds a new online software depot to the list of currently configured online software depots.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
GET
List Depots Online
Returns a list of currently configured online software depots.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
DELETE
Delete Depot Online
The task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot's content from the system.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
GET
Get Depot Online
Gets the information about a currently configured online software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
PATCH
Update Depot Online
Updates the configuration of a currently configured online software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
DELETE
Delete Depot Online Async
The task-based Online.delete operation removes content of a user-imported online depot from vLCM completely. As a result, the URL of the user-imported online depot will also be removed. Note: 1. To remove content of system-defined online depots, use Online.flush operation. 2. The non task-based Online.delete operation has been deprecated. It only deletes the record of depot from the list of imported online software depots, instead of removing the depot's content from the system.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
POST
Flush Depot Online Async
The task-based Online.flush operation removes content of a system-defined online depot from vLCM completely. As a result, the system-defined online depot will be disabled. Note: To remove content of user-imported online depots, use the task-based Online.delete operation.
Depots Sync Schedule
GET
Get Depots Sync Schedule
Returns the currently configured software depot sync schedule.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
PUT
Set Depots Sync Schedule
Sets the software depot sync schedule.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
Depots Umds
DELETE
Delete Depots Umds
The task-based Umds.delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based Umds.delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
GET
Get Depots Umds
Gets the information about a currently configured UMDS software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
PUT
Set Depots Umds
Sets or overwrites information about the UMDS software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
PATCH
Update Depots Umds
Updates the configuration of a currently configured UMDS software depot.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
DELETE
Delete Depots Umds Async
The task-based Umds.delete operation removes content of the UMDS depot from vLCM completely. Note: The non task-based Umds.delete operation has been deprecated. It deletes only the record of UMDS depot from database, instead of removing the content of UMDS depot from vLCM.
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Write.
Hardware Support Managers Packages
GET
List Manager Hardware Support Packages
Returns the list of available Hardware Support Packages (HSPs) for a particular host, as specified by its Hardware Support Manager (HSM)
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.
Hardware Support Managers Packages Versions
GET
Get Manager Pkg Version Packages
Returns the detailed information for a specific version of an available Hardware Support Packages (HSPs) as specified by the Hardware Support Manager (HSM)
if you do not have all of the privileges described as follows:
- Operation execution requires VcIntegrity.lifecycleSettings.Read.