SDDC Manager API

SDDC Manager API What's changed in SDDC Manager API

What's changed in SDDC Manager API

These are all the changes between the current version and the previous version

Total Changes
444
New Operations
50
New Structures
100
Update Operations
25
Update Structures
65
Deprecated Operations
32
Deprecated Structures
1
Deleted Operations
38
Deleted Structures
48

Operation Changes

New Operations

GET
Get Avi LBClusters
POST
Deploy ALBCluster
GET
Get Cluster Capacity For ALBDeployment
POST
Validate ALBCompatibility
GET
Get ALBClusters Form Factors_1
POST
Validate ALBController Cluster Creation Spec
DELETE
Undeploy ALBCluster
GET
Get Avi LBCluster
GET
Get Bundle Download Status
GET
Get Cluster Image Compliance
GET
Get Domain Capabilities
PATCH
Set Auto Renew Configuration
POST
Synchronization
GET
Get Brownfield Sync Task By Id
GET
Get Domain Capabilities By Domain Id
GET
Get Domain Datacenters
PATCH
Enable Overlay Over Management Network
PATCH
Set Auto Renew Configuration For Domain
GET
Get Notifications
POST
Scale Out Nsx
GET
Get Vpc Configuration
GET
Get Projects
GET
Get Vpc Connectivity Profiles
POST
Upload Product Binary
POST
Upload Product Version Catalog With Signature
PATCH
Update Product Version Catalog Patches
GET
Get Product Version Catalog Content
GET
Get Product Version Catalog Upload Task
GET
Get Custom Patches By Sku
GET
Get Release Components By Sku
POST
Import
POST
Validation
GET
Get Brownfield Check Task By Id
GET
Get Brownfield Import Task By Id
GET
Get Appliance Info
PATCH
Sync UMDS
GET
Get Depot Sync Info
PATCH
Sync Depot Metadata
GET
Get System Vcf Management Components
GET
Get Upgrade Preview
POST
Initiate Repository Images Query
GET
Get Repository Images Query Response
POST
Deploy Vcf Management Components
GET
Get Vcf Management Components
GET
Get Vcf Management Components Tasks
GET
Get Vcf Management Components Latest Task
GET
Get Vcf Management Components Task By ID
GET
Get Vcf Management Components Task Spec
POST
Validate Vcf Management Components
GET
Get Vcf Management Components Validations By Id

Updated Operations

DELETE
Delete Bundle
Parameter added
Parameter binaryFilesOnly
Response added
Response with Status Code 204
Response deleted
Response with Status Code 202
PATCH
Update Cluster
Response added
Response with Status Code 200
GET
Get Compatibility Matrix Content
Response added
Response with Status Code 400
GET
Get Compatibility Matrix Metadata
Response added
Response with Status Code 400
GET
Get Compatibility Matrix
Response added
Response with Status Code 400
GET
Get Compatibility Matrices
Response added
Response with Status Code 400
GET
Get Configs
Parameter added
Parameter includeFailed
GET
Get Hosts
Parameter added
Parameter fqdn
Parameter added
Parameter size
Parameter added
Parameter page
POST
Save Manifest
Response added
Response with Status Code 409
GET
Get Nsx Clusters
Parameter added
Parameter vCenterVersion
DELETE
Delete Personality
Response added
Response with Status Code 400
GET
Get Personalities
Parameter added
Parameter type
Parameter added
Parameter size
Parameter added
Parameter page
Parameter added
Parameter sort
GET
Get Custom Patches
Parameter deleted
Parameter vxrailReleaseVersion
Response added
Response with Status Code 500
Response added
Response with Status Code 404
Response added
Response with Status Code 422
Response added
Response with Status Code 400
PATCH
Update Release By Domain ID
Response added
Response with Status Code 400
Response added
Response with Status Code 422
GET
Get Releases
Parameter added
Parameter versionGe
Parameter added
Parameter minInstallerVersionLe
Parameter added
Parameter includeOnlyCompatible
Parameter deleted
Parameter vxRailVersionEq
Parameter deleted
Parameter vxRailVersionGt
Parameter deleted
Parameter applicableForVxRailVersion
Response added
Response with Status Code 403
GET
Get Sddc Manager Upgradables
Response added
Response with Status Code 501
GET
Get Backup Location
Parameter added
Parameter serverIp
Parameter deleted
Parameter serverIP
GET
Get Upgradables
Response added
Response with Status Code 409
Response added
Response with Status Code 408
GET
Get Tasks
Parameter added
Parameter doLiveRefresh
GET
Get Upgrade Precheck By ID
Response added
Response with Status Code 404
POST
Start Upgrade Precheck
Response added
Response with Status Code 404
PATCH
Update Upgrade Schedule
Response added
Response with Status Code 400
Response added
Response with Status Code 409
GET
Get Upgrades
Response added
Response with Status Code 409
POST
Perform Upgrade
Response added
Response with Status Code 404
PATCH
Update Vsan Hcl Configuration
Response deleted
Response with Status Code 200

Deprecated Operations

POST
Upload Bundle
GET
Get Host Query Response_1
GET
Get Host Criteria
GET
Get Host Criterion
POST
Post Host Query
POST
Post Query
GET
Get Host Query Response
GET
Get Identity Precheck Result
GET
Get Sddc Ws1b Oidc Info
GET
Get Identity Providers
POST
Add External Identity Provider
GET
Get Identity Provider By Id
PATCH
Update External Identity Provider
DELETE
Delete External Identity Provider
POST
Add Embedded Identity Source
DELETE
Delete Identity Source
PATCH
Update Embedded Identity Source
POST
Generate Sync Client Token
GET
Get ALBClusters
POST
Create ALBCluster
GET
Get ALBClusters Form Factors
POST
Validate ALBCluster Creation Spec
POST
Validate Nsx ALBCompatibility
GET
Get ALBCluster
DELETE
Delete ALBCluster
POST
Upload Product Version Catalog
GET
Get Product Version Catalog
PUT
Update Version Alias Configurations
GET
Get Version Alias Configuration
DELETE
Delete Version Alias By Software Type
DELETE
Delete Alias Versions By Software Type And Base Version
PUT
Update Version Alias Configuration

Deleted Operations

GET
Get Avns
POST
Create Avns
POST
Validate Avn Spec
PATCH
Update Bundle Compatibility Sets
PUT
Upload Certificates
PATCH
Rename Personality By Id
GET
Get Bringup Tasks
POST
Start Bringup
GET
Get Bringup App Info
POST
Validate Bringup Spec
GET
Get Bringup Validations
PATCH
Retry Bringup Validation
GET
Get Bringup Validation
GET
Export Bringup Validation Report
GET
Get Bringup Task By ID
PATCH
Retry Sddc
GET
Export Bringup Detail Report
GET
Get Sddc Manager Info
POST
Start Precheck
GET
Get Precheck Task
POST
Start Bringup Spec Conversion
GET
Get Vras
PUT
Connect Vrli With Domain
GET
Get Vrli Integrated Domains
GET
Get Vrlis
GET
Get Vrops Integrated Domains
PUT
Connect Vrops With Domain
GET
Get Vropses
DELETE
Rollback Vrslcm
GET
Get Vrslcm
PUT
Update Vrslcm Version In Inventory
GET
Get Vrslcm Status
GET
Get Vrslcms
POST
Deploy Vrslcm
POST
Validate Vrslcm
GET
Get Vrslcm Validation
PUT
Update Vrslcm Version By Id In Inventory
GET
Get Wsas

Data Structure Changes

New Structures

ALBCluster
AddOn
AlbControllerClusterSpec
AlbControllerNodeSpec
AlbVersionValidationSpec
AlternativeImage
AlternativeImageInfo
ApplianceInfo
BaseImage
BreakElmSpec
BrownfieldCheckSpec
BrownfieldImportSpec
BrownfieldSyncSpec
BrownfieldTask
BundleDownloadStatusInfo
BundleReference
Cidr
ClusterImageCompliance
ClusterImageComplianceCheckSpec
ClusterImageComplianceDetail
ClusterImageReference
ClusterTransitionSpec
Component
ConfigApplicabilityStatus
CustomPatch
CustomPatchArtifact
CustomPatchBundleInfo
CustomPatches
Datacenter
DepotSyncInfo
DocumentationLink
DomainCapabilities
DomainResourceCertificatesUpdateSpec
DomainsWithCapabilities
DtgwSpec
FirmwareAndDriverPackage
Gpu
HostBundleDepotUpdateSpec
HostHardware
HostHardwareInfo
HostPrecheckDetails
ImageSelectionInfo
Lag
LagSpec
Message
NotifiableDomain
NotifiableResource
Notification
NsxDeploymentSpec
PageDomainCapabilities
PageOfALBCluster
PageOfBundleDownloadStatusInfo
PageOfDatacenter
PageOfReleaseComponentDetail
PageRepositoryImage
ProductBinary
ProductBinaryUploadSpec
ProductReleaseComponent
ProductTypeInfo
ProductVersionCatalogUploadTask
ProductVersionCatalogWithSignatureSpec
QuickPatchCompatibleVersion
ReleaseComponentDetail
RemediationFailureAction
RemediationOptionsSpec
RepositoryImage
RepositoryImageId
RepositoryImageQueryResponse
RepositoryImageQuerySpec
RepositoryImageSoftware
ResourceCertificatesUpdateSpec
ResourceError
SDDCResource
SelectionCriteria
Solution
SupervisorActivationSpec
SupervisorManagementNetwork
SupervisorManagementNetworkDetails
SupervisorVpcNetwork
UpgradeEligibilityResult
UpgradeGuardrailResult
UpgradeItem
UpgradePreview
VcfAutomation
VcfAutomationSpec
VcfManagementComponents
VcfManagementComponentsInfrastructureSpec
VcfManagementComponentsNetworkSpec
VcfManagementComponentsSpec
VcfOperations
VcfOperationsCollector
VcfOperationsCollectorSpec
VcfOperationsFleetManagement
VcfOperationsFleetManagementSpec
VcfOperationsNode
VcfOperationsNodeDetails
VcfOperationsSpec
VpcConfiguration
VpcSpec
VsanSiteAffinity

Updated Structures

AuthenticatedResource
Property resourceIp changed
deprecated from false to true
BundleUpdateSpec
Property deleted
compatibilitySetsFilePath
Certificate
Property added
autoRenewFailureMessage
Property added
caType
Property added
autoRenew
Property added
autoRenewStatus
Property added
domainId
CertificateAuthority
Property added
autoRenewalConfiguredCount
CertificatesGenerationSpec
Property added
validity
Cluster
Property added
configManagerEnabled
Property added
isImported
Property added
datacenter
Property primaryDatastoreName changed
deprecated from false to true
ClusterSpec
Property added
supervisorActivationSpec
Property added
datacenterName
Property deleted
vxRailDetails
ClusterUpdateSpec
Property added
clusterTransitionSpec
Property added
clusterImageComplianceCheckSpec
ConfigDriftSpec
Property added
applicabilityStatus
CredentialsSubTask
Property added
completionTimestamp
CredentialsTask
Property added
completionTimestamp
DepotAccount
Property added
downloadToken
Domain
Property deleted
vropsIntegrationStatus
Property deleted
vrliIntegrationStatus
Property deleted
vraIntegrationStatus
DomainCreationSpec
Property added
existingDatastoreName
DomainFutureRelease
Property added
minInstallerVersion
DomainRelease
Property deleted
targetVxRailVersion
DomainReleaseView
Property deleted
targetVxRailVersion
DomainUpdateSpec
Property added
breakElmSpec
EdgeCluster
Property added
originType
Error
Property added
remediationUrl
Property added
label
HciMeshData
Property added
clusterMorId
HealthSummaryIncludeItems
Property precheckReport changed
deprecated from false to true
Host
Property added
gpus
Property added
vvolStorageProtocolType
Property bundleRepoDatastore changed
deprecated from false to true
Property deleted
isPrimary
Property deleted
isVsanEsaEligible
HostPrechecks
Property added
hostPrecheckDetails
Property deleted
host
HostReference
Property ipAddress changed
deprecated from false to true
HostSpec
Property ipAddress changed
deprecated from false to true
LocalUser
Property apiKey changed
deprecated from false to true
Logs
Property deleted
vxrailManagerLogs
NasVolumeSpec
Property added
enableBindToVmknic
NetworkDetailsSpec
Property ipAddress changed
deprecated from false to true
NetworkPool
Property added
hostsCount
NsxALBCluster
Property clusterIpAddress changed
deprecated from false to true
NsxAlbControllerClusterSpec
Property clusterIpAddress changed
deprecated from false to true
Property domainIds changed
deprecated from false to true
NsxAlbVersionValidationSpec
Property domainIds changed
deprecated from false to true
NsxTCluster
Property vip changed
deprecated from false to true
NsxTClusterReference
Property vip changed
deprecated from false to true
NsxTManager
Property ipAddress changed
deprecated from false to true
NsxTSpec
Property added
vpcSpec
Property added
nsxManagerRootPassword
Property vip changed
deprecated from false to true
NsxtManagerSpec
Property deleted
ip
NsxtSwitchConfig
Property added
ipAssignmentType
NsxtSwitchConfiguration
Property added
ipAssignmentType
Page
Property elements changed
type from EdgeClusterNsxtEntityCriterion to SddcManagerUpgradable
Patch
Property added
releaseDate
Personality
Property added
type
PersonalitySpec
Property hardwareSupportSpecs changed
deprecated from false to true
PersonalityUploadSpecReferred
Property added
clusterMorId
Property added
vCenterImageId
Portgroup
Property added
id
ProductVersion
Property added
automatedInstall
Property added
lifecycleManagedBy
Property added
changeId
Psc
Property ipAddress changed
deprecated from false to true
ReconciliationForResource
Property added
applyFixes
Property added
configDriftIds
Release
Property added
minInstallerVersion
SddcHostSpec
Property deleted
association
Property deleted
ipAddressPrivate
Property deleted
vSwitch
SddcManager
Property ipAddress changed
deprecated from false to true
SddcNsxtSpec
Property added
version
Property added
enableEdgeClusterSync
Property added
skipNsxOverlayOverManagementNetwork
Property added
sslThumbprint
Property added
useExistingDeployment
Property deleted
vip
Property deleted
nsxtLicense
Property deleted
overLayTransportZone
SoftwareInfo
Property added
removedComponents
Property added
alternativeImages
SubTask
Property added
documentationLink
User
Property apiKey changed
deprecated from false to true
ValidationCheck
Property added
acknowledge
Vcenter
Property added
status
Property ipAddress changed
deprecated from false to true
Vds
Property added
lags
VdsConfiguration
Property added
lags
VdsSpec
Property added
lagSpecs
VsanMaxConfig
Property added
enableVsanExternalNetwork
VsanRemoteDatastoreClusterSpec
Property added
primaryAzName
Property added
isStretched
VsanRemoteDatastoreSpec
Property added
networkTopology
Property added
siteAffinity

Deprecated Structures

HardwareSupportSpec

Deleted Structures

Avn
AvnsCreationSpec
DnsSpec
DomainIntegration
DvsSpec
IpAllocation
NiocSpec
NsxtTransportZone
PageOfDomainIntegration
PageOfSddcTask
PageOfValidation
PageOfVra
PageOfVrli
PageOfVrops
PageOfVrslcm
PageOfWsa
PrecheckSpec
ProxySpec
PscSpec
PscSsoSpec
ResourcePoolSpec
SddcClusterSpec
SddcManagerInfo
SddcManagerSpec
SddcNetworkSpec
SddcSpec
SddcSubTask
SddcTask
SddcVcenterSpec
UnmanagedResourceCredential
VmnicToUplink
Vra
VrealizeProductNode
Vrli
Vrops
VropsNode
Vrslcm
VrslcmDeploymentSpec
VrslcmOperationStatus
VrslcmStatus
VsanEsaConfig
VsanSpec
VxManagerSpec
VxRailArrayAssociationContext
VxRailContext
VxRailCustomArrayContext
VxRailDetails
Wsa