VMware Developer Documentation
BETA
API Reference
PowerCLI Reference
vSphere Automation API
Appliance REST APIs
Appliance REST APIs Data Structures
vAPI Error
REST Error
AccessConsolecliSetRequestBody
StdErrorsError
AccessDcuiSetRequestBody
AccessShellShellConfig
AccessSshSetRequestBody
Notification
HealthCheckSettingsSettingSpec
HealthCheckSettingsUpdateSpec
LocalAccountsConfig
LocalAccountsInfo
LocalAccountsUpdateConfig
LocalAccountsCreateRequestBody
MonitoringMonitoredItem
MonitoringMonitoredItemData
MonitoringIntervalType
MonitoringFunctionType
MonitoringMonitoredItemDataRequest
NetworkingInfo
NetworkingUpdateSpec
NetworkingChangeSpec
NetworkingDNSInfoDNSMode
NetworkingDNSInfo
NetworkingDnsServersDNSServerConfig
NetworkingInterfacesIpv6Config
NetworkingInterfacesIpv4Config
NtpTestRunStatus
NtpLocalizableMessage
NtpServerStatus
NtpSetRequestBody
NtpTestRequestBody
RecoveryInfo
InlineApiApplianceServices200Response
ServicesInfo
ServicesState
ShutdownRebootRequestBody
ShutdownShutdownConfig
ShutdownPoweroffRequestBody
SupportBundleIterationSpec
SupportBundleCreateSpec
SupportBundleFilterSpec
SupportBundleInfo
SupportBundleCreationStatus
SupportBundleListResult
TimesyncSetRequestBody
TimesyncTimeSyncMode
UpdateState
TaskInfo
UpdateInfo
HealthDatabaseMessageSeverity
HealthDatabaseMessage
HealthDatabaseInfoStatus
HealthDatabaseInfo
HealthDatabasestorageHealthLevel
HealthLoadHealthLevel
HealthMemHealthLevel
HealthSoftwarepackagesHealthLevel
HealthStorageHealthLevel
HealthSwapHealthLevel
HealthSystemHealthLevel
InfraprofileConfigsImportProfileSpec
InfraprofileConfigsValidationStatus
InfraprofileNotifications
InfraprofileConfigsProfileInfo
InfraprofileConfigsValidationResult
InfraprofileConfigsProfilesSpec
LocalAccountsPolicyInfo
LoggingForwardingConfig
LoggingForwardingProtocol
LoggingForwardingSetRequestBody
LoggingForwardingTestRequestBody
LoggingForwardingConnectionStatusState
LoggingForwardingConnectionStatus
NetworkingInterfacesIpv6Info
NetworkingInterfacesInterfaceInfo
NetworkingInterfacesInterfaceStatus
NetworkingInterfacesIpv4Info
NetworkingNoProxySetRequestBody
NetworkingProxyConfig
NetworkingProxyTestResult
NetworkingProxyServerStatus
NetworkingProxyProtocol
NetworkingProxyTestRequestBody
InlineApiApplianceNetworkingProxy200Response
NetworkingDnsDomainsAddRequestBody
NetworkingDnsDomainsSetRequestBody
NetworkingDnsHostnameTestStatusInfo
NetworkingDnsHostnameMessageStatus
NetworkingDnsHostnameTestStatus
NetworkingDnsHostnameSetRequestBody
NetworkingDnsHostnameTestRequestBody
NetworkingDnsHostnameMessage
NetworkingDnsServersMessage
NetworkingDnsServersTestStatusInfo
NetworkingDnsServersDNSServerMode
NetworkingDnsServersTestStatus
NetworkingDnsServersMessageStatus
NetworkingDnsServersAddRequestBody
NetworkingDnsServersTestRequestBody
NetworkingFirewallInboundSetRequestBody
NetworkingFirewallInboundRule
NetworkingFirewallInboundPolicy
NetworkingInterfacesIpv4Mode
NetworkingInterfacesIpv6Origin
NetworkingInterfacesIpv6Status
NetworkingInterfacesIpv6Address
NetworkingInterfacesIpv6AddressInfo
RecoveryBackupLocationType
RecoveryBackupReturnStatus
RecoveryBackupLocalizableMessage
RecoveryBackupReturnResult
RecoveryBackupBackupRequest
RecoveryRestoreLocalizableMessage
RecoveryRestoreLocationType
RecoveryRestoreRestoreRequest
RecoveryRestoreMetadata
RecoveryBackupJobBackupRequest
RecoveryBackupJobBackupJobStatus
RecoveryBackupJobReturnStatus
RecoveryBackupJobBackupRestoreProcessState
RecoveryBackupJobLocationType
RecoveryBackupJobReturnResult
RecoveryBackupJobLocalizableMessage
RecoveryBackupPartsPart
RecoveryBackupPartsLocalizableMessage
InlineApiApplianceRecoveryBackupSchedules200Response
RecoveryBackupSchedulesRecurrenceInfo
RecoveryBackupSchedulesRetentionInfo
RecoveryBackupSchedulesCreateSpec
RecoveryBackupSchedulesInfo
RecoveryBackupSchedulesCreateRequestBody
RecoveryBackupSchedulesDayOfWeek
RecoveryBackupSchedulesRunRequestBody
RecoveryBackupSchedulesUpdateSpec
InlineApiApplianceRecoveryBackupJobDetails200Response
RecoveryBackupJobDetailsType
RecoveryBackupJobDetailsInfo
RecoveryBackupJobDetailsFilterSpec
RecoveryBackupJobDetailsBuildInfo
RecoveryBackupLocationSpec
RecoveryBackupSystemNameArchiveSummary
RecoveryBackupSystemNameArchiveListRequestBody
RecoveryBackupSystemNameArchiveInfo
RecoveryBackupSystemNameArchiveFilterSpec
RecoveryReconciliationJobInfo
RecoveryReconciliationJobCreateSpec
RecoveryReconciliationJobStatus
RecoveryRestoreJobRestoreRequest
RecoveryRestoreJobLocalizableMessage
RecoveryRestoreJobReturnResult
RecoveryRestoreJobRestoreJobStatus
RecoveryRestoreJobLocationType
RecoveryRestoreJobReturnStatus
RecoveryRestoreJobBackupRestoreProcessState
InlineApiApplianceSupportBundleComponents200Response
InlineApiApplianceSupportBundleComponents200ResponseMap
SystemStorageStorageChange
SystemStorageStorageMapping
InlineApiApplianceSystemStorageActionResizeEx200Response
SystemTimeSystemTimeStruct
SystemVersionVersionStruct
SystemSecurityGlobalFipsInfo
SystemSecurityGlobalFipsUpdateSpec
SystemTimeTimezoneSetRequestBody
UpdatePendingStageAndInstallRequestBody
UpdatePendingValidateRequestBody
UpdatePendingInfo
UpdatePendingSourceType
UpdatePendingInstallRequestBody
UpdateCommonInfoPriority
UpdateCommonInfoCategory
UpdateCommonInfoSeverity
UpdatePendingPrecheckResult
UpdatePendingQuestionInputType
UpdatePendingQuestion
Notifications
UpdateSummary
UpdatePolicyTime
UpdatePolicyConfig
UpdatePolicyInfo
UpdatePolicyDayOfWeek
UpdateStagedInfo
VcenterSettingsV1ConfigCheckSpec
VcenterSettingsV1ConfigApplySpec
VcenterSettingsV1ConfigCreateSpec
VcenterSettingsV1DesiredState
VcenterSettingsV1ConfigScanSpec
VcenterSettingsV1ConfigInfo
VcenterSettingsV1ConfigApplyDesiredStateSpec
VcenterSettingsV1ConfigApplyStatus
VcenterSettingsV1Notifications
VcenterSettingsV1ConfigApplyResult
VcenterSettingsV1ConfigCheckDesiredStateSpec
VcenterSettingsV1ConfigCurrentInvokerType
VmonServiceState
VmonServiceInfo
VmonServiceUpdateSpec
VmonServiceStartupType
VmonServiceHealth
SubtaskInfo
InfraprofileNotification
InfraprofileTaskInfo
UpdateCommonInfo
UpdateServiceInfo
VcenterSettingsV1DiffResult
VcenterSettingsV1ComplianceResult
VcenterSettingsV1ScanResultComplianceStatus
VcenterSettingsV1Impact
VcenterSettingsV1Notification
VcenterSettingsV1TaskInfo
VcenterSettingsV1StatusType
VcenterSettingsV1ScanResult
VcenterSettingsV1ApplyImpact
VcenterSettingsV1CheckResult
VcenterSettingsV1ConfigComponentsInventoryClusterDrsDrsConfig
VcenterSettingsV1ConfigComponentsInventoryClusterDrsDrsVmOverrides
VcenterSettingsV1ConfigComponentsInventoryClusterDrsGroupDetails
VcenterSettingsV1ConfigComponentsInventoryClusterDrsProactiveHAConfigRemediationType
VcenterSettingsV1ConfigComponentsInventoryClusterDrsVmHostRule
VcenterSettingsV1ConfigComponentsInventoryClusterDrsDrsBehaviorInfo
VcenterSettingsV1ConfigComponentsInventoryClusterDrsAdditionalOptions
VcenterSettingsV1ConfigComponentsInventoryClusterDrsProactiveHAConfig
VcenterSettingsV1ConfigComponentsInventoryCommonOptionValue
VcenterSettingsV1ConfigComponentsInventoryClusterDrsPowerManagement
VcenterSettingsV1ConfigComponentsInventoryClusterDrsDpmBehaviorInfo
VcenterSettingsV1ConfigComponentsInventoryClusterDrsProactiveHAConfigBehaviorType
VcenterSettingsV1ConfigComponentsInventoryClusterDrsGroup
VcenterSettingsV1ConfigComponentsInventoryClusterDrsStatus
VcenterSettingsV1ConfigComponentsInventoryClusterDrsScaleSharesBehavior
VcenterSettingsV1ConfigComponentsInventoryClusterDrsAffinityRule
VcenterSettingsV1ConfigComponentsInventoryClusterDrsRule
VcenterSettingsV1ConfigComponentsInventoryClusterDrsDependencyRule
VcenterSettingsV1ConfigComponentsInventoryClusterDrsAutomation
VcenterSettingsV1ConfigComponentsInventoryInventoryManagement
VcenterSettingsV1ConfigComponentsInventorySettings
VcenterSettingsV1ConfigComponentsInventoryClusterClusterConfigInfo
VcenterSettingsV1ConfigComponentsInventoryClusterHaVsphereHA
VcenterSettingsV1ConfigComponentsInventoryCommonPermission
VcenterSettingsV1ConfigComponentsInventoryDatastoreStorageDrsPodConfigInfo
VcenterSettingsV1ConfigComponentsInventoryDatastoreSummary
VcenterSettingsV1ConfigComponentsInventoryDatastoreStorageDrsConfigInfo
VcenterSettingsV1ConfigComponentsInventoryDatastoreDatastore
VcenterSettingsV1ConfigComponentsInventoryDatastoreMaintenanceModeState
VcenterSettingsV1ConfigComponentsInventoryDatastoreStoragePod
VcenterSettingsV1ConfigComponentsInventoryDatastorePodStorageDrsEntry
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesRestartPriority
VcenterSettingsV1ConfigComponentsInventoryClusterHaHaVmOverrides
VcenterSettingsV1ConfigComponentsInventoryClusterHaFixedSizeSlotPolicy
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponses
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesVmReactionOnAPDCleared
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesIsolationResponse
VcenterSettingsV1ConfigComponentsInventoryClusterHaVmToolsMonitoringSettings
VcenterSettingsV1ConfigComponentsInventoryClusterHaClusterResourcePercentage
VcenterSettingsV1ConfigComponentsInventoryClusterHaHeartBeatDataStoresHBDatastoreCandidate
VcenterSettingsV1ConfigComponentsInventoryClusterHaHeartBeatDataStores
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesServiceState
VcenterSettingsV1ConfigComponentsInventoryClusterHaAdmissionControl
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesVmMonitoringState
VcenterSettingsV1ConfigComponentsInventoryClusterHaFailuresAndResponsesStorageVmReaction
VcenterSettingsV1ConfigComponentsInventoryNetworkNetwork
VcenterSettingsV1ConfigComponentsManagementclusterResourceAllocationInfo
VcenterSettingsV1ConfigComponentsManagementclusterManagementCluster
VcenterSettingsV1ConfigComponentsManagementclusterShares
VcenterSettingsV1ConfigComponentsManagementclusterResourceConfigSpec
VcenterSettingsV1ConfigComponentsManagementclusterManagementVirtualMachineManagementVMType
VcenterSettingsV1ConfigComponentsManagementclusterResourcePool
VcenterSettingsV1ConfigComponentsManagementclusterDrsConfigDrsBehaviorInfo
VcenterSettingsV1ConfigComponentsManagementclusterDrsConfig
VcenterSettingsV1ConfigComponentsManagementclusterSharesLevel
VcenterSettingsV1ConfigComponentsManagementclusterManagementVirtualMachine
VcenterSettingsV1ConfigComponentsVsphereuiconfigurationVsphereUIConfiguration
VcenterSettingsV1ConfigComponentsInventoryClusterVsanVsanConfigInfo
VcenterSettingsV1ConfigComponentsInventoryClusterVsanHostDefaultInfo
VcenterSettingsV1ConfigComponentsInventoryResourcepoolResourceAllocationInfo
VcenterSettingsV1ConfigComponentsInventoryResourcepoolResourcePoolSummary
VcenterSettingsV1ConfigComponentsInventoryResourcepoolResourcePool
VcenterSettingsV1ConfigComponentsInventoryResourcepoolSharesLevel
VcenterSettingsV1ConfigComponentsInventoryResourcepoolShares
VcenterSettingsV1ConfigComponentsApplmgmtAddress
VcenterSettingsV1ConfigComponentsApplmgmtNtp
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicy
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfoDayOfWeek
VcenterSettingsV1ConfigComponentsApplmgmtIpv4Mode
VcenterSettingsV1ConfigComponentsApplmgmtTimeUpdateDay
VcenterSettingsV1ConfigComponentsApplmgmtDatetimeConfig
VcenterSettingsV1ConfigComponentsApplmgmtInterface
VcenterSettingsV1ConfigComponentsApplmgmtTimesyncTimeSyncMode
VcenterSettingsV1ConfigComponentsApplmgmtSmtp
VcenterSettingsV1ConfigComponentsApplmgmtConsolecli
VcenterSettingsV1ConfigComponentsApplmgmtUserAccountSettings
VcenterSettingsV1ConfigComponentsApplmgmtAccessSettings
VcenterSettingsV1ConfigComponentsApplmgmtInterfaceInterfaceStatus
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccounts
VcenterSettingsV1ConfigComponentsApplmgmtAddressOrigin
VcenterSettingsV1ConfigComponentsApplmgmtIpv4
VcenterSettingsV1ConfigComponentsApplmgmtShell
VcenterSettingsV1ConfigComponentsApplmgmtApplianceManagement
VcenterSettingsV1ConfigComponentsApplmgmtSsh
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicyPolicy
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccountsPolicy
VcenterSettingsV1ConfigComponentsApplmgmtApplianceNetwork
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtTime
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfigurationProtocol
VcenterSettingsV1ConfigComponentsApplmgmtDcui
VcenterSettingsV1ConfigComponentsApplmgmtRetentionInfo
VcenterSettingsV1ConfigComponentsApplmgmtLogForwarding
VcenterSettingsV1ConfigComponentsApplmgmtBackupSchedule
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicyAutoUpdateNotification
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtTimesync
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfigurationDNSServerMode
VcenterSettingsV1ConfigComponentsApplmgmtLogForwardingProtocol
VcenterSettingsV1ConfigComponentsApplmgmtTimezone
VcenterSettingsV1ConfigComponentsApplmgmtCeip
VcenterSettingsV1ConfigComponentsApplmgmtAddressStatus
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfo
VcenterSettingsV1ConfigComponentsApplmgmtIpv6
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicy
VcenterSettingsV1ConfigComponentsAuthmanagementAuthenticationManagement
VcenterSettingsV1ConfigComponentsAuthmanagementGlobalPermission
VcenterSettingsV1ConfigComponentsAuthmanagementLockoutPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementVCGroups
VcenterSettingsV1ConfigComponentsAuthmanagementIdentitySourceType
VcenterSettingsV1ConfigComponentsAuthmanagementPrivileges
VcenterSettingsV1ConfigComponentsAuthmanagementRoles
VcenterSettingsV1ConfigComponentsAuthmanagementTokenPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementPasswordPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementIdentitySource
VcenterSettingsV1ConfigComponentsInventoryFolderFolder
VcenterSettingsV1ConfigComponentsInventoryFolderFolderDetails
VcenterSettingsV1ConfigComponentsInventoryauthorizationInventoryAuthorization
VcenterSettingsV1ConfigComponentsInventoryauthorizationPermission
VcenterSettingsV1ConfigComponentsInventoryauthorizationServiceProviderEntities
VcenterSettingsV1ConfigComponentsInventoryVmResourceAllocationInfo
VcenterSettingsV1ConfigComponentsInventoryVmConfigInfo
VcenterSettingsV1ConfigComponentsInventoryVmVirtualHardware
VcenterSettingsV1ConfigComponentsInventoryVmVirtualMachineConfig
VcenterSettingsV1ConfigComponentsInventoryDatacenterDatacenter
VcenterSettingsV1ConfigComponentsAuthcommonPrincipal
VcenterSettingsV1ConfigComponentsInventoryHostHostConfig
Main Menu
Appliance REST APIs
Getting Started
Authentication
API Categories
Access
Collapse
Appliance
Collapse
Health
Collapse
Infraprofile
Collapse
Local Accounts
Collapse
Logging
Collapse
Networking
Collapse
Recovery
Collapse
Support Bundle
Collapse
System
Collapse
Update
Collapse
vCenter
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
