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

post	Backup Tasks Trigger backup
put	Configure Backup Settings Configure backup settings to backup NSX and SDDC manager
patch	Edit Backup Settings Edit backup configuration to backup NSX and SDDC manager
get	Get Backup Settings Get backup configuration used to backup NSX and SDDC manager
post	Restores Tasks Trigger Restore
get	Restores Tasks Fetch the restores task

---

Bundles

get	Get Bundle Get a Bundle
get	Get Bundles Get the Bundles
get	Get Bundles For Skip Upgrade 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 Update software compatibility sets for Bundles
post	Upload Bundle Upload a Bundle

---

CEIP

get	Get CEIP Status Get CEIP status
patch	Update 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
put	Decode Cert Chain decodeCertChain
delete	Delete CA Configuration Deletes CA configuration file
get	Download CSR Download available CSR(s) in tar.gz format
put	Generate Certificates Generate certificate(s) for the selected resource(s) in a domain
put	Generates CSRs Generate CSR(s)
get	Get CSRs Get available CSR(s) in json format
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 Resource Certificates Validation Result Get the resource certificate validation result
patch	Replace Certificates Replace certificate(s) for the selected resource(s) in a domain
put	Replace Resource Certificates Replace resource certificates
put	Upload Certificates 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

---

Clusters

post	Add Datastore To Cluster Mount a datastore to a cluster
put	Assign Tags To Existing Cluster Assign Tags to Cluster
get	Assignable Tags To Cluster get assignable 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 Cluster Tag Manager URL Get Cluster Tag Manager Url
get	Get Clusters Get the Clusters
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 Validate the input spec for mounting vSAN remote datastore to an existing cluster

---

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

put	Assign Tags To Existing Domain Assign Tags to Domain
get	Assignable Tags To Domain get assignable 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 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 Domain Get a Domain
get	Get Domain Endpoints Get Endpoints of a Domain
get	Get Domain Tag Manager URL Get Domain Tag Manager Url
get	Get Domains Get the Domains
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 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

put	Assign Tags To Existing Host Assign Tags to Host
get	Assignable Tags To Host get Assignable 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 Get query response
get	Get Host Tag Manager URL Get Host Tag Manager Url
get	Get Hosts Get the Hosts
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
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

---

Manifests

get	Get Manifest Get manifest
post	Save Manifest Save/Load manifest

---

NSX-T Clusters

get	Get Criteria Get all NSX-T criteria
get	Get Criterion Get a NSX-T criterion
get	Get NSX-T Cluster Get a NSX-T cluster
get	Get NSX-T Cluster Query Response Get NSX-T cluster query response
get	Get NSX-T Clusters Get the NSX-T clusters
get	Get NSX-T IP Address Pool Get a NSX-T IP address pool
get	Get NSX-T IP Address Pools Get the NSX-T IP address pools
get	Get Validation Result getValidationResult
post	Post Query Post a query
post	Validate IP Pool validateIpPool

---

NSX-T Edge 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-T Edge Cluster
post	Validate Edge Cluster Spec Validate an Edge Cluster spec
post	Validate Edge Cluster Update Spec Validate an NSX-T Edge Cluster update spec

---

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

---

PSCs

get	Get PSC Get a PSC
get	Get PSCs Get the PSCs

---

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
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

---

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 Get Precheck Task by ID
post	Precheck System Precheck System

---

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 NSX-T Upgrade Resources Get NSXT upgradable resources
get	Get Upgradables Get the Upgradables
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 Precheck getPrecheck
get	Get Upgrade By ID Get Upgrade By Id
get	Get Upgrades Get Upgrades
post	Perform Prechecks performPrechecks
post	Perform Upgrade Perform Upgrade

---

Users

post	Add Users Add users
delete	Delete User Delete a user
get	Get All UI Users 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 San Health 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 VASA Provider Get a VASA Provider
get	Get VASA Providers Get the VASA Providers
get	Get Validation Of VASA Provider Get the status of the validation of the VASA Provider
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

---

vCenters

get	Get vCenter Get a vCenter
get	Get vCenters Get vCenters

---

vRA

get	Get VRas Get all existing vRealize Automation instances

---

vRLI

put	Connect vRLI With Domain Connects vRealize Log Insight with domain
get	Get Integrated Domains Gets vRealize Log Insight integration status for workload domains
get	Get VRlis Get all existing vRealize Log Insight instances

---

vROPs

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

---

vRSLCM

post	Deploy vRSLCM Deploy vRealize Suite Lifecycle Manager
get	Get vRSLCM Get the existing vRealize Suite Lifecycle Manager
get	Get vRSLCM Validation Get the status of the validations for vRealize Lifecycle Manager deployment
get	Get vRSLCMs Get all existing vRealize Suite Lifecycle Manager instances
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