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