VMware Cloud Foundation API Reference Guide Operations Index
All available VMware Cloud Foundation API Reference Guide Operations
Avns
POST
Create Avns
Create AVNs
GET
Get All Avns
Fetches all AVNs
POST
Validate Avns
Validate AVN Creation Spec
Backup Restore
GET
Get Backup Configuration
Retrieve the backup configuration for SDDC Manager and NSX Manager
GET
Get Restore Task
Retrieve the restore task
PUT
Set Backup Configuration
Configure the backup configuration for SDDC Manager and NSX Manager
POST
Start Backup
Start a backup operation
POST
Start Restore
Start a restore operation
PATCH
Update Backup Configuration
Update the backup configuration for SDDC Manager and NSX Manager
Bundles
GET
Get Bundle
Get a Bundle
GET
Get Bundles
Get the Bundles
GET
Get Bundles For Skip Upgrade Using GET
Get bundles for skip upgrade a domain from current version to target version.
PATCH
Update Bundle
Update a Bundle for downloading from depot
PATCH
Update Bundle Compatibility Sets Deprecated
Update software compatibility sets for Bundles
POST
Upload Bundle
Upload a Bundle
Ceip
GET
Get Ceip Status
Get CEIP status
PATCH
Set Ceip Status
Opt-in or Opt-out of CEIP
Certificates
PATCH
Configure Certificate Authority
Configure existing certificate authority
PUT
Create Certificate Authority
Create a certificate authority
DELETE
Delete Ca Configuration
Deletes CA configuration file
GET
Download CSR Deprecated
Download available CSR(s) in tar.gz format
PUT
Generate Certificates
Generate certificate(s) for the selected resource(s) in a domain
PUT
Generates CS Rs
Generate CSR(s)
GET
Get Certificate Authorities
Get certificate authorities information
GET
Get Certificate Authority By Id
Get certificate authority information
GET
Get Certificates
Get latest generated certificate(s) in a domain.
GET
Get CS Rs
Get available CSR(s) in json format
GET
Get Resource Certificates Validation Result
Get the resource certificate validation result
PATCH
Replace Certificates Deprecated
Replace certificate(s) for the selected resource(s) in a domain
PUT
Replace Resource Certificates
Replace resource certificates
PUT
Upload Certificates Deprecated
Upload certificates to the certificate store
PUT
Validate Resource Certificates
Validate resource certificates
GET
View Certificate
View certificate of all the resources in a domain
Check Sets
GET
Get Last Assessment Run Info
Get information about the last assessment run
GET
Get Result
Get the result for a given check run
POST
Query Check Sets
Query for check-sets for the given resources
POST
Trigger Check Run
Trigger a run of the selected checks
PATCH
Trigger Partial Retry Of Check Run
Trigger partial retry of a completed check run
Clusters
POST
Add Datastore To Cluster
Mount a datastore to a cluster
GET
Assignable Tags To Cluster
get assignable Tags to Cluster
PUT
Assign Tags To Existing Cluster
Assign Tags to Cluster
POST
Create Cluster
Create a Cluster and add to an existing Domain
DELETE
Delete Cluster
Delete a Cluster from a Domain if it has been previously initialized for deletion
GET
Get Cluster
Get a Cluster
GET
Get Cluster Datastores
Get the list of all datastores associated with the cluster.
GET
Get Clusters
Get the Clusters
GET
Get Cluster Tag Manager Url
Get Cluster Tag Manager Url
GET
Get Datastore Criterion
Get a criterion to query for datastore
GET
Get Datastore Query Response
Get Datastore query response
GET
Get Datastores Criteria
Get all datastore criteria
GET
Get Host Criteria
Get all host criteria
GET
Get Host Criterion
Get a criterion to query for host
GET
Get Host Query Response
Get query response
GET
Get Tags Assigned To Cluster
Get Tags assigned to Cluster
GET
Get Tags Assigned To Clusters
Get Tags assigned to Clusters
GET
Get Vdses
Get the list of VDSes of a cluster.
POST
Post Datastore Query
Post a datastore query
POST
Post Host Query
Post a host query
DELETE
Remove Datastore From Cluster
Unmount a datastore from a cluster
DELETE
Remove Tags From Existing Cluster
Remove Tags From Cluster
PATCH
Update Cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
POST
Validate Cluster Operations
Validate input specification for updating given Cluster
POST
Validate Clusters Operations
Validate the input specification for Cluster creation
POST
Validate Vsan Remote Datastore Spec
Validate the input spec for mounting vSAN remote datastore to an existing cluster
Compatibility Matrix
GET
Get Compatibility Matrices
Get Compatibility Matrices
GET
Get Compatibility Matrix
Get Compatibility Matrix
GET
Get Compatibility Matrix Content
Get Compatibility Matrix content
GET
Get Compatibility Matrix Metadata
Get Compatibility Matrix Metadata
PUT
Update Compatibility Matrix
Update CompatibilityMatrix for a source with JSON file
Config Reconciler
GET
Get Configs
Get configs associated with the given criteria
GET
Get Reconciliation Task
Get config reconciliation task associated with the given task Id
POST
Reconcile Configs
Reconcile configs
Credentials
DELETE
Cancel Credentials Task
Cancel a failed credentials task for a given ID
POST
Fetch Password Expiration
Fetch expiration details of passwords for a list of credentials
GET
Get Credential
Get Credential for the given ID
GET
Get Credentials
Get the Credentials
GET
Get Credentials Sub Task
Fetch details of a subtask for a given credentials task ID and sub-task ID.
GET
Get Credentials Task
Fetch a credentials task
GET
Get Credentials Task Resources Credentials
Fetch resource credentials for a given credentials task ID
GET
Get Credentials Tasks
Fetch the credentials tasks
GET
Get Expirations For Passwords
Get the status of the password expiration fetch
PATCH
Retry Credentials Task
Retry a failed credentials task for a given ID
PATCH
Update Or Rotate Passwords
Update or rotate passwords for a list of resources
Depot Settings
GET
Get Depot Settings
Get Depot Settings
PUT
Update Depot Settings
Update Depot Settings
Domains
GET
Assignable Tags To Domain
get assignable Tags to Domain
PUT
Assign Tags To Existing Domain
Assign Tags to Domain
POST
Create Domain
Create a Domain
DELETE
Delete Domain
Delete a Domain if it has been previously initialized for deletion
GET
Get Cluster Criteria
Get all cluster criteria
GET
Get Cluster Criterion
Get a criterion to query for cluster
GET
Get Cluster Query Response
Get cluster query response
GET
Get Clusters Query Response
Get clusters query response
GET
Get Datastore Criterion 1
Get a criterion to query for datastore
GET
Get Datastore Query Response 1
Get Datastore query response
GET
Get Datastores Criteria 1
Get all datastore criteria
GET
Get Domain
Get a Domain
GET
Get Domain Endpoints
Get Endpoints of a Domain
GET
Get Domains
Get the Domains
GET
Get Domain Tag Manager Url
Get Domain Tag Manager Url
GET
Get Tags Assigned To Domain
Get Tags assigned to Domain
GET
Get Tags Assigned To Domains
Get Tags assigned to Domains
POST
Post Cluster Query
Post a cluster query
POST
Post Clusters Query
Post clusters query
POST
Post Datastore Query 1
Post a datastore query
DELETE
Remove Tags From Domain
remove Tags From Domain
PATCH
Update Domain
Update a Domain
POST
Validate Domains Operations
Validate the input spec for domains operations
Fips Mode Details
GET
Get Security Config
Get VCF security configuration
Hosts
GET
Assignable Tags To Host
get Assignable Tags to Host
PUT
Assign Tags To Existing Host
Assign Tags to Host
POST
Commission Hosts
Commission the Hosts
DELETE
Decommission Hosts
Decommission the Hosts
GET
Get Criteria
Get all criteria
GET
Get Criterion
Get a criterion
GET
Get Host
Get a Host
GET
Get Host Query Response 1
Get query response
GET
Get Hosts
Get the Hosts
GET
Get Host Tag Manager Url
Get Host Tag Manager Url
GET
Get Tags Assigned To Host
Get Tags assigned to Host
GET
Get Tags Assigned To Hosts
Get Tags assigned to Hosts
GET
Get Validation For Commission Hosts
Get the status of the validation of the input specification to commission the Hosts
POST
Post Query
Post a query
DELETE
Remove Tags From Host
Remove Tags From Host
POST
Validate Hosts Operations
Validate the input spec for hosts operations
Identity Providers
POST
Add Embedded Identity Source
Add an embedded Identity source
POST
Add External Identity Provider
Add an external Identity provider
DELETE
Delete External Identity Provider
Delete an external Identity Provider
DELETE
Delete Identity Source
Delete an Identity Source
GET
Get All Idps
Get all Identity Providers
GET
Get Identity Provider By Id
Get Identity Provider By Id
PATCH
Update Embedded Identity Source
Update an embedded Identity source
PATCH
Update External Identity Provider
Update an external Identity provider
License Keys
POST
Add License Key
Add a License Key
POST
Check Resources License
Check resources license
DELETE
Delete License Key
Delete a License Key
GET
Get License Key
Get a License Key by key
GET
Get License Keys
Get the License Keys
GET
Get Licensing Info
Get the Licensing information
GET
Get Resources License Check Result
Get the result of the resources license check
PUT
Update License Keys On Resources
Update license keys of resources
Manifests
GET
Get Manifest
Get manifest
POST
Save Manifest
Save/Load manifest
Network Pools
POST
Add Ip Pool To Network Of Network Pool
Add an IP Pool to a Network of a Network Pool
POST
Create Network Pool
Create a Network Pool
DELETE
Delete Ip Pool From Network Of Network Pool
Delete an IP Pool from a Network of a Network Pool
DELETE
Delete Network Pool
Delete a Network Pool
GET
Get Network Of Network Pool
Get a Network of a Network Pool
GET
Get Network Pool
Get a Network Pool
GET
Get Network Pools
Get the Network Pools
GET
Get Networks Of Network Pool
Get the Networks of a Network Pool
PATCH
Update Network Pool
Update Network Pool
Nsx T Clusters
GET
Get Criteria 1
Get all NSX criteria
GET
Get Criterion 1
Get a NSX criterion
GET
Get Nsxt Cluster
Get a NSX cluster
GET
Get Nsxt Cluster Query Response
Get NSX cluster query response
GET
Get Nsxt Clusters
Get the NSX clusters
GET
Get Nsxt Ip Address Pool
Get a NSX IP address pool
GET
Get Nsxt Ip Address Pools
Get the NSX IP address pools
GET
Get Validation Result Using GET
getValidationResult
POST
Post Query 1
Post a query
POST
Validate Ip Pool Using POST
validateIpPool
Nsx Tedge Clusters
POST
Create Edge
Create an Edge Cluster
GET
Get Edge Cluster
Get an Edge Cluster
GET
Get Edge Clusters
Get the Edge Clusters
GET
Get Validation For Create Edge Cluster
Get the Edge Cluster spec validation
PATCH
Update Edge Cluster
Expand or Shrink an NSX Edge Cluster
POST
Validate Edge Cluster Spec
Validate an Edge Cluster spec
POST
Validate Edge Cluster Update Spec
Validate an NSX Edge Cluster update spec
Personalities
DELETE
Delete Personality
Delete the personality based on either name or id
GET
Get Personalities
Get the Personalities
GET
Get Personality
Get Personalities By Id
PATCH
Rename Personality By Id
Rename personality based on ID
POST
Upload Personality
Upload a Personality
PUT
Upload Personality Files
Upload personality files to SDDC Manager
Proxy Configuration
GET
Get Proxy Configuration
Get the current Proxy configuration
PATCH
Update Proxy Configuration
Update Proxy configuration
Pscs
GET
Get Psc
Get a PSC
GET
Get Pscs
Get the PSCs
Releases
GET
Get Future Releases
Returns all known to the system future target versions for a domain.
GET
Get Releases
Get Releases.
GET
Get System Release
Get System Release.
Resource Functionalities
GET
Get Resource Functionalities
Get Resource Functionalities
GET
Get Resources Functionalities Allowed Global
Get Resource Functionalities Allowed Global Configuration
Resource Warnings
GET
Get Resource Warning
Get a Resource Warning by ID
GET
Get Resource Warnings
Get Resource Warnings
Sddc
POST
Convert To Json Spec
Convert SDDC specification Json/Excel File
POST
Create Sddc
Create SDDC
GET
Get All Sddc Validations
Get all SDDC specification validations
GET
Get Bringup Detail Report
Get SDDC report by ID
GET
Get Bringup Info
Get Bringup Info
GET
Get Bringup Validation Report
Get validation report by ID
GET
Get Sddc Manager Info
Retrieve SDDC Manager VM details
GET
Get Sddc Validation
Get SDDC specification validation status by ID
GET
Retrieve All Sddcs
Retrieve all SDDCs
GET
Retrieve SDDC
Retrieve a SDDC
PATCH
Retry Sddc
Retry failed SDDC creation
PATCH
Retry Sddc Validation
Retry SDDC validation
POST
Validate Sddc Spec
Validate SDDC specification before creation
Sddc Managers
GET
Get Sddc Manager
Get a SDDC Manager
GET
Get Sddc Managers
Get the SDDC Managers
Sos
GET
Gethealthsummary
Fetch the progress of a Health summary task.
GET
Gethealthsummarytasks
Fetch All Health Summary Tasks.
GET
Getsupport Bundle
Fetch the progress of support bundle task.
GET
Getsupport Bundle Tasks
Fetch All Support bundle Tasks.
POST
Health Summary
Initiates Health Summary checks.
GET
Healthsummarydata
Download Health Summary Bundle.
GET
Support Bundledata
Download Support bundles.
POST
Supportbundles
Initiates Support bundle download
System
PUT
Configure Dns
Configure the Dns Server
PUT
Configure Ntp
Configure the Ntp Server
GET
Get Dns Configuration
Get the current DnsConfiguration
GET
Get Ntp Configuration
Get the current NtpConfiguration
GET
Get System
Get the system
GET
Get Validation Of Dns Configuration
Get the status of the validation of the input DnsConfiguration
GET
Get Validation Of Ntp Configuration
Get the status of the validation of the input ntpServers to configure new Ntp server
GET
Get Validations Of DNS Configuration
Get the validations of the input dnsServers to configure new DNS server
GET
Get Validations Of Ntp Configuration
Get the validations of the input ntpServers to configure new Ntp server
PATCH
Patch System
Update system level configuration
POST
Validate Dns Configuration
Validate DnsConfiguration input spec and system health before DNS configuration
POST
Validate Ntp Configuration
Validate NtpConfiguration input spec and system health before Ntp configuration
System Prechecks
GET
Get Precheck Task Deprecated
Get Precheck Task by ID
POST
Precheck System Deprecated
Precheck System
Target Upgrade Version
GET
Get Domain Release View
Get release view for domain.
GET
Get Domain Release View 1
Get release view for all WLDs.
PATCH
Save Domain Release View
Save/update target upgrade version for domain.
Tasks
DELETE
Cancel Task
Cancel a Task
GET
Get Task
Get a Task
GET
Get Tasks
Get the Tasks
PATCH
Retry Task
Retry a Task
Tokens
POST
Create Token
Create Token Pair
DELETE
Invalidate Refresh Token
Invalidate Refresh Token
PATCH
Refresh Access Token
Refresh Access Token
Trusted Certificates
POST
Add Trusted Certificate
Add a trusted certificate to the SDDC Manager
DELETE
Delete Trusted Certificate
Delete a trusted certificate from the SDDC Manager
GET
Get Trusted Certificates
Get the trusted certificates from the SDDC Manager
Upgradables
GET
Get Nsxt Upgrade Resources
Get NSX upgradable resources
GET
Get Upgradables
Get the Upgradables
GET
Get Upgradables And Resource Errors
Get the Upgradables and Resource Errors
GET
Get Upgradables By Domain
Get the Upgradables
GET
Get Upgradables Clusters
Get registered and available HSM details along with Software details
Upgrades
PATCH
Commit Reschedule Upgrade
Commit/Reschedule Upgrade
GET
Get Upgrade By Id
Get Upgrade By Id
GET
Get Upgrade Precheck
Get Upgrade Precheck Details
GET
Get Upgrades
Get Upgrades
POST
Perform Upgrade
Perform Upgrade
POST
Perform Upgrade Precheck
Perform Upgrade Prechecks
Users
POST
Add Users
Add users
DELETE
Delete User
Delete a user
GET
Get All Ui Users Using GET
getAllUiUsers
GET
Get Local Account
Get local account details
GET
Get Roles
Get all roles
GET
Get SSO Domain Entities
Get all entities of SSO domain
GET
Get SSO Domains
Get all SSO domains
GET
Get Users
Get all Users
PATCH
Update Local User Password
Update password for local account
V Centers
GET
Get Vcenter
Get a vCenter
GET
Get Vcenters
Get vCenters
V Ra
GET
Get Vras
Get all existing vRealize Automation instances
V Rli
PUT
Connect Vrli With Domain
Connects vRealize Log Insight with domain
GET
Get Integrated Domains 1
Gets vRealize Log Insight integration status for workload domains
GET
Get Vrlis
Get all existing vRealize Log Insight instances
V Rops
PUT
Connect Vrops With Domain
Connect/disconnect workload domains with vRealize Operations
GET
Get Integrated Domains Vrops
Gets vRealize Operations integration status for workload domains
GET
Get Vropses
Get all existing vRealize Operations instances
V Rslcm
POST
Deploy Vrslcm
Deploy vRealize Suite Lifecycle Manager
GET
Get Vrslcm
Get the existing vRealize Suite Lifecycle Manager
GET
Get Vrslcms
Get all existing vRealize Suite Lifecycle Manager instances
GET
Get Vrslcm Validation
Get the status of the validations for vRealize Lifecycle Manager deployment
DELETE
Rollback Vrslcm
Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment
PUT
Update Vrslcm Version By Id In Inventory
Update vRSLCM version by ID in SDDC Manager inventory
PUT
Update Vrslcm Version In Inventory
Updates the version of VRSLCM in SDDC Manager inventory
POST
Validate Vrslcm
Validate the input specification for vRealize Suite Lifecycle Manager deployment
V Sanhealth Check
GET
Get Health Check Query
Get vSAN health check status
GET
Get Health Check Status
Get vSAN health check status by Query Id
GET
Get Health Check Status Task
Get vSAN health check update task status
PATCH
Set Health Check Status
Update vSAN health check status
Vasa Providers
POST
Add Storage Containers To Vasa Provider
Add the storage containers to a VASA Provider
POST
Add Users To Vasa Provider
Add the users to a VASA Provider
POST
Add Vasa Provider
Add a VASA Provider
DELETE
Delete Storage Container Of Vasa Provider
Delete a storage container of a VASA Provider
DELETE
Delete Vasa Provider
Delete a VASA Provider
GET
Get Storage Containers Of Vasa Provider
Get the storage containers of a VASA Provider
GET
Get Users Of Vasa Provider
Get the users of a VASA Provider
GET
Get Validation Of Vasa Provider
Get the status of the validation of the VASA Provider
GET
Get Vasa Provider
Get a VASA Provider
GET
Get Vasa Providers
Get the VASA Providers
PATCH
Update Storage Container Of Vasa Provider
Update the storage container of a VASA Provider
PATCH
Update User Of Vasa Provider
Update the user of a VASA Provider
PATCH
Update Vasa Provider
Update a VASA Provider
POST
Validate Vasa Provider
Validate VasaProvider input specification
Vcf Services
GET
Get Vcf Service
Get a VcfService
GET
Get Vcf Services
Get the VcfServices
Version Aliases For Bundle Component Type
DELETE
Delete Alias Versions By Software Type And Base Version
Delete Version Alias Configuration
DELETE
Delete Version Alias By Software Type
Delete Version Alias for a bundle component type
GET
Get Version Alias Configuration
Get Version Alias Configuration
PUT
Update Version Alias Configuration
Update Version Alias Configuration
PUT
Update Version Alias Configurations
Update Version Alias Configurations
Wsa
GET
Get Wsas
Get all existing Workspace ONE Access instances