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