VMware Cloud Foundation API Reference Guide Operations Index

VMware Cloud Foundation API Reference Guide Operations Index

All available VMware Cloud Foundation API Reference Guide Operations

Avns

Fetches all AVNs

Validate AVN Creation Spec

Backup Restore

Configure Backup Settings

Configure backup settings to backup NSX and SDDC manager

Edit Backup Settings

Edit backup configuration to backup NSX and SDDC manager

Get Backup Settings

Get backup configuration used to backup NSX and SDDC manager

Fetch the restores task

Restores Tasks 1

Trigger Restore

Bundles

Get the Bundles

Update a Bundle for downloading from depot

Update Bundle Compatibility Sets

Update software compatibility sets for Bundles

Upload a Bundle

Ceip

Get Ceip Status

Get CEIP status

Update Ceip Status

Opt-in or Opt-out of CEIP

Certificates

Configure Certificate Authority

Configure existing certificate authority

Create Certificate Authority

Create a certificate authority

Delete Ca Configuration

Deletes CA configuration file

Download available CSR(s) in tar.gz format

Generate Certificates

Generate certificate(s) for the selected resource(s) in a domain

Generates CS Rs

Generate CSR(s)

Get Certificate Authorities

Get certificate authorities information

Get Certificate Authority By Id

Get certificate authority information

Get Certificates

Get latest generated certificate(s) in a domain.

Get available CSR(s) in json format

Replace Certificates

Replace certificate(s) for the selected resource(s) in a domain

Upload Certificates

Upload certificates to the certificate store

View Certificate

View certificate of all the resources in a domain

Clusters

Create a Cluster and add to an existing Domain

Delete a Cluster from a Domain if it has been previously initialized for deletion

Get the Clusters

Get Host Criteria

Get all host criteria

Get Host Criterion

Get a criterion to query for host

Get Host Query Response

Get query response

Get the list of VDSes of a cluster.

Post Host Query

Post a host query

Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion

Validate Cluster Operations

Validate the input spec for operations on a cluster

Validate Clusters Operations

Validate the input spec for clusters operations

Credentials

Cancel Credentials Task

Cancel a failed credentials task for a given ID

Get Credential for the given ID

Get Credentials

Get the Credentials

Get Credentials Sub Task

Fetch details of a subtask for a given credentials task ID and sub-task ID.

Get Credentials Task

Fetch a credentials task

Get Credentials Task Resources Credentials

Fetch resource credentials for a given credentials task ID

Get Credentials Tasks

Fetch the credentials tasks

Retry Credentials Task

Retry a failed credentials task for a given ID

Update Or Rotate Passwords

Update or rotate passwords for a list of resources

Depot Settings

Get Depot Settings

Get Depot Settings

Update Depot Settings

Update Depot Settings

Domains

Create a Domain

Delete a Domain if it has been previously initialized for deletion

Get Cluster Criteria

Get all cluster criteria

Get Cluster Criterion

Get a criterion to query for cluster

Get Cluster Query Response

Get cluster query response

Get Clusters Query Response

Get clusters query response

Get Domain Endpoints

Get Endpoints of a Domain

Get the Domains

Post Cluster Query

Post a cluster query

Post Clusters Query

Post clusters query

Update a Domain

Validate Domains Operations

Validate the input spec for domains operations

Federation

Bootstrap a VMware Cloud Foundation to form a federation

Get Federation Details

Get details of a federation

Teardown a federation

Fips Mode Details

Get Security Config

Get VCF security configuration

Hosts

Commission Hosts

Commission the Hosts

Decommission Hosts

Decommission the Hosts

Get all criteria

Get a criterion

Get Host Query Response 1

Get query response

Get Validation For Commission Hosts

Get the status of the validation of the input specification to commission the Hosts

Validate Hosts Operations

Validate the input spec for hosts operations

License Keys

Add License Key

Add a License Key

Delete License Key

Delete a License Key

Get License Key

Get a License Key by key

Get License Keys

Get the License Keys

Manifests

Save/Load manifest

Members

Get fact about a VMware Cloud Foundation

Join Federation

Join a VMware Cloud Foundation to a federation

Leave Federation

Leave a VMware Cloud Foundation from a federation

Membership Token

Invite a VMware Cloud Foundation to be member of a federation

Network Pools

Add Ip Pool To Network Of Network Pool

Add an IP Pool to a Network of a Network Pool

Create Network Pool

Create a Network Pool

Delete Ip Pool From Network Of Network Pool

Delete an IP Pool from a Network of a Network Pool

Delete Network Pool

Delete a Network Pool

Get Network Of Network Pool

Get a Network of a Network Pool

Get Network Pool

Get a Network Pool

Get Network Pools

Get the Network Pools

Get Networks Of Network Pool

Get the Networks of a Network Pool

Update Network Pool

Update Network Pool

Nsx T Clusters

Get all NSX-T criteria

Get Criterion 1

Get a NSX-T criterion

Get Nsxt Cluster

Get a NSX-T cluster

Get Nsxt Cluster Query Response

Get NSX-T cluster query response

Get Nsxt Clusters

Get the NSX-T clusters

Get Nsxt Ip Address Pool

Get a NSX-T IP address pool

Get Nsxt Ip Address Pools

Get the NSX-T IP address pools

Get Validation Result Using GET

getValidationResult

Validate Ip Pool Using POST

Nsx Tedge Clusters

Create an Edge Cluster

Get Edge Cluster

Get an Edge Cluster

Get Edge Clusters

Get the Edge Clusters

Get Validation For Create Edge Cluster

Get the Edge Cluster spec validation

Update Edge Cluster

Expand or Shrink an NSX-T Edge Cluster

Validate Edge Cluster Spec

Validate an Edge Cluster spec

Validate Edge Cluster Update Spec

Validate an NSX-T Edge Cluster update spec

Personalities

Delete Personality

Delete the personality based on either name or id

Get Personalities

Get the Personalities

Get Personality

Get Personalities By Id

Upload Personality

Upload a Personality

Upload Personality Files

Upload personality files to SDDC Manager

Progress

Get progress of an invoked operation

Pscs

Releases

Sddc

Convert To Json Spec

Convert SDDC specification Json/Excel File

Get All Sddc Validations

Get all SDDC specification validations

Get Bringup Detail Report

Get SDDC report by ID

Get Bringup Info

Get Bringup Info

Get Bringup Validation Report

Get validation report by ID

Get Sddc Manager Info

Retrieve SDDC Manager VM details

Get Sddc Validation

Get SDDC specification validation status by ID

Retrieve All Sddcs

Retrieve all SDDCs

Retrieve a SDDC

Retry failed SDDC creation

Retry Sddc Validation

Retry SDDC validation

Validate Sddc Spec

Validate SDDC specification before creation

Sddc Managers

Get Sddc Manager

Get a SDDC Manager

Get Sddc Managers

Get the SDDC Managers

Sos

Gethealthsummary

Get Health-Checks task record for an id.

Gethealthsummarytasks

Get all Health-Checks task records.

Getsupport Bundle

Get Support-Bundle task record for an id.

Getsupport Bundle Tasks

Get all Support-Bundle task records.

Initiates Health-Checks for SDDC.

Healthsummarydata

Download Health-Checks bundle.

Support Bundledata

Download Support-Bundle.

Initiates Support-Bundle collection for SDDC.

System

Configure the Dns Server

Configure the Ntp Server

Get Dns Configuration

Get the current DnsConfiguration

Get Ntp Configuration

Get the current NtpConfiguration

Get Validation Of Dns Configuration

Get the status of the validation of the input DnsConfiguration

Get Validation Of Ntp Configuration

Get the status of the validation of the input ntpServers to configure new Ntp server

Get Validations Of DNS Configuration

Get the validations of the input dnsServers to configure new DNS server

Get Validations Of Ntp Configuration

Get the validations of the input ntpServers to configure new Ntp server

Validate Dns Configuration

Validate DnsConfiguration input spec and system health before DNS configuration

Validate Ntp Configuration

Validate NtpConfiguration input spec and system health before Ntp configuration

System Prechecks

Get Precheck Task

Get Precheck Task by ID

Precheck System

Precheck System

Tasks

Tokens

Create Token Pair

Invalidate Refresh Token

Invalidate Refresh Token

Refresh Access Token

Refresh Access Token

Trusted Certificates

Add Trusted Certificate

Add trusted certificate to the SDDC manager

Upgradables

Get Nsxt Upgrade Resources

Get NSXT upgradable resources

Get Upgradables

Get the Upgradables

Get Upgradables By Domain

Get the Upgradables

Get Upgradables Clusters

Get registered and available HSM details along with Software details

Upgrades

Commit Reschedule Upgrade

Commit/Reschedule Upgrade

Get Precheck Using GET

Get Upgrade By Id

Get Upgrade By Id

Perform Prechecks Using POST

performPrechecks

Perform Upgrade

Perform Upgrade

Users

Get All Ui Users Using GET

Get Local Account

Get local account details

Get SSO Domain Entities

Get all entities of SSO domain

Get SSO Domains

Get all SSO domains

Update Local User Password

Update password for local account

V Centers

V Ra

Get all existing vRealize Automation instances

V Rli

Connect Vrli With Domain

Connects vRealize Log Insight with domain

Get Integrated Domains 1

Gets vRealize Log Insight integration status for workload domains

Get all existing vRealize Log Insight instances

V Rops

Connect Vrops With Domain

Connect/disconnect workload domains with vRealize Operations

Get Integrated Domains Vrops

Gets vRealize Operations integration status for workload domains

Get all existing vRealize Operations instances

V Rslcm

Deploy vRealize Suite Lifecycle Manager

Get the existing vRealize Suite Lifecycle Manager

Get all existing vRealize Suite Lifecycle Manager instances

Get Vrslcm Validation

Get the status of the validations for vRealize Lifecycle Manager deployment

Rollback Vrslcm

Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment

Validate Vrslcm

Validate the input specification for vRealize Suite Lifecycle Manager deployment

Vasa Providers

Add Storage Containers To Vasa Provider

Add the storage containers to a VASA Provider

Add Users To Vasa Provider

Add the users to a VASA Provider

Add Vasa Provider

Add a VASA Provider

Delete Storage Container Of Vasa Provider

Delete a storage container of a VASA Provider

Delete Vasa Provider

Delete a VASA Provider

Get Storage Containers Of Vasa Provider

Get the storage containers of a VASA Provider

Get Users Of Vasa Provider

Get the users of a VASA Provider

Get Validation Of Vasa Provider

Get the status of the validation of the VASA Provider

Get Vasa Provider

Get a VASA Provider

Get Vasa Providers

Get the VASA Providers

Update Storage Container Of Vasa Provider

Update the storage container of a VASA Provider

Update User Of Vasa Provider

Update the user of a VASA Provider

Update Vasa Provider

Update a VASA Provider

Validate Vasa Provider

Validate VasaProvider input specification

Vcf Services

Get Vcf Service

Get a VcfService

Get Vcf Services

Get the VcfServices

Version Aliases For Bundle Component Type

Delete Alias Versions By Software Type And Base Version

Delete Version Alias Configuration

Delete Version Alias By Software Type

Delete Version Alias for a bundle component type

Get Version Alias Configuration

Get Version Alias Configuration

Update Version Alias Configuration

Update Version Alias Configuration

Update Version Alias Configurations

Update Version Alias Configurations

Wsa

Get all existing Workspace ONE Access instances