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