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

Automation

Retrieve a list of VMware Aria Automation instances

Avns

Create Application Virtual Networks (AVN)

Retrieve Application Virtual Network (AVN) details

Validate Avn Spec

Perform validation of the AvnsCreationSpec specification

Backup Restore

Get Backup Configuration

Retrieve the backup configuration for SDDC Manager and NSX Manager

Get Restore Task

Retrieve the restore task

Set Backup Configuration

Configure the backup configuration for SDDC Manager and NSX Manager

Start a backup operation

Start a restore operation

Update Backup Configuration

Update the backup configuration for SDDC Manager and NSX Manager

Bundles

Retrieve a bundle by its ID

Retrieve a list of bundles

Get Bundles For Skip Upgrade

Retrieve a list of bundles for skip upgrade by domain ID

Start Bundle Download By ID

Start immediate download or schedule download of a bundle by ID

Update Bundle Compatibility Sets

Update the software compatability set for all bundles

Upload a bundle to SDDC Manager

Ceip

Get Ceip Status

Retrieve the CEIP status

Set Ceip Status

Configure CEIP to Opt-In or Opt-Out

Certificates

Configure Certificate Authority

Update the configuration of a Certificate Authority

Create Certificate Authority

Configure integration with a Certificate Authority

Request the download of CSR(s) for a domain in tar.gz format

Generate Certificates

Request the creation of signed certificate for resources of a domain

Generates CS Rs

Request the creation of certificate signing request (CSR) files for resources of a domain

Get Certificate Authorities

Retrieve a list of Certificate Authorities

Get Certificate Authority By Id

Retrive the details of a Certificate Authority by ID

Get Certificates By Domain

Retrieve the certificate details for all resources in a domain

Request available CSR(s) in JSON format for a domain

Get Domain Certificates

Retrieve the latest generated certificates for a domain by its ID

Get Resource Certificates Validation By ID

Retrieve the results of a certificate validation by its ID

Remove Certificate Authority

Remove the configuration of a Certificate Authority

Replace Certificates

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

Replace Resource Certificates

Replace the certificate(s) for selected resources of a domain

Upload Certificates

Import certificate(s) to the certificate store for a domain

Validate Resource Certificates

Perform validation of the ResourceCertificateSpec specification

Check Sets

Get Last Assessment Run Info

Get information about the last assessment run

Get the result for a given check run

Query Check Sets

Query for check-sets for the given resources

Trigger Check Run

Trigger a run of the selected checks

Trigger Partial Retry Of Check Run

Trigger partial retry of a completed check run

Clusters

Add Datastore To Cluster

Mount a datastore to a cluster

Assign Tags To Cluster

Assign Tags to Cluster

Create a cluster and add to an existing domain

Delete a cluster from a domain if it has been previously initialized for deletion

Get a cluster by its ID

Get Cluster Datastores

Get the list of all datastores associated with the cluster.

Get Cluster Network Configuration

Get cluster network configuration

Get Cluster Network Configuration Criteria

Get cluster network configuration criteria

Get Cluster Network Configuration Query Response

Get cluster network configuration query response

Retrieve a list of clusters

Get Cluster Tag Manager Url

Get Cluster Tag Manager Url

Get Datastore Criterion

Get a criterion to query for datastore

Get Datastore Query Response

Get Datastore query response

Get Datastores Criteria

Get all datastore criteria

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 Tag Assignable For Cluster

Get tags assignable to a cluster

Get Tags Assigned To Cluster

Get tags assigned to a cluster by its ID

Get Tags Assigned To Clusters

Get tags assigned to clusters

Get the list of VDSes of a cluster.

Import Vds To Inventory

Import Vds to inventory for the given cluster

Post Datastore Query

Post a datastore query

Post Host Query

Post a host query

Remove Datastore From Cluster

Unmount a datastore from a cluster

Remove Tags From Cluster

Remove tags from a cluster

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

Validate Cluster Creation Spec

Perform validation of the ClusterCreationSpec specification

Validate Cluster Update Spec

Perform validation of the ClusterUpdateSpec specification

Validate Vsan Remote Datastore Spec

Perform validation of the DatastoreMountSpec specification

Compatibility Matrix

Get Compatibility Matrices

Get Compatibility Matrices

Get Compatibility Matrix

Get Compatibility Matrix

Get Compatibility Matrix Content

Get Compatibility Matrix content

Get Compatibility Matrix Metadata

Get Compatibility Matrix Metadata

Update Compatibility Matrix

Update CompatibilityMatrix for a source with JSON file

Config Reconciler

Get configs associated with the given criteria

Get Reconciliation Task

Get config reconciliation task associated with the given task Id

Reconcile Configs

Reconcile configs

Credentials

Cancel Credentials Task

Cancel a failed credential task by its ID

Retrieve a credential by its ID

Get Credentials

Retrieve a list of credentials

Get Credentials Sub Task

Retrieve a credential sub task by its ID

Get Credentials Task

Retrieve a credential task by ID

Get Credentials Tasks

Retrieve a list of credential tasks

Get Credential Task By Resource ID

Retriece a credential taks by resource ID

Get Password Expiration

Fetch expiration details of passwords for a list of credentials

Get Password Expiration By Task ID

Retrive a password expiration task by ID

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

Retrieve the depot configuration

Update Depot Settings

Configure the depot credentials

Domains

Assign Tags To Domain

Assign tags to a domain

Create a domain

Remove a domain if it has been previously initialized for deletion

Get Assignable Tags For Domain

Get tags assignable to a domain

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 Datastore Criterion 1

Get a criterion to query for datastore

Get Datastore Query Response 1

Get Datastore query response

Get Datastores Criteria 1

Get all datastore criteria

Get a domain by its ID

Get Domain Endpoints

Retrieve a list of endpoints or URLs for a domain by its ID

Retrieve a list of domains

Get Domain Tag Manager Url

Get Domain Tag Manager Url

Get Tags Assigned To Domain

Get tags assigned to a domain

Get Tags Assigned To Domains

Get tags assigned to all domains

Post Cluster Query

Post a cluster query

Post Clusters Query

Post clusters query

Post Datastore Query 1

Post a datastore query

Remove Tags From Domain

remove Tags From Domain

Update a Domain

Validate Domain Creation Spec

Perform validation of the DomainCreationSpec specification

Fips Mode Details

Get FIPS Configuration

Retrieve the FIPS configration mode

Hosts

Assign Tags To Host

Assign tags to a host

Commission Hosts

Commission the Hosts

Decommission Hosts

Decommission the Hosts

Get Assignable Tag For Host

Get tags assignable to a host

Get all criteria

Get a criterion

Get a host by its ID

Get Host Commission Validation By ID

Retrieve the results of a host commission validation by its ID

Get Host Query Response 1

Get query response

Get Host Tag Manager Url

Get Host Tag Manager Url

Get Tags Assigned To Host

Get Tags assigned to Host

Get Tags Assigned To Hosts

Get Tags assigned to Hosts

Remove Tags From Host

Remove Tags From Host

Validate Host Commission Spec

Perform validation of the HostCommissionSpec specification

Identity Provider Precheck

Get Identity Precheck Result

Get Identity Provider Federation Precheck Result

Identity Providers

Add Embedded Identity Source

Add a new identity source to the embedded identity provider

Add External Identity Provider

Add a new external identity provider

Delete External Identity Provider

Remove an identity provider

Delete Identity Source

Delete an Identity Source

Generate Sync Client Token

Generate new sync client token

Get Identity Provider By Id

Get an identity provider by its id

Get Identity Providers

Get all identity providers

Update Embedded Identity Source

Update an identity source

Update External Identity Provider

Update an identity provider

License Keys

Add License Key

Add a a new license key

Get License Check Result By ID

Retrieve the results of a license check by its ID

Get License Information

Retrieve licensing information

Get License Key

Retrieve a license key

Get License Keys

Retrieve a list of license keys

Remove License Key

Remove a license key

Set License Key For Resource

Update a license key for a resource

Start License Check By Resource

Start a license check for a resource

Manifests

Save/Load manifest

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 the list of all Network Pools

Get Network Pool By ID

Get a Network Pool

Get Networks Of Network Pool

Get the Networks of a Network Pool

Update Network Pool

Update Network Pool

Nsx T Clusters

Get Nsx Cluster

Retrieve the details of an NSX cluster by its ID

Get Nsx Cluster Query Response

Get NSX cluster query response

Get Nsx Clusters

Retrieve a list of NSX clusters

Get Nsx Criteria

Get all NSX criteria

Get Nsx Criterion

Get a NSX criterion

Get Nsx Ip Address Pool

Retrieve an NSX IP Address Pool by its name

Get Nsx Ip Address Pools

Retrive a list of NSX IP Address Pools by the NSX cluster ID

Get Nsx Transport Zones

Retrieve list of all NSX transport zones

Get Validation Result Using GET

getValidationResult

Start Nsx Criteria Query

Start a query with NSX Criteria

Validate Ip Pool Using POST

Nsx Tedge Clusters

Create Edge Cluster

Create an NSX Edge Cluster

Get Edge Cluster

Retrieve an NSX Edge Cluster by its ID

Get Edge Clusters

Retrieve a list of NSX Edge Clusters

Get Edge Cluster Validation By ID

Retrieve the results of a NSX Edge Cluster validation by its ID

Update Edge Cluster

Expand or shrink an NSX Edge Cluster

Validate Edge Cluster Creation Spec

Perform validiation of the EdgeClusterCreationSpec specification

Validate Edge Cluster Update Spec

Perform validation of the EdgeClusterUpdateSpec specification

Operations

Connect Vrops With Domain

Connect or disconnect a domain with VMware Aria Operations

Retrieve a list of VMware Aria Operations instances

Get Vrops Integrated Domains

Retrieve a list of VMware Aria Operations integration status for domains

Operations For Logs

Connect Vrli With Domain

Connect or disconnect a domain with VMware Aria Operations for Logs

Get Vrli Integrated Domains

Retrieve a list of VMware Aria Operations for Logs integration status for domains

Retrieve a list of VMware Aria Operations for Logs instances

Personalities

Delete Personality

Delete the personality based on either name or id

Get Personalities

Get the Personalities

Get Personality

Get a Personality by its id

Rename Personality By Id

Rename personality based on ID

Upload Personality

Upload a Personality

Upload Personality Files

Upload personality files to SDDC Manager

Proxy Configuration

Get Proxy Configuration

Get the current Proxy configuration

Update Proxy Configuration

Update Proxy configuration

Pscs

Retrieve details of a Platform Service Controller (PSC)

Retrieve a list of Platform Service Controller (PSC)

Releases

Get Future Releases

Retrive a list of future release by domain ID

Retrieve a list of release including current and target versions

Get System Release

Retrieve the lowest deployed release of VMware Cloud Foundation

Resource Functionalities

Get Resource Functionalities

Get Resource Functionalities

Get Resources Functionalities Allowed Global

Get Resource Functionalities Allowed Global Configuration

Resource Warnings

Get Resource Warning

Get a Resource Warning by ID

Get Resource Warnings

Get Resource Warnings

Sddc

Export Bringup Detail Report

Get bringup report by ID

Export Bringup Validation Report

Get validation report by ID

Get Bringup App Info

Get information about the bringup application

Get Bringup Task By ID

Get a bringup task by its id

Get Bringup Tasks

Retrieve all bringup tasks

Get Bringup Validation

Retrieve the results of a bringup validation by its ID

Get Bringup Validations

Retrieve a list of bringup validations

Get Sddc Manager Info

Retrieve SDDC Manager VM details

Retry Bringup Validation

Retry bringup validation

Retry failed SDDC creation

Deploy a management domain

Start Bringup Spec Conversion

Convert SDDC specification Json/Excel File

Validate Bringup Spec

Perform validation of the SddcSpec specification

Sddc Managers

Get Local Os User Accounts

Get local OS user accounts from the SDDC Manager appliance

Get Sddc Manager

Retrieve the details of an SDDC Manager by its id

Get Sddc Managers

Retrieve a list of SDDC Managers

Sos

Export Health Check By ID

Download a Health Check tar.gz by its ID

Export Support Bundle By ID

Download a Support Bundle tar.gz by ID

Get Health Check Status

Retrieve the status of the Health Check operations

Get Health Check Task

Retieve a list of Health Check tasks

Get Support Bundle Status

Retrive the status of the Support Bundle operation

Get Support Bundle Task

Retrieve a list of Support Bundle tasks

Start Health Check

Start a Health Check operation using SoS

Start Support Bundle

Start a Support Bundle operation using SoS

Suite Lifecycle

Deploy VMware Aria Suite Lifecycle

Retrive information about VMware Aria Suite Lifecycle

Get all existing VMware Aria Suite Lifecycle instances

Get Vrslcm Validation

Retrieve the results of a VMware Aria Suite Lifecycle validation by its ID

Rollback Vrslcm

Remove VMware Aria Suite Lifecycle after an unsuccessful deployment

Update Vrslcm Version By Id In Inventory

Update the version of VMware Aria Suite Lifecycle based on its ID

Update Vrslcm Version In Inventory

Update the version of VMware Aria Suite Lifecycle

Validate Vrslcm

Perform validation of the VrslcmDeploymentSpec specification

System

Update the DNS configuration

Update the NTP configuration

Get Dns Configuration

Retrieve the DNS configuration

Get Ntp Configuration

Retrieve the NTP configuration

Get System Configuration

Retrieve the system configuration

Get Validation Of Dns Configuration

Retrieve the results of a DNS configuration validation by its ID

Get Validation Of Ntp Configuration

Retrieve the results of a NTP configuration validation by its ID

Get Validations Of DNS Configuration

Retrieve a list of DNS configuation validations

Get Validations Of Ntp Configuration

Retrieve a list of NTP configuation validations

Update System Configuration

Updates paramters of the system configuration

Validate Dns Configuration

Perform validation of the DnsConfiguration specification

Validate Ntp Configuration

Perform validation of the NtpConfiguration specification

System Prechecks

Get Precheck Task

Retrieve a precheck task by its id

Start a system precheck

Target Upgrade Version

Get Release By Domain

Retrieve a release view for a domain by its ID

Get Release By Domain 1

Retrieve a release view for all domains

Update Release By Domain ID

Modify the target upgrade release for a domain by its ID

Tasks

Retrieve a task by its ID

Retrieve a list of all tasks

Tokens

Create Token Pair

Invalidate Refresh Token

Invalidate Refresh Token

Refresh Access Token

Refresh Access Token

Trusted Certificates

Add Trusted Certificate

Add a trusted certificate to the SDDC Manager

Delete Trusted Certificate

Delete a trusted certificate from the SDDC Manager

Get Trusted Certificates

Retrieve all trusted certificates from SDDC Manager

Upgradables

Get Nsx Upgrade Resources

Retrieve a list of all upgradable NSX resources for a domain by its ID

Get Upgradables

Retrieve a list of all upgradable resources

Get Upgradables And Resource Errors

Get the Upgradables and Resource Errors

Get Upgradables By Domain

Retrieve a list of all upgradable resources for a domain by its ID

Get Upgradables Clusters

Retrieve a list of upgradable packages details from HSM for a domain by its ID

Upgrades

Get Upgrade By Id

Retrieve an upgrade by ID

Get Upgrade Precheck By ID

Retrieve an upgrade precheck task by ID

Retrieve a list of upgrades

Perform Upgrade

Start an upgrade operation

Start Upgrade Precheck

Start an upgrade precheck operation

Update Upgrade Schedule

Change a DRAFT upgrade to a SCHEDULED state

Users

Assign access to users in SDDC Manager

Get Local Account

Get local account details

Retrieve a list of roles from SDDC Manager

Get SSO Domain Entities

Retrieve a list of users and groups from a domain in vCenter Single Sign-On

Get SSO Domains

Retrieive a list of domains from vCenter Single Sign-On

Retrieve a list of users assigned access via SDDC Manager

Retrieve a list of users from SDDC Manager

Remove access for a user in SDDC Manager

Update Local User Password

Update password for local account

V Centers

Retrieve a vCenter Server by its ID

Retrieve a list of vCenter Servers

V Sanhealth Check

Get Vsan Health Check By Domain

Retrieve vSAN Health Check status for a domain by its ID

Get Vsan Health Check By Query ID

Retrieve vSAN Health Check status for a domain and query ID

Get Vsan Health Check By Task ID

Retrieve a vSAN Health Check by task ID

Update Vsan Health Check By Domain

Update the vSAN Health Check status for a domain

Vasa Providers

Add Vasa Provider

Add a VASA Provider

Add Vasa Provider Storage Container

Add the storage containers to a VASA Provider

Add Vasa Provider User

Add the users to a VASA Provider

Get Vasa Provider

Get a VASA Provider

Get Vasa Providers

Get the VASA Providers

Get Vasa Provider Storage Containers

Get the storage containers of a VASA Provider

Get Vasa Provider User

Get the users of a VASA Provider

Get Vasa Provider Validation

Get the status of the validation of the VASA Provider

Remove Vasa Provider

Delete a VASA Provider

Remove Vasa Provider Storage Container

Delete a storage container of a VASA Provider

Update Vasa Provider

Update a VASA Provider

Update Vasa Provider Storage Container

Update the storage container of a VASA Provider

Update Vasa Provider User

Update the user of a VASA Provider

Validate Vasa Provider Spec

Validate VasaProvider input specification

Vcf Services

Get Vcf Service

Retrieve an SDDC Manager service by its ID

Get Vcf Services

Retrieve a list of SDDC Manager services

Version Aliases For Bundle Component Type

Delete Alias Versions By Software Type And Base Version

Removes Version Alias Configuration by component type and version

Delete Version Alias By Software Type

Removes Version Alias Configuration by component type

Get Version Alias Configuration

Retrieve Version Alias Configuration

Update Version Alias Configuration

Update the Version Alias Configuration by component type

Update Version Alias Configurations

Update Version Alias Configurations

Wsa

Retrieve a list of Workspace ONE Access instances