VMware Developer Documentation
BETA
API Reference
PowerCLI Reference
vSphere Automation API
ESX REST APIs
ESX REST APIs Data Structures
vAPI Error
REST Error
HclCompatibilityDataStatus
HclNotifications
HclReportsLocation
HclReportsToken
HclHostsCompatibilityReleasesEsxiCompatibilityReleases
HclHostsCompatibilityReportServerCompatibility
HclDriver
HclFirmware
HclHostsCompatibilityReportResult
HclHostsCompatibilityReportServerHclInfo
HclHostsCompatibilityReportHclReport
HclHostsCompatibilityReportDeviceConstraint
HclHostsCompatibilityReportBiosConstraint
HclServer
HclCompatibilityStatus
HclPCIDevice
HclHostsCompatibilityReportDeviceHclInfo
HclHostsCompatibilityReportSpec
HostsSoftwareInfo
HostsSoftwareInfo
HostsSoftwareHostCredentials
HostsSoftwareConnectionSpecAuthenticationType
HostsSoftwareConnectionSpec
HostsNotifications
InlineApiEsxHostsHostSoftwareInstalledComponents200Response
HostsSoftwareInstalledComponentsInstalledComponentInfo
SettingsClustersConfigurationApplyResult
SettingsClustersConfigurationImportSpec
SettingsClustersConfigurationApplySpec
SettingsClustersConfigurationHostStatus
SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec
SettingsClustersConfigurationExportResult
SettingsClustersConfigurationInfo
SettingsClustersConfigurationMetadata
SettingsClustersDepotOverridesInfo
SettingsClustersDepotOverridesDepot
SettingsClustersSoftwareApplySpec
SettingsClustersSoftwareStageStatus
SettingsClustersSoftwareStatus
SettingsClustersSoftwareStageResult
SettingsClustersSoftwareEntityCheckResult
SettingsClustersSoftwareStageStatusStatus
SettingsClustersSoftwareApplyStatus
SettingsClustersSoftwareCheckStatus
SettingsClustersSoftwareEntityCheckResultEntityType
SettingsClustersSoftwareCheckInfo
SettingsClustersSoftwareExportType
SettingsClustersSoftwareCheckSpec
SettingsClustersSoftwareCheckIssue
SettingsClustersSoftwareApplyStatusStatus
SettingsSoftwareInfo
InlineApiEsxSettingsClustersClusterSoftwareActionExport200Response
SettingsClustersSoftwareStageSpec
SettingsClustersSoftwareApplyResult
SettingsClustersSoftwareCheckResult
SettingsClustersSoftwareExportSpec
SettingsClustersConfigurationSchemaResult
SettingsClustersConfigurationClusterCompliance
SettingsClustersConfigurationClusterPrecheckResult
SettingsClustersConfigurationReportsRecentTasksDraftTasks
SettingsClustersConfigurationReportsRecentTasksInfo
SettingsClustersEnablementConfigurationInfo
SettingsClustersEnablementSoftwareCheckResult
SettingsClustersEnablementSoftwareInfo
SettingsClustersEnablementSoftwareCheckType
SettingsClustersEnablementSoftwareCheckSpec
SettingsClustersEnablementSoftwareEnableSpec
SettingsClustersEnablementConfigurationTransitionValidateResultStatus
SettingsClustersEnablementConfigurationTransitionReferenceHost
SettingsClustersEnablementConfigurationTransitionFileSpec
SettingsClustersEnablementConfigurationTransitionEligibilityResultStatus
SettingsClustersEnablementConfigurationTransitionValidateResult
SettingsClustersEnablementConfigurationTransitionInfoStatus
SettingsClustersEnablementConfigurationTransitionInfo
SettingsClustersEnablementConfigurationTransitionSource
SettingsClustersEnablementConfigurationTransitionState
SettingsClustersEnablementConfigurationTransitionEligibilityResult
SettingsHostInfo
SettingsClustersConfigurationDraftImportResult
SettingsClustersEnablementConfigurationTransitionEnableResult
SettingsClustersEnablementConfigurationTransitionEnableResultStatus
SettingsClustersPoliciesApplyConfiguredPolicySpecPreRemediationPowerAction
SettingsClustersPoliciesApplyConfiguredPolicySpec
SettingsClustersPoliciesApplyFailureActionAction
SettingsClustersPoliciesApplyFailureAction
SettingsClustersPoliciesApplyParallelRemediationAction
SettingsClustersPoliciesApplyEffectiveFailureActionAction
SettingsClustersPoliciesApplyEffectiveFailureAction
SettingsClustersPoliciesApplyEffectiveParallelRemediationAction
SettingsClustersPoliciesApplyEffectiveEffectivePolicySpecPreRemediationPowerAction
SettingsAddOnInfo
SettingsBaseImageInfo
SettingsClustersSoftwareCommitsInfoApplyStatusType
SettingsClustersSoftwareCommitsInfo
SettingsClusterCompliance
InlineApiEsxSettingsClustersClusterSoftwareComponents200Response
SettingsComponentInfo
SettingsClustersSoftwareDraftsValidateResult
SettingsClustersSoftwareDraftsCommitSpec
SettingsClustersSoftwareDraftsInfo
SettingsClustersSoftwareDraftsSourceType
SettingsClustersSoftwareDraftsStatusType
SettingsClustersSoftwareDraftsMetadata
InlineApiEsxSettingsClustersClusterSoftwareDrafts200Response
SettingsClustersSoftwareDraftsImportSpec
SettingsClustersSoftwareDraftsFilterSpec
SettingsClustersSoftwareDraftsSummary
InlineApiEsxSettingsClustersClusterSoftwareEffectiveComponents200Response
SettingsHardwareSupportInfo
SettingsClustersSoftwareRecommendationsFilterSpec
SettingsClustersSoftwareRecommendationsExplanationDetails
SettingsClustersSoftwareRecommendationsInfo
InlineApiEsxSettingsClustersClusterSoftwareSolutions200Response
SettingsSolutionInfo
InlineApiEsxSettingsClustersClusterSoftwareDraftsDraftSoftwareComponents200Response
SettingsClustersSoftwareDraftsSoftwareComponentsUpdateSpec
InlineApiEsxSettingsClustersClusterSoftwareDraftsDraftSoftwareEffectiveComponents200Response
SettingsClustersSoftwareReportsApplyImpactApplyImpactSpec
SettingsClustersSoftwareReportsApplyImpactImpact
SettingsClustersSoftwareReportsApplyImpactClusterImpact
SettingsClustersSoftwareReportsHardwareCompatibilityCheckSummary
SettingsClustersSoftwareReportsHardwareCompatibilityComplianceStatus
SettingsClustersSoftwareReportsLastApplyResultApplyStatusStatus
SettingsClustersSoftwareReportsLastApplyResultApplyStatus
SettingsClustersSoftwareReportsLastApplyResultApplyResult
SettingsClustersSoftwareReportsLastCheckResultCheckResult
SettingsClustersSoftwareReportsLastCheckResultStatus
SettingsClustersSoftwareReportsLastCheckResultEntityCheckResultEntityType
SettingsClustersSoftwareReportsLastCheckResultEntityCheckResult
SettingsClustersSoftwareReportsLastCheckResultCheckInfo
SettingsClustersSoftwareReportsLastCheckResultCheckStatus
SettingsClustersSoftwareReportsCheckResult
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusComplianceAction
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusKey
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusReclassificationSpec
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusService
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesVcgEntriesUpdateSpec
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesVcgEntriesKey
SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesVcgEntriesProductSelectionSpec
SettingsDefaultsClustersPoliciesApplyFailureActionAction
SettingsDefaultsClustersPoliciesApplyFailureAction
SettingsDefaultsClustersPoliciesApplyConfiguredPolicySpecPreRemediationPowerAction
SettingsDefaultsClustersPoliciesApplyConfiguredPolicySpec
SettingsDefaultsClustersPoliciesApplyParallelRemediationAction
SettingsDefaultsClustersPoliciesApplyEffectiveFailureActionAction
SettingsDefaultsClustersPoliciesApplyEffectiveFailureAction
SettingsDefaultsClustersPoliciesApplyEffectiveParallelRemediationAction
SettingsDefaultsClustersPoliciesApplyEffectiveEffectivePolicySpecPreRemediationPowerAction
SettingsDefaultsClustersPoliciesApplyEffectiveEffectivePolicySpec
SettingsDefaultsHostsPoliciesApplyFailureActionAction
SettingsDefaultsHostsPoliciesApplyFailureAction
SettingsDefaultsHostsPoliciesApplyConfiguredPolicySpecPreRemediationPowerAction
SettingsDefaultsHostsPoliciesApplyConfiguredPolicySpec
SettingsDefaultsHostsPoliciesApplyEffectiveFailureAction
SettingsDefaultsHostsPoliciesApplyEffectiveEffectivePolicySpecPreRemediationPowerAction
SettingsDefaultsHostsPoliciesApplyEffectiveEffectivePolicySpec
SettingsDefaultsHostsPoliciesApplyEffectiveFailureActionAction
SettingsDepotContentAddOnsAddOnVersionSummary
SettingsDepotContentAddOnsFilterSpec
SettingsDepotContentAddOnsCategoryType
SettingsDepotContentAddOnsSummary
SettingsDepotContentBaseImagesFilterSpec
SettingsDepotContentBaseImagesSummary
SettingsDepotContentBaseImagesCategoryType
SettingsDepotContentComponentsComponentBundleType
SettingsDepotContentComponentsSummary
SettingsDepotContentComponentsComponentVersionSummary
SettingsDepotContentComponentsFilterSpec
SettingsDepotContentComponentsCategoryType
SettingsDepotContentComponentsUrgencyType
SettingsDepotContentAddOnsVersionsInfo
SettingsDepotContentAddOnsVersionsComponentInfo
SettingsDepotContentAddOnsVersionsCategoryType
SettingsDepotContentAddOnsVersionsRemovedComponentInfo
SettingsDepotContentBaseImagesVersionsComponentVersionInfo
SettingsDepotContentBaseImagesVersionsInfo
SettingsDepotContentBaseImagesVersionsCategoryType
SettingsDepotContentComponentsVersionsCategoryType
SettingsDepotContentComponentsVersionsInfo
SettingsDepotContentComponentsVersionsUrgencyType
SettingsDepotsOfflineHostCredentials
SettingsDepotsOfflineInfo
SettingsDepotsOfflineSummary
SettingsDepotsOfflineCreateResult
SettingsDepotsOfflineConnectionSpec
SettingsDepotsOfflineSourceType
SettingsDepotsOfflineCreateSpec
SettingsDepotsOfflinePrecheckResult
SettingsDepotsOfflineDeleteResult
SettingsSoftwareSpec
InlineApiEsxSettingsDepotsOffline200Response
SettingsDepotsOfflineConnectionSpecAuthenticationType
SettingsDepotsOfflineDepotExtractInfo
SettingsDepotsOnlineUpdateSpec
SettingsDepotsOnlineCreateSpec
SettingsDepotsOnlineSummary
SettingsDepotsOnlinePrecheckResult
SettingsDepotsOnlineInfo
InlineApiEsxSettingsDepotsOnline200Response
SettingsDepotsOnlineDeleteResult
SettingsDepotsOnlineFlushResult
SettingsDepotsSyncScheduleSchedule
SettingsDepotsSyncScheduleSpec
SettingsDepotsSyncScheduleDayOfWeek
SettingsDepotsSyncScheduleRecurrence
SettingsDepotsUmdsPrecheckResult
SettingsDepotsUmdsInfo
SettingsDepotsUmdsUpdateSpec
SettingsDepotsUmdsSetSpec
SettingsDepotsUmdsDeleteResult
SettingsDepotsOfflineContentInfo
SettingsDepotsOnlineContentInfo
SettingsDepotsUmdsContentInfo
SettingsHardwareSupportManagersHardwareSupportManagerInfo
SettingsHardwareSupportManagersPackagesFilterSpec
SettingsHardwareSupportManagersPackagesHardwareSupportPackageInfo
SettingsHardwareSupportManagersPackagesVersionsFilterSpec
SettingsHardwareSupportManagersPackagesVersionsRemovedComponentInfo
SettingsHardwareSupportManagersPackagesVersionsComponentInfo
SettingsHardwareSupportManagersPackagesVersionsPackageInfo
SettingsHostsConfigurationExtractResult
SettingsHostsDepotOverridesInfo
SettingsHostsDepotOverridesDepot
SettingsHostsSoftwareStatus
SettingsHostsSoftwareCheckStatus
SettingsHostsSoftwareStageStatus
SettingsHostsSoftwareApplyStatusStatus
SettingsHostsSoftwareApplyStatus
SettingsHostsSoftwareStageSpec
SettingsHostsSoftwareExportSpec
SettingsHostsSoftwareEntityCheckResult
SettingsHostsSoftwareEntityCheckResultEntityType
SettingsHostsSoftwareExportType
InlineApiEsxSettingsHostsHostSoftwareActionExport200Response
SettingsHostsSoftwareStageResult
SettingsHostsSoftwareCheckIssue
SettingsHostsSoftwareApplyResult
SettingsHostsSoftwareCheckResult
SettingsHostsSoftwareApplySpec
SettingsHostsSoftwareCheckSpec
SettingsHostsSoftwareStageStatusStatus
SettingsHostsSoftwareCheckInfo
SettingsHostsEnablementSoftwareCheckSpec
SettingsHostsEnablementSoftwareEnableSpec
SettingsHostsEnablementSoftwareCheckType
SettingsHostsEnablementSoftwareCheckResult
SettingsHostsEnablementSoftwareInfo
SettingsHostsPoliciesApplyFailureAction
SettingsHostsPoliciesApplyConfiguredPolicySpecPreRemediationPowerAction
SettingsHostsPoliciesApplyConfiguredPolicySpec
SettingsHostsPoliciesApplyFailureActionAction
SettingsHostsPoliciesApplyEffectiveFailureActionAction
SettingsHostsPoliciesApplyEffectiveFailureAction
SettingsHostsPoliciesApplyEffectiveEffectivePolicySpecPreRemediationPowerAction
SettingsHostsPoliciesApplyEffectiveEffectivePolicySpec
SettingsHostsSoftwareCommitsApplyStatusType
SettingsHostsSoftwareCommitsInfo
SettingsHostCompliance
InlineApiEsxSettingsHostsHostSoftwareComponents200Response
SettingsHostsSoftwareDraftsValidateResult
SettingsHostsSoftwareDraftsFilterSpec
SettingsHostsSoftwareDraftsMetadata
SettingsHostsSoftwareDraftsInfo
SettingsHostsSoftwareDraftsSummary
SettingsHostsSoftwareDraftsStatusType
SettingsHostsSoftwareDraftsImportSpec
SettingsHostsSoftwareDraftsCommitSpec
InlineApiEsxSettingsHostsHostSoftwareDrafts200Response
SettingsHostsSoftwareDraftsSourceType
InlineApiEsxSettingsHostsHostSoftwareEffectiveComponents200Response
SettingsHostsSoftwareRecommendationsInfo
SettingsHostsSoftwareRecommendationsExplanationDetails
InlineApiEsxSettingsHostsHostSoftwareSolutions200Response
InlineApiEsxSettingsHostsHostSoftwareDraftsDraftSoftwareComponents200Response
SettingsHostsSoftwareDraftsSoftwareComponentsUpdateSpec
InlineApiEsxSettingsHostsHostSoftwareDraftsDraftSoftwareEffectiveComponents200Response
SettingsHostsSoftwareReportsApplyImpactImpact
SettingsHostsSoftwareReportsApplyImpactHostImpact
SettingsHostsSoftwareReportsLastApplyResultApplyResult
SettingsHostsSoftwareReportsLastApplyResultApplyStatusStatus
SettingsHostsSoftwareReportsLastApplyResultApplyStatus
SettingsHostsSoftwareReportsLastCheckResultCheckResult
SettingsHostsSoftwareReportsLastCheckResultCheckIssue
SettingsHostsSoftwareReportsLastCheckResultStatus
SettingsHostsSoftwareReportsLastCheckResultEntityCheckResultEntityType
SettingsHostsSoftwareReportsLastCheckResultEntityCheckResult
SettingsHostsSoftwareReportsLastCheckResultCheckInfo
SettingsHostsSoftwareReportsLastCheckResultCheckStatus
HclNotification
HostsHardwareSupportPackageSpec
HostsComponentInfo
HostsAddOnSpec
HostsBaseImageSpec
HostsHardwareSupportPackageInfo
HostsHardwareSupportInfo
HostsNotification
HostsCertificateInfo
HostsHardwareSupportSpec
HostsSolutionComponentSpec
HostsBaseImageInfo
HostsSoftwareSpec
HostsSolutionInfo
HostsSolutionSpec
HostsAddOnInfo
SettingsSolutionDetails
SettingsAddOnDetails
SettingsNotifications
SettingsComponentCompliance
SettingsDataProcessingUnitCompliance
SettingsBaseImageSpec
SettingsNotification
SettingsEffectiveComponentInfo
SettingsStatus
SettingsComponentSource
SettingsHardwareSupportPackageCompliance
SettingsBaseImageCompliance
SettingsCheckStatus
SettingsStatusInfo
SettingsHardwareSupportPackageSpec
SettingsHardwareModuleFirmwareInfo
SettingsAddOnCompliance
SettingsComplianceStatus
SettingsHardwareModuleClass
SettingsComponentOverrideInfo
SettingsSolutionComponentDetails
SettingsBaseImageDetails
SettingsEffectiveComponentDetails
SettingsDataProcessingUnitsCompliance
SettingsHardwareModuleFirmwareCompliance
SettingsCheckDescription
SettingsNotificationType
SettingsTaskInfo
SettingsAddOnSpec
SettingsSolutionCompliance
SettingsHardwareSupportPackageInfo
SettingsDataProcessingUnitInfo
SettingsComplianceImpact
SettingsCheckError
SettingsSolutionComponentSpec
SettingsHardwareSupportSpec
SettingsHardwareModuleDetails
SettingsSolutionSpec
SettingsComponentDetails
SettingsStageStatus
SettingsClustersConfigurationHostStatusStatus
SettingsClustersConfigurationValidationResult
SettingsClustersConfigurationSettingCompliance
SettingsClustersConfigurationValidationError
SettingsClustersConfigurationConfigurationSpec
SettingsClustersConfigurationComplianceInfo
SettingsClustersConfigurationImpactInfo
SettingsClustersConfigurationImportResult
SettingsClustersConfigurationClusterComplianceStatus
SettingsClustersConfigurationImportResultStatus
SettingsClustersConfigurationImpactType
SettingsClustersConfigurationDraftImportResultStatus
SettingsClustersConfigurationHostResult
SettingsClustersConfigurationDocumentStructure
SettingsClustersConfigurationClusterPrecheckResultStatus
SettingsClustersConfigurationComplianceStatus
SettingsClustersConfigurationHostPrecheckResult
SettingsClustersConfigurationHostCompliance
SettingsClustersSoftwareReportsStorageDeviceCompatibility
SettingsClustersSoftwareReportsDriverFirmwareVersion
SettingsClustersSoftwareReportsPciDeviceConstraint
SettingsClustersSoftwareReportsPciDevice
SettingsClustersSoftwareReportsStorageDeviceComplianceInfo
SettingsClustersSoftwareReportsComplianceStatus
SettingsClustersSoftwareReportsComplianceStatusDetail
SettingsClustersSoftwareReportsStorageDeviceConstraint
SettingsClustersSoftwareReportsStorageDeviceCompliance
SettingsClustersSoftwareReportsFirmwareVersionMatchingCriteria
SettingsClustersSoftwareReportsService
SettingsClustersSoftwareReportsPciDeviceComplianceInfo
SettingsClustersSoftwareReportsStorageDeviceInfo
SettingsClustersSoftwareReportsPciDeviceCompliance
SettingsDepotsMetadataInfo
SettingsDepotsAffectedDesiredStateInfo
SettingsDepotsUpdateSummary
SettingsDepotsSolutionVersion
SettingsDepotsAddonSummary
SettingsDepotsHardwareSupportPackageVersion
SettingsDepotsComponentSummary
SettingsDepotsComponentVersion
SettingsDepotsHardwareSupportPackageSummary
SettingsDepotsAddonVersion
SettingsDepotsSolutionSummary
SettingsDepotsBaseImageVersion
SettingsDepotsHardwareSupportManagerSummary
SettingsDepotsAffectedBaselineInfo
Main Menu
ESX REST APIs
Getting Started
Authentication
API Categories
HCL
Collapse
Hosts
Collapse
Settings
Collapse
Data Structures
REST API Index
Feedback
Was this page helpful?
Yes
No
Your feedback will be directly sent to the engineers.
Submit
Cookie Settings
