VMware Cloud Foundation API Reference Guide Operations Index
All available VMware Cloud Foundation API Reference Guide Operations
Retrieve a list of VMware Aria Automation instances
Returns all matching AVNs
Create Application Virtual Networks (AVN)
Returns Validation report
Retrieve the backup configuration for SDDC Manager and NSX Manager
Configure the backup configuration for SDDC Manager and NSX Manager
Update the backup configuration for SDDC Manager and NSX Manager
Validation API for backup configuration for SDDC Manager and NSX Manager
Start a restore operation
Start a backup operation
Retrieve the backup location details
Retrieve the restore task
Get all Bundles i.e uploaded bundles and also bundles available via depot access.
Upload Bundle to SDDC Manager. Used when you do not have internet connectivity for downloading bundles from VMWare/VxRail to SDDC Manager. The Bundles are manually downloaded from Depot using Bundle Transfer utility
Get a Bundle
Delete a Bundle by bundle ID.
Update a Bundle for scheduling/triggering download. Only one download can triggered for a Bundle.
Update software compatibility sets for Bundles
Get bundles for skip upgrade a domain from current version to target version.
Get CEIP status and instance id
Opt-in or Opt-out of CEIP
View detailed metadata about the certificate(s) of all the resources in a domain
Replace resource certificates
Validate resource certificates
Get available CSR(s) in json format
Generate CSR(s) for the selected resource(s) in the domain.
Warning: Avoid using wildcard certificates. Instead, use subdomain-specific certificates that are rotated often. A compromised wildcard certificate can lead to security repercussions
Get latest generated certificate(s) in a domain.
Generate certificate(s) for the selected resource(s) in a domain. CA must be configured and CSR must be generated beforehand.
Replace certificate(s) for the selected resource(s) in a domain
Upload certificates to the certificate store
Get certificate authorities information
Creates a certificate authority. This is required to generate signed certificates by supporting CAs.
Update the configuration of a Certificate Authority
Get the resource certificate validation result
Download available CSR(s) in tar.gz format
Get certificate authority information
Deletes CA configuration file
Get information about the last assessment run
Trigger a run of the selected checks
Query for check-sets for the given resources
Get the result for a given check run
Trigger partial retry of a completed check run
Get tags assigned to a cluster by its ID
Assign Tags to Cluster
Remove tags from a cluster
Retrieve a list of clusters
Create a cluster and add to an existing domain
Perform validation of the ClusterUpdateSpec specification
Get cluster network configuration
Post a host query
Get the list of all datastores associated with the cluster.
Mount a datastore to a cluster
Post a datastore query
Get the list of VDSes of a cluster.
Import Vds to inventory for the given cluster
Perform validation of the DatastoreMountSpec specification
Perform validation of the DatastoreMountSpec specification
Perform validation of the ClusterCreationSpec specification
Get a cluster by its ID
Delete a cluster from a domain if it has been previously initialized for deletion
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Gets the status of given cluster updates validation workflow by given validation id
Get Cluster Tag Manager Url
Get tags assignable to a cluster
The response retrieved is only applicable for pure L2 domain clusters
Get cluster network configuration criteria
Get all host criteria
Get a criterion to query for host
Get all datastore criteria
Get a criterion to query for datastore
Get query response
Get Datastore query response
Gets the status of given cluster create validation workflow by given validation id
Get tags assigned to clusters
Unmount a datastore from a cluster
Get Compatibility Matrices
Update CompatibilityMatrix content for a source using a JSON file
Get Compatibility Matrix
Get Compatibility Matrix Metadata
Get Compatibility Matrix content
Get compliance audit history for a domain
Compliance audit of resource
Get compliance audit task
Retry compliance audit task
Get compliance audit for a domain
Get compliance audit items for a domain
Get a list of all compliance standards
Get a list of all compliance configurations
Get compliance audit history
Get compliance audit
Get compliance audit items
For selective reconciliation, provide a config spec.
Get configs associated with the given criteria, all if no criteria is provided
Get config reconciliation task associated with the given task Id
Fetch expiration details of passwords for a list of credentials
Retrieve a list of credentials
Update passwords for given list of resources by supplying new passwords or rotate the passwords using system generated passwords
Retrieve a credential task by ID
Cancel a failed credential task by its ID
Retry a failed credentials task for a given ID
Retrieve a credential by its ID
Retrieve a list of credential tasks
Retrieve a credential sub task by its ID
Retriece a credential taks by resource ID
Retrive a password expiration task by ID
Get the depot configuration. In a fresh setup, this would be empty.
Update depot settings. Depot settings can be updated with VMware Depot account
Delete the depot configuration if such is present within VCF.
Get tags assigned to a domain
Assign tags to a domain
remove Tags From Domain
Retrieve a list of domains
Create a domain
Perform validation of the DomainUpdateSpec specification
Perform Domain Isolation Prechecks
Post a datastore query
Post a cluster query
Post clusters query
Perform validation of the DomainCreationSpec specification
Get a domain by its ID
Remove a domain if it has been previously initialized for deletion
Update a Domain
Gets the status of given domain update validation workflow by given validation id
Get Domain Tag Manager Url
Get tags assignable to a domain
Retrieve a list of endpoints or URLs for a domain by its ID
Get the status of the Domain Isolation Precheck
Get Datastore query response
Get all datastore criteria
Get a criterion to query for datastore
Get cluster query response
Get clusters query response
Get all cluster criteria
Get a criterion to query for cluster
Gets the status of given domain create validation workflow by given validation id
Get tags assigned to all domains
Retrieve VCF security FIPS mode.
Filter applicable patches (current/target vcf releases) per product type per domain
Get Tags assigned to Host
Assign tags to a host
Remove Tags From Host
Get all hosts
Commission the Hosts
Decommission the Hosts
Perform validation of the HostCommissionSpec specification
Validate the input specification to commission the Hosts
Post a query
Post host(s) prechecks
Get a host by its ID
Get Host Tag Manager Url
Get tags assignable to a host
Retrieve the results of a host commission validation by its ID
Get Tags assigned to Hosts
Get query response
Get host(s) prechecks response
Get all criteria
Get a criterion
Get a list precheck result with warnings/errors
Get a list of all identity providers
Add a new external identity provider
Generates a new sync client token
Add an identity source to an embedded IDP by id, if it exists
Get a specific identity irovider using its id
Delete an Identity Provider by its identifier, if it exists
Update the identity provider by its identifier, if it exists
Delete an Identity Source by domain name, if it exists
Update the identity source associated with the embedded IDP by name, if it exists
Get the SDDC Manager WS1B OIDC Information
Update a license key for a resource
Start a license check for a resource
Retrieve a list of license keys
Add a a new license key
Update the license key
Retrieve the results of a license check by its ID
Retrieve licensing information
Get the Licensing information of system
Get the Licensing information of a domain
Retrieve a license key
Remove a license key
Get product types
Get manifest. There should be only one valid manifest in the System.
Save/Load manifest. Make sure manifest is a valid one. If manifest already exists, it gets overridden.
Get the Network Pools
Create a Network Pool
Add an IP Pool to a Network of a Network Pool
Delete an IP Pool from a Network of a Network Pool
Get a Network Pool by ID, if it exists
Delete the Network Pool by the ID, if it exists and is unused
Update a Network Pool by ID, if it exists
Get the Networks that are part of a Network Pool
Get a Network that is part of a Network Pool
Retrieve a list of NSX ALB Clusters
Create NSX ALB cluster
Perform validiation of the NsxAlbControllerClusterSpec specification
Validate NSX ALB compatibility version
Retrieve an NSX ALB Cluster by its ID
Deletes an NSX ALB Cluster by its ID
Retrieve a list of NSX ALB Clusters Form Factors
Start a query with NSX Criteria
Retrieve a list of NSX clusters
Retrieve list of all NSX transport zones
Retrive a list of NSX IP Address Pools by the NSX cluster ID
Retrieve an NSX IP Address Pool by its name
Retrieve the details of an NSX cluster by its ID
Get NSX cluster query response
Get all NSX criteria
Get a NSX criterion
Retrieve a list of NSX Edge Clusters
Create an NSX Edge Cluster
Perform validation of the EdgeClusterUpdateSpec specification
Perform validiation of the EdgeClusterCreationSpec specification
Retrieve an NSX Edge Cluster by its ID
Expand or shrink an NSX Edge Cluster
Get the Edge Cluster criterion list for the NSX query
Retrieve the results of a NSX Edge Cluster validation by its ID
Retrieve a list of VMware Aria Operations for Logs integration status for domains
Connect or disconnect a domain with VMware Aria Operations for Logs
Retrieve a list of VMware Aria Operations for Logs instances
Retrieves the existing domains and their connection status with Aria Operations.
Connects/disconnects a workload domains with VMware Aria Operations
Retrieve a list of VMware Aria Operations instances
Upload personality files to SDDC Manager
Get the Personalities which are available via depot access.
Upload Personality to SDDC Manager.
Delete the personality based on either name or id
Get the Personality for id
Rename personality with the ID passed in the URL
Get product version catalog. There should be only one valid product version catalog in the System.
Upload product version catalog. Make sure product version is a valid one.
Get the current Proxy configuration
Update Proxy configuration
Retrieve a list of Platform Service Controller (PSC)
Retrieve details of a Platform Service Controller (PSC)
Get all Releases, with option to get current release for a domain, get release by version or get future releases for a versionor get all the applicable target release.
Returns release for the lowest deployed VCF version for a domain on the environment.If Management domain is ahead of WLD domain, VCF BOM version for the WLDdomain will be returned.
Returns all known to the system future target versions for a domain. If some of them are not allowed (e.g. stepping stone) includes message why. If the domain does not have a product configured at that point, that product will not be included in the BOM or patch bundle list in each release.
Get Resource Functionalities
Update Resources Functionalities
Get Resource Functionalities Allowed Global Configuration
Update Resources Functionalities Is Allowed Global Configuration
Get Resource Warnings
Create a new Resource Warning
Get a Resource Warning by ID
SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.
Retrieve all bringup tasks
Deploy a management domain
Retrieve a list of bringup validations
SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.
Get a bringup task by its id
Retry failed SDDC creation
Retrieve the results of a bringup validation by its ID
Retry a completed SDDC validation
Retrieves the details of SDDC Manager VM
Returns the bringup report. Reports are generated in PDF and CSV formats.
Returns the bringup report for a validation. Reports are generated in PDF format.
GET Method to retrieve information about Bringup app
Fetch SDDC Manager Upgradables
Retrieve a list of SDDC Managers
Retrieve the details of an SDDC Manager by its id
Retrieve the history of SDDC Manager by its id
Returns a list of local OS user accounts from the SDDC Manager appliance
Retrieve a list of Support Bundle tasks
Start a Support Bundle operation using SoS
Retieve a list of Health Check tasks
Start a Health Check operation using SoS
Retrive the status of the Support Bundle operation
Download a Support Bundle tar.gz by ID
Retrieve the status of the Health Check operations
Download a Health Check tar.gz by its ID
Updates VMware Aria Suite Lifecycle version
Gets the complete information about the existing VMware Aria Suite Lifecycle instance.
Updates VMware Aria Suite Lifecycle version in VCF inventory
Triggers the VMware Aria Suite Lifecycle rollback operation and returns an URL in the headers to track the operation status.
Get all existing VMware Aria Suite Lifecycle instances
Triggers the VMware Aria Suite Lifecycle deployment operation and returns an URL in the headers to track the operation status.
Triggers VMware Aria Suite Lifecycle deployment specification validation workflow
Gets the status of given VMware Aria Suite Lifecycle validation workflow by given validation id
Get status on the VMware Aria Suite Lifecycle product and availability of different actions.
Retrieve the system configuration
Updates paramters of the system configuration
Retrieve the NTP configuration
Update the NTP configuration
Retrieve the DNS configuration
Update the DNS configuration
Retrieve a list of NTP configuation validations
Perform validation of the NtpConfiguration specification
Retrieve a list of DNS configuation validations
Perform validation of the DnsConfiguration specification
Retrieve the results of a NTP configuration validation by its ID
Retrieve the results of a DNS configuration validation by its ID
Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck. As this API is deprecated, please use the new LCM Prechecks API - /v1/system/check-sets/queries and /v1/system/check-sets
Monitor the progress of precheck task by the precheck task ID. As this API is deprecated, please use the new LCM Prechecks API - /v1/system/check-sets/{taskId}
Validate the target selected upgrade release BOM or custom BOM for a domain by its ID
Get last selected upgrade version for the domain.
Delete last selected upgrade version for the domain
Update last selected upgrade version for the domain
Get last selected upgrade version for WLDs.
Monitor the progress of domain target state validation task by the validation id.
Get a Task by ID, if it exists
Cancel a Task by ID, if it exists
Retry a failed Task by ID, if it exists
Get the tasks
Creates access token and refresh token for user access
Refresh the access token associated with the given refresh token
Invalidate the provided refresh token
Retrieve all trusted certificates from SDDC Manager
Add a trusted certificate to the SDDC Manager
Delete a trusted certificate from the SDDC Manager.
Fetches the list of Upgradables for a given domain. If a target version is provided, Upgradables that are required for given target version become Available. The Upgradables providesinformation that can be use for Precheck API and also in the actual Upgrade API call.This API is used only for management domain, for all cases please use v1/system/upgradables.
Get the list NSX upgradable reosurce with resource metadata info
Fetches the list of available hardware support managers and configured hardware support managers for the give resource along with the hardware support packages and Software details.
Fetches the list of Upgradables in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call.
Retrieve a list of upgrades
Schedule/Trigger Upgrade of a Resource. Ex: Resource can be DOMAIN, CLUSTER, UNMANAGED_HOST etc. Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above. Supports scheduling/triggering of only 'parallel' upgrades and only Resource 'cluster' that are managed using both vSphere Lifecycle Manager Baselines and vSphere Lifecycle Manager Images in the same request.
Perform Upgrade Prechecks
Retrieve an upgrade by ID
Commit/Reschedule an existing upgrade. It moves the upgrade from DRAFT state to SCHEDULED state and/or changes the upgrade scheduled date/time.
Gets upgrade precheck details
Get a list of all users
Add list of users
Get information on the local account
Disable local account
Update the password for local account only if the old password is correct, or if user configures the local account for the first time
Retrieve a list of users assigned access via SDDC Manager
Get a list of all SSO domains
Get a list of all entities in the SSO domain
Get a list of all roles
Delete the user by the ID, if it exists
Retrieve a list of vCenter Servers
Retrieve a vCenter Server by its ID
Download vSAN HCL if online connectivity is available. Timestamp of vSAN HCL on SDDC Manager is checked with what is available online before download. vSAN HCL is downloaded only if new data is available.
Get vSAN HCL configuration
Update vSAN HCL configuration
Attributes of vSAN HCL data such as timestamp of last update
Get vSAN health check status for all cluster on the domain
Update vSAN health check status for domain
Get vSAN health check update task status for a given task Id
Get vSAN health check status for a given Query Id
Get the VASA Providers
Add a VASA Provider
Get the users of a VASA Provider
Add the users to a VASA Provider
Get the storage containers of a VASA Provider
Add the storage containers to a VASA Provider
Validate VasaProvider input specification
Get a VASA Provider
Delete a VASA Provider
Update a VASA Provider
Update the user of a VASA Provider
Delete a storage container of a VASA Provider
Update the storage container of a VASA Provider
Get the status of the validation of the VASA Provider
Retrieve a list of SDDC Manager services
Retrieve an SDDC Manager service by its ID
Get the Version Alias Configuration.
Update Version Alias Configurations.
Update Version Alias Configuration.
Delete Version Alias Configuration by bundle component type, version, and aliases.
Removes Version Alias Configuration by component type
Retrieve a list of Workspace ONE Access instances