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
AccessConsolecliGetResponseBody
AccessDcuiGetResponseBody
AccessDcuiSetRequestBody
AccessShellShellConfig
AccessShellGetResponseBody
AccessShellSetRequestBody
AccessSshSetRequestBody
AccessSshGetResponseBody
HealthMessagesResponseBody
LocalAccountsUpdateRequestBody
LocalAccountsConfig
LocalAccountsInfo
LocalAccountsUpdateConfig
LocalAccountsCreateRequestBody
LocalAccountsGetResponseBody
LocalAccountsListResponseBody
LocalAccountsSetRequestBody
MonitoringQueryResponseBody
MonitoringMonitoredItemDataRequest
MonitoringMonitoredItem
MonitoringMonitoredItemData
MonitoringIntervalType
MonitoringFunctionType
MonitoringGetResponseBody
MonitoringListResponseBody
NetworkingGetResponseBody
NetworkingInfo
NetworkingUpdateSpec
NetworkingChangeTaskRequestBody
NetworkingDNSInfo
NetworkingInterfacesIpv4Config
NetworkingChangeTaskResponseBody
NetworkingChangeSpec
NetworkingDNSInfoDNSMode
NetworkingUpdateRequestBody
NetworkingDnsServersDNSServerConfig
NetworkingInterfacesIpv6Config
NtpTestRunStatus
NtpLocalizableMessage
NtpServerStatus
NtpGetResponseBody
NtpSetRequestBody
NtpTestRequestBody
NtpTestResponseBody
RecoveryInfo
RecoveryGetResponseBody
ServicesState
ServicesGetResponseBody
ServicesListResponseBody
ServicesInfo
ShutdownShutdownConfig
ShutdownGetResponseBody
ShutdownPoweroffRequestBody
ShutdownRebootRequestBody
TimesyncTimeSyncMode
TimesyncGetResponseBody
TimesyncSetRequestBody
UpdateInfo
UpdateState
UpdateGetResponseBody
TaskInfo
HealthApplmgmtGetResponseBody
HealthDatabasestorageGetResponseBody
HealthDatabasestorageHealthLevel
HealthLoadGetResponseBody
HealthLoadHealthLevel
HealthMemHealthLevel
HealthMemGetResponseBody
HealthSoftwarepackagesHealthLevel
HealthSoftwarepackagesGetResponseBody
HealthStorageHealthLevel
HealthStorageGetResponseBody
HealthSwapGetResponseBody
HealthSwapHealthLevel
HealthSystemHealthLevel
HealthSystemGetResponseBody
HealthSystemLastcheckResponseBody
InfraprofileConfigsImportProfileSpec
InfraprofileConfigsValidationStatus
InfraprofileNotifications
InfraprofileConfigsProfileInfo
InfraprofileConfigsValidationResult
InfraprofileConfigsProfilesSpec
LocalAccountsPolicyInfo
LocalAccountsPolicyGetResponseBody
LocalAccountsPolicySetRequestBody
LoggingForwardingTestRequestBody
LoggingForwardingTestResponseBody
LoggingForwardingConnectionStatusState
LoggingForwardingConnectionStatus
LoggingForwardingConfig
LoggingForwardingProtocol
LoggingForwardingGetResponseBody
LoggingForwardingSetRequestBody
NetworkingInterfacesIpv6Info
NetworkingInterfacesInterfaceInfo
NetworkingInterfacesInterfaceStatus
NetworkingInterfacesGetResponseBody
NetworkingInterfacesListResponseBody
NetworkingInterfacesIpv4Info
NetworkingNoProxyGetResponseBody
NetworkingNoProxySetRequestBody
NetworkingProxyGetResponseBody
NetworkingProxyTestResponseBody
NetworkingProxyConfig
NetworkingProxyServerStatus
NetworkingProxyListResponseBody
NetworkingProxySetRequestBody
NetworkingProxyTestResult
NetworkingProxyProtocol
NetworkingProxyTestRequestBody
NetworkingDnsDomainsAddRequestBody
NetworkingDnsDomainsListResponseBody
NetworkingDnsDomainsSetRequestBody
NetworkingDnsHostnameGetResponseBody
NetworkingDnsHostnameSetRequestBody
NetworkingDnsHostnameTestRequestBody
NetworkingDnsHostnameTestResponseBody
NetworkingDnsHostnameMessage
NetworkingDnsHostnameTestStatusInfo
NetworkingDnsHostnameMessageStatus
NetworkingDnsHostnameTestStatus
NetworkingDnsServersTestRequestBody
NetworkingDnsServersTestStatus
NetworkingDnsServersAddRequestBody
NetworkingDnsServersTestResponseBody
NetworkingDnsServersMessageStatus
NetworkingDnsServersSetRequestBody
NetworkingDnsServersMessage
NetworkingDnsServersTestStatusInfo
NetworkingDnsServersDNSServerMode
NetworkingDnsServersGetResponseBody
NetworkingFirewallInboundGetResponseBody
NetworkingFirewallInboundSetRequestBody
NetworkingFirewallInboundRule
NetworkingFirewallInboundPolicy
NetworkingInterfacesIpv4Mode
NetworkingInterfacesIpv4GetResponseBody
NetworkingInterfacesIpv4SetRequestBody
NetworkingInterfacesIpv6Status
NetworkingInterfacesIpv6GetResponseBody
NetworkingInterfacesIpv6SetRequestBody
NetworkingInterfacesIpv6Address
NetworkingInterfacesIpv6AddressInfo
NetworkingInterfacesIpv6Origin
RecoveryBackupValidateRequestBody
RecoveryBackupValidateResponseBody
RecoveryBackupLocalizableMessage
RecoveryBackupReturnResult
RecoveryBackupBackupRequest
RecoveryBackupLocationType
RecoveryBackupReturnStatus
RecoveryRestoreValidateResponseBody
RecoveryRestoreRestoreRequest
RecoveryRestoreMetadata
RecoveryRestoreLocalizableMessage
RecoveryRestoreLocationType
RecoveryRestoreValidateRequestBody
RecoveryBackupJobGetResponseBody
RecoveryBackupJobReturnResult
RecoveryBackupJobLocalizableMessage
RecoveryBackupJobCreateRequestBody
RecoveryBackupJobListResponseBody
RecoveryBackupJobBackupRestoreProcessState
RecoveryBackupJobCreateResponseBody
RecoveryBackupJobBackupJobStatus
RecoveryBackupJobReturnStatus
RecoveryBackupJobCancelResponseBody
RecoveryBackupJobBackupRequest
RecoveryBackupJobLocationType
RecoveryBackupPartsPart
RecoveryBackupPartsLocalizableMessage
RecoveryBackupPartsGetResponseBody
RecoveryBackupPartsListResponseBody
RecoveryBackupSchedulesRunResponseBody
RecoveryBackupSchedulesUpdateRequestBody
RecoveryBackupSchedulesUpdateSpec
RecoveryBackupSchedulesCreateSpec
RecoveryBackupSchedulesRecurrenceInfo
RecoveryBackupSchedulesRetentionInfo
RecoveryBackupSchedulesListResponseBody
RecoveryBackupSchedulesRunRequestBody
RecoveryBackupSchedulesInfo
RecoveryBackupSchedulesDayOfWeek
RecoveryBackupSchedulesCreateRequestBody
RecoveryBackupSchedulesGetResponseBody
RecoveryBackupSystemNameListResponseBody
RecoveryBackupJobDetailsType
RecoveryBackupJobDetailsListResponseBody
RecoveryBackupJobDetailsInfo
RecoveryBackupJobDetailsFilterSpec
RecoveryBackupJobDetailsBuildInfo
RecoveryBackupSystemNameArchiveGetResponseBody
RecoveryBackupSystemNameArchiveListResponseBody
RecoveryBackupSystemNameArchiveInfo
RecoveryBackupSystemNameArchiveFilterSpec
RecoveryBackupSystemNameArchiveSummary
RecoveryReconciliationJobCreateResponseBody
RecoveryReconciliationJobGetResponseBody
RecoveryReconciliationJobInfo
RecoveryReconciliationJobCreateSpec
RecoveryReconciliationJobStatus
RecoveryReconciliationJobCreateRequestBody
RecoveryRestoreJobReturnResult
RecoveryRestoreJobLocationType
RecoveryRestoreJobRestoreRequest
RecoveryRestoreJobCreateRequestBody
RecoveryRestoreJobCancelResponseBody
RecoveryRestoreJobCreateResponseBody
RecoveryRestoreJobRestoreJobStatus
RecoveryRestoreJobBackupRestoreProcessState
RecoveryRestoreJobGetResponseBody
RecoveryRestoreJobLocalizableMessage
RecoveryRestoreJobReturnStatus
SystemStorageListResponseBody
SystemStorageResizeExResponseBody
SystemStorageStorageChange
SystemStorageStorageMapping
SystemTimeGetResponseBody
SystemTimeSystemTimeStruct
SystemUptimeGetResponseBody
SystemVersionVersionStruct
SystemVersionGetResponseBody
SystemSecurityGlobalFipsUpdateSpec
SystemSecurityGlobalFipsInfo
SystemTimeTimezoneSetRequestBody
SystemTimeTimezoneGetResponseBody
UpdatePendingValidateResponseBody
UpdatePendingListResponseBody
UpdatePendingStageAndInstallRequestBody
UpdatePendingPrecheckResult
UpdatePendingInfo
UpdatePendingQuestionInputType
UpdatePendingSourceType
UpdatePendingGetResponseBody
UpdatePendingQuestion
UpdatePendingValidateRequestBody
UpdatePendingInstallRequestBody
UpdatePendingPrecheckResponseBody
Notifications
UpdatePolicyDayOfWeek
UpdatePolicyGetResponseBody
UpdatePolicySetRequestBody
UpdatePolicyTime
UpdatePolicyConfig
UpdatePolicyInfo
UpdateStagedInfo
UpdateStagedGetResponseBody
VcenterSettingsV1ConfigCreateSpec
VcenterSettingsV1ConfigInfo
VcenterSettingsV1DesiredState
VcenterSettingsV1Notifications
VcenterSettingsV1ConfigScanSpec
VmonServiceGetResponseBody
VmonServiceListDetailsResponseBody
VmonServiceUpdateRequestBody
VmonServiceInfo
VmonServiceUpdateSpec
VmonServiceStartupType
VmonServiceHealth
VmonServiceState
SubtaskInfo
Notification
InfraprofileTaskInfo
InfraprofileNotification
UpdateSummary
UpdateCommonInfoPriority
UpdateCommonInfoSeverity
UpdateCommonInfoCategory
UpdateCommonInfo
UpdateServiceInfo
VcenterSettingsV1Notification
VcenterSettingsV1DiffResult
VcenterSettingsV1ScanResult
VcenterSettingsV1TaskInfo
VcenterSettingsV1ComplianceResult
VcenterSettingsV1ScanResultComplianceStatus
VcenterSettingsV1ConfigComponentsApplmgmtTimezone
VcenterSettingsV1ConfigComponentsApplmgmtApplianceNetwork
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfigurationDNSServerMode
VcenterSettingsV1ConfigComponentsApplmgmtConsolecli
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicy
VcenterSettingsV1ConfigComponentsApplmgmtSsh
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfigurationProtocol
VcenterSettingsV1ConfigComponentsApplmgmtTimeUpdateDay
VcenterSettingsV1ConfigComponentsApplmgmtTime
VcenterSettingsV1ConfigComponentsApplmgmtTimesync
VcenterSettingsV1ConfigComponentsApplmgmtDnsServerConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfoDayOfWeek
VcenterSettingsV1ConfigComponentsApplmgmtProxyConfiguration
VcenterSettingsV1ConfigComponentsApplmgmtFirewallRulePolicyPolicy
VcenterSettingsV1ConfigComponentsApplmgmtShell
VcenterSettingsV1ConfigComponentsApplmgmtRecurrenceInfo
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccountsPolicy
VcenterSettingsV1ConfigComponentsApplmgmtNtp
VcenterSettingsV1ConfigComponentsApplmgmtRetentionInfo
VcenterSettingsV1ConfigComponentsApplmgmtLogForwarding
VcenterSettingsV1ConfigComponentsApplmgmtApplianceManagement
VcenterSettingsV1ConfigComponentsApplmgmtLocalAccounts
VcenterSettingsV1ConfigComponentsApplmgmtDcui
VcenterSettingsV1ConfigComponentsApplmgmtTimesyncTimeSyncMode
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicy
VcenterSettingsV1ConfigComponentsApplmgmtLogForwardingProtocol
VcenterSettingsV1ConfigComponentsApplmgmtBackupSchedule
VcenterSettingsV1ConfigComponentsApplmgmtSoftwareUpdatePolicyAutoUpdateNotification
VcenterSettingsV1ConfigComponentsApplmgmtSmtp
VcenterSettingsV1ConfigComponentsAuthmanagementPrincipal
VcenterSettingsV1ConfigComponentsAuthmanagementAuthenticationManagement
VcenterSettingsV1ConfigComponentsAuthmanagementPrivileges
VcenterSettingsV1ConfigComponentsAuthmanagementRoles
VcenterSettingsV1ConfigComponentsAuthmanagementGlobalPermission
VcenterSettingsV1ConfigComponentsAuthmanagementTokenPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementLockoutPolicy
VcenterSettingsV1ConfigComponentsAuthmanagementPasswordPolicy
RecoveryBackupLocationSpec
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
System
Collapse
Update
Collapse
vCenter
Collapse
vMon
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
