Operations

GET https://{server}/rest/appliance/networking/firewall/inbound

Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. This operation was added in vSphere API 6.7.1.

PUT https://{server}/rest/appliance/networking/firewall/inbound

Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows:

Address	Prefix	Interface Name	Policy
10.112.0.1	0	*	REJECT
10.112.0.1	0	nic0	ACCEPT

In the above example, the first rule drops all packets originating from 10.112.0.1 and
the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set. This operation was added in vSphere API 6.7.1.

appliance networking interfaces

interfaces

interfaces service provides operations Provides information about network interface.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/networking/interfaces/{interface_name}	Get information about a particular network interface.
list	GET https://{server}/rest/appliance/networking/interfaces	Get list of available network interfaces, including those that are not yet configured.

ipv4

The ipv4 service provides operations to perform IPv4 network configuration for interfaces. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/networking/interfaces/{interface_name}/ipv4	Get IPv4 network configuration for specific NIC. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/networking/interfaces/{interface_name}/ipv4	Set IPv4 network configuration for specific network interface. This operation was added in vSphere API 6.7.

ipv6

The ipv6 service provides operations to perform IPv6 network configuration for interfaces. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/networking/interfaces/{interface_name}/ipv6	Get IPv6 network configuration for specific interface. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/networking/interfaces/{interface_name}/ipv6	Set IPv6 network configuration for specific interface. This operation was added in vSphere API 6.7.

no proxy

The no_proxy service provides operations to configure a connection that does not need a proxy. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/networking/noproxy	Returns servers for which no proxy configuration will be applied. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/networking/noproxy	Sets servers for which no proxy configuration should be applied. This operation sets environment variables. In order for this operation to take effect, a logout from appliance or a service restart is required. If IPv4 is enabled, "127.0.0.1" and "localhost" will always bypass the proxy (even if they are not explicitly configured). This operation was added in vSphere API 6.7.

proxy

The proxy service provides operations Proxy configuration. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
delete	DELETE https://{server}/rest/appliance/networking/proxy/{protocol}	Deletes a proxy configuration for a specific protocol. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/networking/proxy/{protocol}	Gets the proxy configuration for a specific protocol. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/appliance/networking/proxy	Gets proxy configuration for all configured protocols. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/networking/proxy/{protocol}	Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required. This operation was added in vSphere API 6.7.
test	POST https://{server}/rest/appliance/networking/proxy/{protocol}?action=test	Tests a proxy configuration by testing the connection to the proxy server and test host. This operation was added in vSphere API 6.7.

routes

routes service provides operations Performs networking routes operations. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/networking/routes	Get main routing table. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/rest/appliance/networking/routes	Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
test	POST https://{server}/rest/appliance/networking/routes?action=test	Test connection to a list of gateways. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

ntp

ntp service provides operations Gets NTP configuration status and tests connection to ntp servers. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/ntp	Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/ntp	Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration. This operation was added in vSphere API 6.7.
test	POST https://{server}/rest/appliance/ntp/test	Test the connection to a list of ntp servers. This operation was added in vSphere API 6.7.

appliance recovery

The appliance.recovery API provides services for backin up and restoring vCenter Appliance configuration. The API is available starting in vSphere 6.7.

recovery

The recovery service provides operations to invoke an appliance recovery (backup and restore). This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/recovery	Gets the properties of the appliance Recovery subsystem. This operation was added in vSphere API 6.7.

appliance recovery backup

backup

backup service provides operations Performs backup restore operations

Operation	HTTP request	Description
validate	POST https://{server}/rest/appliance/recovery/backup/validate	Check for backup errors without starting backup.

appliance recovery backup job

job

The job service provides operations to be performed on a backup job.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/appliance/recovery/backup/job/{id}/cancel	Cancel the backup job.
create	POST https://{server}/rest/appliance/recovery/backup/job	Initiate backup.
get	GET https://{server}/rest/appliance/recovery/backup/job/{id}	See backup job progress/result.
list	GET https://{server}/rest/appliance/recovery/backup/job	Get list of backup jobs

details

The details service provides operations to get the details about backup jobs. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
list	GET https://{server}/rest/appliance/recovery/backup/job/details	Returns detailed information about the current and historical backup jobs. This operation was added in vSphere API 6.7.

parts

parts service provides operations Provides list of parts optional for the backup

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/recovery/backup/parts/{id}	Gets the size (in MB) of the part.
list	GET https://{server}/rest/appliance/recovery/backup/parts	Gets a list of the backup parts.

schedules

The schedules service provides operations to be performed to manage backup schedules. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
create	POST https://{server}/rest/appliance/recovery/backup/schedules/{schedule}	Creates a schedule. This operation was added in vSphere API 6.7.
delete	DELETE https://{server}/rest/appliance/recovery/backup/schedules/{schedule}	Deletes an existing schedule. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/recovery/backup/schedules/{schedule}	Returns an existing schedule information based on id. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/appliance/recovery/backup/schedules	Returns a list of existing schedules with details. This operation was added in vSphere API 6.7.
run	POST https://{server}/rest/appliance/recovery/backup/schedules/{schedule}?action=run	Initiate backup with the specified schedule. This operation was added in vSphere API 6.7.
update	PUT https://{server}/rest/appliance/recovery/backup/schedules/update/{schedule}	Updates a schedule. This operation was added in vSphere API 6.7.

appliance recovery backup system name

system name

The system_name service provides operations to enumerate system names of appliance backups. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
list	GET https://{server}/rest/appliance/recovery/backup/system-name	Returns a list of system names for which backup archives exist under `loc_spec`. This operation was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/recovery/backup/system-name/{system_name}/archives/{archive}	Returns the information for backup corresponding to given backup location and system name. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/appliance/recovery/backup/system-name/{system_name}/archives	Returns information about backup archives corresponding to given backup location and system name, which match the appliance.recovery.backup.system_name.archive.filter_spec. This operation was added in vSphere API 6.7.

appliance recovery reconciliation

job

The job service provides operations to create and get the status of reconciliation job. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
create	POST https://{server}/rest/appliance/recovery/reconciliation/job	Initiate reconciliation. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/recovery/reconciliation/job	Get reconciliation job progress/result. This operation was added in vSphere API 6.7.

appliance recovery restore

restore

restore service provides operations Performs restore operations

Operation	HTTP request	Description
validate	POST https://{server}/rest/appliance/recovery/restore/validate	Get metadata before restore

job

job service provides operations Performs restore operations

Operation	HTTP request	Description
cancel	POST https://{server}/rest/appliance/recovery/restore/job/cancel	Cancel the restore job
create	POST https://{server}/rest/appliance/recovery/restore/job	Initiate restore.
get	GET https://{server}/rest/appliance/recovery/restore/job	See restore job progress/result.

services

The Service service provides operations to manage a single/set of appliance services. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/services/{service}	Returns the state of a service. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/appliance/services	Lists details of vCenter services. This operation was added in vSphere API 6.7.
restart	POST https://{server}/rest/appliance/services/{service}/restart	Restarts a service. This operation was added in vSphere API 6.7.
start	POST https://{server}/rest/appliance/services/{service}/start	Starts a service. This operation was added in vSphere API 6.7.
stop	POST https://{server}/rest/appliance/services/{service}/stop	Stops a service. This operation was added in vSphere API 6.7.

shutdown

shutdown service provides operations Performs reboot/shutdown operations on appliance. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/appliance/shutdown/cancel	Cancel pending shutdown action. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/shutdown	Get details about the pending shutdown action. This operation was added in vSphere API 6.7.
poweroff	POST https://{server}/rest/appliance/shutdown/poweroff	Power off the appliance. This operation was added in vSphere API 6.7.
reboot	POST https://{server}/rest/appliance/shutdown/reboot	Reboot the appliance. This operation was added in vSphere API 6.7.

appliance support bundle

support bundle

The support_bundle service provides operations to create support bundle task, cancel, list and list components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create-task	POST https://{server}/api/appliance/support-bundle	Create a support bundle. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/appliance/support-bundle	Get list of support-bundles generated. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

components

The SupportBundleComponents service provides operations to get the supported support bundle components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/support-bundle/components	Get list of components/manifests included in the support bundle. Manifests for a component specifies the files for a particular component that all needs to be collected as part of support bundle. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

appliance system

The appliance.system API provides services to query the appliance system information. The API is available starting in vSphere 6.5.

appliance system security

enhanced security

The enhanced_security service provides operations to enable/disable enhanced security in the appliance for specific environment (GovCloud).

Operation	HTTP request	Description
set	PUT https://{server}/rest/appliance/system/enhanced-security	Enable/Disable advanced security (IL4/IL5).

file integrity

The file_integrity service provides operations to perform file integrity operations in the appliance.

Operation	HTTP request	Description
baseline	POST https://{server}/rest/appliance/system/file-integrity/baseline	Create file integrity baseline for the appliance.
get	GET https://{server}/rest/appliance/system/file-integrity/check	Get state for scheduled file integrity check.
set	PUT https://{server}/rest/appliance/system/file-integrity/check	Set enabled state for scheduled file integrity check.

global fips

The global_fips service provides operations to enable/disable appliance FIPS mode.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/system/global-fips	Get current appliance FIPS settings.
update	PUT https://{server}/api/appliance/system/global-fips	Enable/Disable Global FIPS mode for the appliance.

global fips internal

The global_fips_internal service provides operations to get appliance FIPS mode by internal services.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/system/internal/global-fips	Get current appliance FIPS settings.

storage

storage service provides operations Appliance storage configuration

Operation	HTTP request	Description
list	GET https://{server}/rest/appliance/system/storage	Get disk to partition mapping.
resize	POST https://{server}/rest/appliance/system/storage/resize	Resize all partitions to 100 percent of disk size.
resize_ex	POST https://{server}/rest/appliance/system/storage?action=resize-ex	Resize all partitions to 100 percent of disk size. This operation was added in vSphere API 6.7.

appliance system time

time

time service provides operations Gets system time.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/system/time	Get system time.

timezone

The timezone service provides operations to get and set the appliance timezone. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/system/time/timezone	Get time zone. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/system/time/timezone	Set time zone. This operation was added in vSphere API 6.7.

uptime

uptime service provides operations Get the system uptime.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/system/uptime	Get the system uptime.

uuid

The uuid service provides operations to get the UUID for the appliance. This api will be primarily used for Applmgmt UI Telemetry. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/system/uuid	Get the vCSA UUID (Unique IDentifier for the appliance). Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

version

version service provides operations Get the appliance version.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/system/version	Get the version.

appliance techpreview

appliance techpreview localaccounts

user

user service provides operations Perform operations on local user account.

Operation	HTTP request	Description
add	POST https://{server}/rest/appliance/techpreview/local-accounts/user	Create a new local user account.
delete	DELETE https://{server}/rest/appliance/techpreview/local-accounts/user/{username}	Delete a local user account.
get	GET https://{server}/rest/appliance/techpreview/local-accounts/user/{username}	Get the local user account information.
list	GET https://{server}/rest/appliance/techpreview/local-accounts/user	List of local accounts
set	PUT https://{server}/rest/appliance/techpreview/local-accounts/user	Update local user account properties role, full name, enabled status and password

appliance techpreview monitoring

snmp

snmp service provides operations SNMP agent operations.

Operation	HTTP request	Description
disable	POST https://{server}/rest/appliance/techpreview/monitoring/snmp/disable	Stop an enabled SNMP agent.
enable	POST https://{server}/rest/appliance/techpreview/monitoring/snmp/enable	Start a disabled SNMP agent.
get	GET https://{server}/rest/appliance/techpreview/monitoring/snmp	Return an SNMP agent configuration.
hash	POST https://{server}/rest/appliance/techpreview/monitoring/snmp/hash	Generate localized keys for secure SNMPv3 communications.
limits	GET https://{server}/rest/appliance/techpreview/monitoring/snmp/limits	Get SNMP limits information.
reset	POST https://{server}/rest/appliance/techpreview/monitoring/snmp/reset	Restore settings to factory defaults.
set	PUT https://{server}/rest/appliance/techpreview/monitoring/snmp	Set SNMP configuration.
stats	GET https://{server}/rest/appliance/techpreview/monitoring/snmp/stats	Generate diagnostics report for snmp agent.
test	POST https://{server}/rest/appliance/techpreview/monitoring/snmp/test	Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).

appliance techpreview networking

appliance techpreview networking firewall addr

inbound

inbound service provides operations Operations for firewall rules.

Operation	HTTP request	Description
add	POST https://{server}/rest/appliance/techpreview/networking/firewall/addr/inbound	Add a firewall rule to allow or deny traffic from incoming IP address.
delete	POST https://{server}/rest/appliance/techpreview/networking/firewall/addr/inbound/delete	Delete specific rule at a given position or delete all rules.
list	GET https://{server}/rest/appliance/techpreview/networking/firewall/addr/inbound	Get ordered list of inbound IP addresses that are allowed or denied by firewall.
set	PUT https://{server}/rest/appliance/techpreview/networking/firewall/addr/inbound	Set list of inbound IP addresses to allow or deny by firewall. This replaces all existing rules. Firewall rules have no impact on closed ports because these ports are closed for all traffic.

ipv4

ipv4 service provides operations Performs IPV4 network configuration for interfaces.

Operation	HTTP request	Description
get	POST https://{server}/rest/appliance/techpreview/networking/ipv4/get	Get IPv4 network configuration for interfaces.
list	GET https://{server}/rest/appliance/techpreview/networking/ipv4	Get IPv4 network configuration for all configured interfaces.
renew	POST https://{server}/rest/appliance/techpreview/networking/ipv4/renew	Renew IPv4 network configuration on interfaces. If the interface is configured to use DHCP for IP address assignment, the lease of the interface is renewed.
set	PUT https://{server}/rest/appliance/techpreview/networking/ipv4	Set IPv4 network configuration.

ipv6

ipv6 service provides operations Performs IPV4 network configuration for interfaces.

Operation	HTTP request	Description
get	POST https://{server}/rest/appliance/techpreview/networking/ipv6/get	Get IPv6 network configuration for interfaces.
list	GET https://{server}/rest/appliance/techpreview/networking/ipv6	Get IPv6 network configuration for all configured interfaces.
set	PUT https://{server}/rest/appliance/techpreview/networking/ipv6	Set IPv6 network configuration.

routes

routes service provides operations Performs networking routes operations.

Operation	HTTP request	Description
add	POST https://{server}/rest/appliance/techpreview/networking/routes	Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.
delete	POST https://{server}/rest/appliance/techpreview/networking/routes/delete	Delete static routing rules.
list	GET https://{server}/rest/appliance/techpreview/networking/routes	Get main routing table. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.
set	PUT https://{server}/rest/appliance/techpreview/networking/routes	Set static routing rules. A destination of 0.0.0.0 and prefix 0 (for IPv4) or destination of :: and prefix 0 (for IPv6) refers to the default gateway.
test	POST https://{server}/rest/appliance/techpreview/networking/routes/test	Test connection to a list of gateways

appliance techpreview services

services

services service provides operations Manages services.

Operation	HTTP request	Description
list	GET https://{server}/rest/appliance/techpreview/services	Get a list of all known services.
restart	POST https://{server}/rest/appliance/techpreview/services/restart	start or restart a service
stop	POST https://{server}/rest/appliance/techpreview/services/stop	Stop a service

status

status service provides operations Get status of a service.

Operation	HTTP request	Description
get	POST https://{server}/rest/appliance/techpreview/services/status/get	Get status of a service.

appliance techpreview system

update

update service provides operations Performs update repository configuration.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/techpreview/system/update	Get update repository configuration.
set	PUT https://{server}/rest/appliance/techpreview/system/update	Set update repository configuration.

timesync

timesync service provides operations Performs time synchronization configuration. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/timesync	Get time synchronization mode. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/timesync	Set time synchronization mode. This operation was added in vSphere API 6.7.

appliance update

The appliance.update API provides services for updating the software in the appliance. The API is available starting in vSphere 6.5.

update

The update service provides operations to get the status of the appliance update. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/appliance/update?action=cancel	Request the cancellation the update operation that is currently in progress. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/update	Gets the current status of the appliance update. This operation was added in vSphere API 6.7.

history

The history service provides operations to get update history. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/update/history/{version}	Returns detailed information about a particular installed update. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/appliance/update/history	Returns information about the list of updates installed. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

pending

The pending service provides operations to manipulate pending updates. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/update/pending/{version}	Gets update information. This operation was added in vSphere API 6.7.
install	POST https://{server}/rest/appliance/update/pending/{version}?action=install	Starts operation of installing the appliance update. Will fail is the update is not staged. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/appliance/update/pending	Checks if new updates are available. This operation was added in vSphere API 6.7.
precheck	POST https://{server}/rest/appliance/update/pending/{version}?action=precheck	Runs update precheck. This operation was added in vSphere API 6.7.
stage	POST https://{server}/rest/appliance/update/pending/{version}?action=stage	Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL. This operation was added in vSphere API 6.7.
stage_and_install	POST https://{server}/rest/appliance/update/pending/{version}?action=stage-and-install	Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL. This operation was added in vSphere API 6.7.
validate	POST https://{server}/rest/appliance/update/pending/{version}?action=validate	Validates the user provided data before the update installation. This operation was added in vSphere API 6.7.

policy

The policy service provides operations to set/get background check for the new updates. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/update/policy	Gets the automatic update checking and staging policy. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/appliance/update/policy	Sets the automatic update checking and staging policy. This operation was added in vSphere API 6.7.

staged

The staged service provides operations to get the status of the staged update. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
delete	DELETE https://{server}/rest/appliance/update/staged	Deletes the staged update. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/appliance/update/staged	Gets the current status of the staged update. This operation was added in vSphere API 6.7.

appliance vcenter settings v1

The appliance.vcenter.settings.v1 API provides services to manage the ConfigManagement.

appliance vcenter settings v1 config

The appliance.vcenter.settings.v1.config API provides services to manage the ConfigManagement.

config

The config service provides operations to manage desired configuration specification of vCenter.

Operation	HTTP request	Description
apply-task	POST https://{server}/api/appliance/vcenter/settings/v1/config/{version}/	Apply the specified profile as the desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check-task	POST https://{server}/api/appliance/vcenter/settings/v1/config/{version}	Validates the Profile configuration. The result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
create	POST https://{server}/api/appliance/vcenter/settings/v1/config	Creates a Profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
delete	DELETE https://{server}/api/appliance/vcenter/settings/v1/config	Deletes a profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
get	GET https://{server}/api/appliance/vcenter/settings/v1/config	Returns information about a profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
scan-task	POST https://{server}/api/appliance/vcenter/settings/v1/config/{version}	Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
scan_desired_state-task	POST https://{server}/api/appliance/vcenter/settings/v1/config	Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
set	PUT https://{server}/api/appliance/vcenter/settings/v1/config	Updates the configuration of the currently created profile. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

components

The components service provides operations to get the information about appliance/vCenter components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/vcenter/settings/v1/config/components	Returns the list of desired component specification for the vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

last check result

The last_check_result service provides operations to get the last profile check result for an appliance. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/vcenter/settings/v1/config/last-check-result	Returns the last check results of the profile. Results will be persisted in cache maximum 5 mins. After that user need to call the check api for the check results. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

last scan result

The last_scan_result service provides operations to get the last profile scan result for an appliance. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/vcenter/settings/v1/config/last-scan-result	Returns the last run scan result on the profile. Results will be persisted in cache maximum 5 mins. After that user needs to call the scan api for the scan results. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

config current

The config_current service provides operations to get the current state of the vCenter. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
get	GET https://{server}/api/appliance/vcenter/settings/v1/config-current	Returns the current state of the vCenter. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

appliance vmon

The appliance.vmon API provides services to manage a set of services that are part of the vCenter Server.

service

The service service provides operations to manage a single/set of services that are managed by vMon.

Operation	HTTP request	Description
get	GET https://{server}/rest/appliance/vmon/service/{service}	Returns the state of a service.
list_details	GET https://{server}/rest/appliance/vmon/service	Lists details of services managed by vMon.
restart	POST https://{server}/rest/appliance/vmon/service/{service}/restart	Restarts a service
start	POST https://{server}/rest/appliance/vmon/service/{service}/start	Starts a service
stop	POST https://{server}/rest/appliance/vmon/service/{service}/stop	Stops a service
update	PATCH https://{server}/rest/appliance/vmon/service/{service}	Updates the properties of a service.

cdc

The cdc API provides services to listen for resource life-cycle or model changes. The API is available starting in vSphere 6.5.

change log

A fully-ordered, read-only log of resource change events. Clients can use it to listen for resource life-cycle or model changes that occur in the system. A client can request all changes that have occurred since its previous change request by providing the sequence token obtained from the result of the previous change request.

Operation	HTTP request	Description
get_changes	POST https://{server}/rest/com/vmware/cdc/change-log?~action=get-changes	Returns all resource change events that have occurred since the provided sequence token. The latter uniquely identifies the first change event in the ordered sequence of change events that must be read. In case the provided sequence token is the most recent one in the Change Log, i.e. there are no new change events to be returned, the server will delay the response (up to a time limit defined by the server) until new changes can be returned. This helps eliminating the overhead of empty request/response calls.
get_current_sequence	POST https://{server}/rest/com/vmware/cdc/change-log?~action=get-current-sequence	Returns a token which identifies the end of the current sequence of changed data events. Any client who wants to retrieve change events should use this method before get_changes in order to initialize its own sequence. The returned value is opaque to the consumer and should not be parsed nor interpreted in any way.

cis

The cis API provides VMware common infrastructure services.

cis data

The cis.data API provides services for uniform data access to the resource model data of the CIS services. The API is available starting in vSphere 6.5.

cis data provider

The cis.data.provider API provides services for uniform data access to the resource model data of a Data Provider. The API is available starting in vSphere 6.5.

cis data provider metadata

schema

Provides access to the resource model schema of a Data Provider. The schema describes all resource models supported by the provider as well as information about the model properties and how they could be queried.

This schema describes all resource models that could be queried via the cis.data.provider.resource_model interface. Hence, any Data Provider that implements the latter must also implement this interface in order to expose its resource model schema.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/cis/data/provider/metadata/schema?~action=get	Information about the resource model schema of the Data Provider. The schema describes all resource models supported by the provider as well as information about the model properties and how they could be queried.

resource model

Represents a uniform data access interface to the resource model data of a Data Provider. Provides a convenient API for search and retrieval of specific projections on the targeted resource model data. Clients can use this interface to navigate through the data provider's inventory using filtering by various resource model property criteria.

Every VMODL2 Data Provider must implement this interface as well as cis.data.provider.metadata.schema interface. The latter is used to advertise the schema of the resource models that could be queried.

Operation	HTTP request	Description
query	POST https://{server}/rest/com/vmware/cis/data/provider/resource-model?~action=query	Executes the provided cis.data.provider.resource_model.query_spec instance, i.e. retrieve a snapshot of the resource model data as specified in the query.

resource model

Represents a uniform data access interface to the resource model data of the CIS services. Provides a convenient API for search and retrieval of specific projections on the targeted resource model data. Clients can use this interface to navigate through the CIS inventory by using filters, i.e. one or a combination of multiple predicates (conditions) on the targeted resource models properties.

Operation	HTTP request	Description
query	POST https://{server}/rest/com/vmware/cis/data/resource-model?~action=query	Executes the provided cis.data.resource_model.query_spec instance, i.e. retrieve a snapshot of the resource model data as specified in the query.

cis data svc

The cis.data.svc API provides services for uniform data access to the resource model data of the CIS services. The API is available starting in vSphere 6.5.

resource model

Operation	HTTP request	Description
query	POST https://{server}/rest/com/vmware/cis/data/svc/resource-model?~action=query	Executes the provided cis.data.svc.resource_model.query_spec instance, i.e. retrieve a snapshot of the resource model data as specified in the query.

session

The session service allows API clients to manage session tokens including creating, deleting and obtaining information about sessions.

The create operation creates session token in exchange for another authentication token.
The delete operation invalidates a session token.
The get retrieves information about a session token.

The call to the create operation is part of the overall authentication process for API clients. For example, the sequence of steps for establishing a session with SAML token is:

Connect to lookup service.
Discover the secure token service (STS) endpoint URL.
Connect to the secure token service to obtain a SAML token.
Authenticate to the lookup service using the obtained SAML token.
Discover the API endpoint URL from lookup service.
Call the create operation. The create call must include the SAML token.

See the programming guide and samples for additional information about establishing API sessions.

Execution Context and Security Context

To use session based authentication a client should supply the session token obtained through the create operation. The client should add the session token in the security context when using SDK classes. Clients using the REST API should supply the session token as a HTTP header.

Session Lifetime

A session begins with call to the create operation to exchange a SAML token for a API session token. A session ends under the following circumstances:

Call to the delete operation.
The session expires. Session expiration may be caused by one of the following situations:
- Client inactivity - For a particular session identified by client requests that specify the associated session ID, the lapsed time since the last request exceeds the maximum interval between requests.
- Unconditional or absolute session expiration time: At the beginning of the session, the session logic uses the SAML token and the system configuration to calculate absolute expiration time.

When a session ends, the authentication logic will reject any subsequent client requests that specify that session. Any operations in progress will continue to completion.

Error Handling

The cis.session returns the following errors:

vapi.std.errors.unauthenticated error for any errors related to the request.
vapi.std.errors.service_unavailable error for all errors caused by internal service failure.

Operation

HTTP request

Description

POST https://{server}/rest/com/vmware/cis/session

Creates a session with the API. This is the equivalent of login. This operation exchanges user credentials supplied in the security context for a session identifier that is to be used for authenticating subsequent calls. To authenticate subsequent calls clients are expected to include the session key.

delete

DELETE https://{server}/rest/com/vmware/cis/session

Terminates the validity of a session token. This is the equivalent of log out.

A session identifier is expected as part of the request.

POST https://{server}/rest/com/vmware/cis/session?~action=get

Returns information about the current session. This operation expects a valid session identifier to be supplied.

A side effect of invoking this operation may be a change to the session's last accessed time to the current time if this is supported by the session implementation. Invoking any other operation in the API will also update the session's last accessed time.

This API is meant to serve the needs of various front end projects that may want to display the name of the user. Examples of this include various web based user interfaces and logging facilities.

cis tagging

The cis.tagging component provides operations and structures to attach metadata, by means of tags, to vSphere objects to make these objects more sortable and searchable. You can use it to create, manage, and enumerate tags and their categories (the group a tag belongs to). You can also query the attached tags and attached objects.

batch

The batch service provides operations to query category, tag, and tag association information in batch. All operations return successfully. Error or insufficient privilege on an individual object will not result in a thrown exception, instead it will just be skipped. This service was added in vSphere API 6.5.

Operation	HTTP request	Description
find_tags_by_name	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=find-tags-by-name	Enumerates all tags containing `tag_name` in its names. You should note that tag names are only unique under its own category. To invoke this opertaion, you need the read privilege on each tag. This operation was added in vSphere API 6.5.
get_all_categories	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=get-all-categories	Fetches all the category information in the system. You need the read privilege on each category to view its information. This operation was added in vSphere API 6.5.
get_all_tags	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=get-all-tags	Fetches all tag information in the system. You need the read privilege on each tag to view its information. This operation was added in vSphere API 6.5.
get_categories	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=get-categories	Fetches the category information for the given category identifiers. You need the read privilege on each category to view its information. This operation was added in vSphere API 6.5.
get_tags	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=get-tags	Fetches the tag information for the given tag identifiers. You need the read privilege on each tag to view its information. This operation was added in vSphere API 6.5.
list_all_attached_objects_on_tags	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-all-attached-objects-on-tags	Fetches the array of tag identifier to the identifiers of the objects its attached to for all tags in the system. To invoke this operation, you need the read privilege on each tag to be returned. The array of object identifiers will only contain those objects for which you have read privileges. This operation was added in vSphere API 6.5.
list_attached_objects	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-attached-objects	Fetches the array of object identifiers to which the input tags are attached. Objects will only appear once in the array regardless of if several input tags are attached to it. To invoke this operation, you need the read privilege on each input tag. The array of object identifiers will only contain those objects for which you have read privileges. Note that this operation does not preserve the mappings between tag identifier and object identifiers. This operation was added in vSphere API 6.5.
list_attached_objects_on_tags	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-attached-objects-on-tags	Fetches the array of tag identifier to the identifiers of the objects its attached to. To invoke this operation, you need the read privilege on each input tag. The array of object identifiers will only contain those objects for which you have read privileges. This operation was added in vSphere API 6.5.
list_attached_tags	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-attached-tags	Fetches the array of tag identifiers of the tags attached to the input objects. Tags will only appear once in the array regardless of if they are attached to several of the input objects. To invoke this operation, you need the read privilege on each input object. The array of tag identifiers will only contain those tags for which you have read privileges. Note that this operation does not preserve the mappings between object identifier and tag identifiers. This operation was added in vSphere API 6.5.
list_attached_tags_on_objects	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-attached-tags-on-objects	Fetches the array of object identifier to the identifiers of the tags attached to that object. To invoke this operation, you need the read privilege on each input object. The array of tag identifiers will only contain those tags for which you have read privileges. This operation was added in vSphere API 6.5.
list_tags_for_categories	POST https://{server}/rest/com/vmware/cis/tagging/batch?~action=list-tags-for-categories	Enumerates all tags for the given @{term list} of categories. To invoke this operation, you need the read privilege on each category and the individual tags in that category. This operation was added in vSphere API 6.5.

cis tagging category

The com.vmware.cis.category API provides services for managing tag categories.

host

The host service provides operations to list categories that have hosts as an attachable type. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/cis/tagging/category/host	Returns information about the categories that have hosts as an attachable type. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

VM

The VM service provides operations to list categories that have virtual machines as an attachable type. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/cis/tagging/category/vm	Returns information about the categories that have virtual machines as an attachable type. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

cis tagging sessions

session manager

Session management interface for the publish API

Operation	HTTP request	Description
keep_alive	POST https://{server}/rest/com/vmware/cis/tagging/sessions/session-manager?~action=keep-alive	Keeps a session id alive. Session Id should be provided in the SecurityContext.
login	POST https://{server}/rest/com/vmware/cis/tagging/sessions/session-manager?~action=login	Logs a user and returns a session id. Authentication information should be provided in the SecurityContext.
logout	POST https://{server}/rest/com/vmware/cis/tagging/sessions/session-manager?~action=logout	Invalidates a session. Session Id should be provided in the SecurityContext.

cis tagging tag

The com.vmware.cis.tag API provides services for managing tags.

tag

The tag service provides operations to create, read, update, delete, and enumerate tags.

Operation	HTTP request	Description
add_to_used_by	POST https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=add-to-used-by	Adds the `used_by_entity` to the cis.tagging.tag_model.used_by subscribers set. If the `used_by_entity` is already in the set, then this becomes a no-op. To invoke this operation, you need the modify cis.tagging.tag_model.used_by privilege on the tag.
create	POST https://{server}/rest/com/vmware/cis/tagging/tag	Creates a tag. To invoke this operation, you need the create tag privilege on the input category.
delete	DELETE https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}	Deletes an existing tag. To invoke this operation, you need the delete privilege on the tag.
get	GET https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}	Fetches the tag information for the given tag identifier. To invoke this operation, you need the read privilege on the tag in order to view the tag info.
list	GET https://{server}/rest/com/vmware/cis/tagging/tag	Enumerates the tags in the system. To invoke this operation, you need read privilege on the individual tags. The array will only contain tags for which you have read privileges.
list_tags_for_category	POST https://{server}/rest/com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category	Enumerates all tags for the given category. To invoke this operation, you need the read privilege on the given category and the individual tags in that category.
list_used_tags	POST https://{server}/rest/com/vmware/cis/tagging/tag?~action=list-used-tags	Enumerates all tags for which the `used_by_entity` is part of the cis.tagging.tag_model.used_by subscribers set. To invoke this operation, you need the read privilege on the individual tags.
remove_from_used_by	POST https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by	Removes the `used_by_entity` from the cis.tagging.tag_model.used_by subscribers set. If the `used_by_entity` is not using this tag, then this becomes a no-op. To invoke this operation, you need modify cis.tagging.tag_model.used_by privilege on the tag.
revoke_propagating_permissions	POST https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=revoke-propagating-permissions	Revokes all propagating permissions on the given tag. You should then attach a direct permission with tagging privileges on the given tag. To invoke this operation, you need tag related privileges (direct or propagating) on the concerned tag.
update	PATCH https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}	Updates an existing tag. To invoke this operation, you need the edit privilege on the tag.

host

The host service provides operations to list tags that can be attached to hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/cis/tagging/tag/host	Returns information about the tags that can be attached to virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

VM

The VM service provides operations to list tags that can be attached to virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/cis/tagging/tag/vm	Returns information about the tags that can be attached to virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

tag association

The tag_association service provides operations to attach, detach, and query tags.

Operation	HTTP request	Description
attach	POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach	Attaches the given tag to the input object. The tag needs to meet the cardinality (cis.tagging.category_model.cardinality) and associability (cis.tagging.category_model.associable_types) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this operation is a no-op and an error will not be thrown. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on the object.
attach_multiple_tags_to_object	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=attach-multiple-tags-to-object	Attaches the given tags to the input object. If a tag is already attached to the object, then the individual operation is a no-op and an error will not be added to cis.tagging.tag_association.batch_result.error_messages. To invoke this operation, you need the read privilege on the object and the attach tag privilege on each tag. This operation was added in vSphere API 6.5.
attach_tag_to_multiple_objects	POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach-tag-to-multiple-objects	Attaches the given tag to the input objects. If a tag is already attached to the object, then the individual operation is a no-op and an error will not be added to cis.tagging.tag_association.batch_result.error_messages. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on each object. This operation was added in vSphere API 6.5.
detach	POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach	Detaches the tag from the given object. If the tag is already removed from the object, then this operation is a no-op and an error will not be thrown. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on the object.
detach_multiple_tags_from_object	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=detach-multiple-tags-from-object	Detaches the given tags from the input object. If a tag is already removed from the object, then the individual operation is a no-op and an error will not be added to cis.tagging.tag_association.batch_result.error_messages. To invoke this operation, you need the read privilege on the object and the attach tag privilege each tag. This operation was added in vSphere API 6.5.
detach_tag_from_multiple_objects	POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=detach-tag-from-multiple-objects	Detaches the given tag from the input objects. If a tag is already removed from the object, then the individual operation is a no-op and an error will not be added to cis.tagging.tag_association.batch_result.error_messages. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on each object. This operation was added in vSphere API 6.5.
list_attachable_tags	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attachable-tags	Fetches the array of attachable tags for the given object, omitting the tags that have already been attached. Criteria for attachability is calculated based on tagging cardinality (cis.tagging.category_model.cardinality) and associability (cis.tagging.category_model.associable_types) constructs. To invoke this operation, you need the read privilege on the input object. The array will only contain those tags for which you have read privileges.
list_attached_objects	POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=list-attached-objects	Fetches the array of attached objects for the given tag. To invoke this operation, you need the read privilege on the input tag. Only those objects for which you have the read privilege will be returned.
list_attached_objects_on_tags	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attached-objects-on-tags	Fetches the array of cis.tagging.tag_association.tag_to_objects describing the input tag identifiers and the objects they are attached to. To invoke this operation, you need the read privilege on each input tag. The cis.tagging.tag_association.tag_to_objects.object_ids will only contain those objects for which you have the read privilege. This operation was added in vSphere API 6.5.
list_attached_tags	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attached-tags	Fetches the array of tags attached to the given object. To invoke this operation, you need the read privilege on the input object. The array will only contain those tags for which you have the read privileges.
list_attached_tags_on_objects	POST https://{server}/rest/com/vmware/cis/tagging/tag-association?~action=list-attached-tags-on-objects	Fetches the array of cis.tagging.tag_association.object_to_tags describing the input object identifiers and the tags attached to each object. To invoke this operation, you need the read privilege on each input object. The cis.tagging.tag_association.object_to_tags.tag_ids will only contain those tags for which you have the read privilege. This operation was added in vSphere API 6.5.

tasks

The tasks service provides operations for managing the task related to a long running operation. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/cis/tasks/{task}?action=cancel	Cancel a running operation associated with the task. This is the best effort attempt. Operation may not be cancelled anymore once it reaches certain stage. This operation was added in vSphere API 6.7.1.
get	GET https://{server}/rest/cis/tasks/{task}	Returns information about a task. This operation was added in vSphere API 6.7.1.
list	GET https://{server}/rest/cis/tasks	Returns information about at most 1000 visible (subject to permission checks) tasks matching the cis.tasks.filter_spec. All tasks must be in the same provider. This operation was added in vSphere API 6.7.1.

content

The Content API provides structures and services for configuring global settings and permissions, and for managing libraries in the Content Library Service.

configuration

The configuration service provides operations to configure the global settings of the Content Library Service.

The configuration settings are used by the Content Library Service to control the behavior of various operations.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/content/configuration?~action=get	Retrieves the current configuration values.
update	PATCH https://{server}/rest/com/vmware/content/configuration	Updates the configuration. The update is incremental. Any field in the content.configuration_model structure that is unset will not be modified. Note that this update operation doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

content library

The Content Library API provides structures and services for defining and managing the library's items, subscription, publication, and storage.

library

The library service provides operations to manage and find content.library_model entities.

The library service provides support for generic functionality which can be applied equally to all types of libraries. The functionality provided by this service will not affect the properties specific to the type of library. See also content.local_library and content.subscribed_library.

Operation	HTTP request	Description
find	POST https://{server}/rest/com/vmware/content/library?~action=find	Returns a list of all the visible (as determined by authorization policy) libraries matching the requested content.library.find_spec.
get	GET https://{server}/rest/com/vmware/content/library/id:{library_id}	Returns a given content.library_model.
list	GET https://{server}/rest/com/vmware/content/library	Returns the identifiers of all libraries of any type in the Content Library.
update	PATCH https://{server}/rest/com/vmware/content/library/id:{library_id}	Updates the properties of a library. This is an incremental update to the library. Any field in the content.library_model structure that is unset will not be modified. This operation will only update the common properties for all library types. This will not, for example, update the content.library_model.publish_info of a local library, nor the content.library_model.subscription_info of a subscribed library. Specific properties are updated in update and update.

content library item

The Content Library Item API provides structures and services for managing files in a library item.

item

The item service provides operations for managing library items.

Operation	HTTP request	Description
copy	POST https://{server}/rest/com/vmware/content/library/item/id:{source_library_item_id}?~action=copy	Copies a library item. Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. A library item cannot be copied into a subscribed library.
create	POST https://{server}/rest/com/vmware/content/library/item	Creates a new library item. A new library item is created without any content. After creation, content can be added through the content.library.item.update_session and content.library.item.updatesession.file services. A library item cannot be created in a subscribed library.
delete	DELETE https://{server}/rest/com/vmware/content/library/item/id:{library_item_id}	Deletes a library item. This operation will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing. This operation cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.
find	POST https://{server}/rest/com/vmware/content/library/item?~action=find	Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested content.library.item.find_spec.
get	GET https://{server}/rest/com/vmware/content/library/item/id:{library_item_id}	Returns the content.library.item_model with the given identifier.
list	GET https://{server}/rest/com/vmware/content/library/item	Returns the identifiers of all items in the given library.
publish	POST https://{server}/rest/com/vmware/content/library/item/id:{library_item_id}?~action=publish	Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library. This operation was added in vSphere API 6.7.2.
update	PATCH https://{server}/rest/com/vmware/content/library/item/id:{library_item_id}	Updates the specified properties of a library item. This is an incremental update to the library item. Fields that are unset in the update specification are left unchanged. This operation cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.

changes

The changes service provides operations to get a history of the content changes made to a library item. This service was added in vSphere API 6.9.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/content/library/item/{library_item}/changes/{version}	Returns information about a library item change. This operation was added in vSphere API 6.9.1.
list	GET https://{server}/rest/content/library/item/{library_item}/changes	Returns commonly used information about the content changes made to a library item. This operation was added in vSphere API 6.9.1.

download session

The download_session service manipulates download sessions, which are used to download content from the Content Library Service.

A download session is an object that tracks the download of content (that is, downloading content from the Content Library Service) and acts as a lease to keep the download links available.

The content.library.item.downloadsession.file service provides access to the download links.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel	Cancels the download session. This operation will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.
create	POST https://{server}/rest/com/vmware/content/library/item/download-session	Creates a new download session.
delete	DELETE https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}	Deletes a download session. This removes the session and all information associated with it. Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.
fail	POST https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail	Terminates the download session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
get	GET https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}	Gets the download session with the specified identifier, including the most up-to-date status information for the session.
keep_alive	POST https://{server}/rest/com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive	Keeps a download session alive. This operation is allowed only if the session is in the ACTIVE state. If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of an active download session.
list	GET https://{server}/rest/com/vmware/content/library/item/download-session	Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.

content library item downloadsession

The Content Library Item Download Session API provides structures and services for downloading files in a session.

file

The file service provides operations for accessing files within a download session.

After a download session is created against a library item, the file service can be used to retrieve all downloadable content within the library item. Since the content may not be available immediately in a downloadable form on the server side, the client will have to prepare the file and wait for the file status to become PREPARED.

See content.library.item.download_session.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get	Retrieves file download information for a specific file.
list	GET https://{server}/rest/com/vmware/content/library/item/downloadsession/file	Lists the information of all the files in the library item associated with the download session.
prepare	POST https://{server}/rest/com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare	Requests a file to be prepared for download.

file

The file service can be used to query for information on the files within a library item. Files are objects which are added to a library item through the content.library.item.update_session and content.library.item.updatesession.file services.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/content/library/item/file/id:{library_item_id}?~action=get	Retrieves the information for a single file in a library item by its name.
list	GET https://{server}/rest/com/vmware/content/library/item/file	Lists all of the files that are stored within a given library item.

storage

storage is a resource that represents a specific instance of a file stored on a storage backing. Unlike content.library.item.file, which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in content.library.item.file, but will be represented multiple times (once for each storage backing) in storage. The storage service provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/content/library/item/storage/id:{library_item_id}?~action=get	Retrieves the storage information for a specific file in a library item.
list	GET https://{server}/rest/com/vmware/content/library/item/storage	Lists all storage items for a given library item.

tagging

A service for managing tags on library items. A library item can be tagged by one or multiple key/value pairs. These can be used to add extra information to the library item. Library item tags will be replicated through the VCSP protocol. If a library item belongs to a published library, the subscribed library item will have the same tags once a sync happens. Note that tags cannot be set on library items that are part of a subscribed library.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/content/library/item/tagging/id:{library_item_id}	Sets a key/value pair on a library item. If the key has been already set in the past, this method will override the old value with the new one.
delete	POST https://{server}/rest/com/vmware/content/library/item/tagging/id:{library_item_id}?~action=delete	Removes the key from the library item tags. If the library item doesn't have such a key this call will be a no-op.
get	POST https://{server}/rest/com/vmware/content/library/item/tagging/id:{library_item_id}?~action=get	Gets the value of the key associated with the library item. If no key is defined this method will return null.
list	GET https://{server}/rest/com/vmware/content/library/item/tagging	Lists all tags associated with the library item. If no tag is found, the method will return an empty list.

update session

The update_session service manipulates sessions that are used to upload content into the Content Library Service, and/or to remove files from a library item.

An update session is a resource which tracks changes to content. An update session is created with a set of files that are intended to be uploaded to a specific content.library.item_model, or removed from an item. The session object can be used to track the uploads and inspect the changes that are being made to the item by that upload. It can also serve as a channel to check on the result of the upload, and status messages such as errors and warnings for the upload.

Modifications are not visible to other clients unless the session is completed and all necessary files have been received.

The management of the files within the session is done through the content.library.item.updatesession.file service.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=cancel	Cancels the update session and sets its state to CANCELED. This operation will free up any temporary resources currently associated with the session. This operation is not allowed if the session has been already completed. Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.
complete	POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=complete	Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. This operation requires the session to be in the ACTIVE state. Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the validate operation. Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
create	POST https://{server}/rest/com/vmware/content/library/item/update-session	Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. Content Library Service allows only one single update session to be active for a specific library item.
delete	DELETE https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}	Deletes an update session. This removes the session and all information associated with it. Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item. Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.
fail	POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail	Terminates the update session with a client specified error message. This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
get	GET https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}	Gets the update session with the specified identifier, including the most up-to-date status information for the session.
keep_alive	POST https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}?~action=keep-alive	Keeps an update session alive. If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this operation enables a client to specifically extend the lifetime of the update session.
list	GET https://{server}/rest/com/vmware/content/library/item/update-session	Lists the identifiers of the update session created by the calling user. Optionally may filter by library item.
update	PATCH https://{server}/rest/com/vmware/content/library/item/update-session/id:{update_session_id}	Updates the properties of an update session. This is an incremental update to the update session. Any field in the content.library.item.update_session_model structure that is unset will not be modified. This operation will only update the property content.library.item.update_session_model.warning_behavior of the update session. This will not, for example, update the content.library.item.update_session_model.library_item_id or content.library.item.update_session_model.state of an update session. This operation requires the session to be in the ACTIVE state. . This operation was added in vSphere API 6.8.

content library item updatesession

The Content Library Item Update Session API provides structures and services for updating files in a session.

file

The file service provides operations for accessing files within an update session.

After an update session is created against a library item, the file service can be used to make changes to the underlying library item metadata as well as the content of the files. The following changes can be made:

deleting an existing file within the library item. This deletes both the metadata and the content.
updating an existing file with new content.
adding a new file to the library item.

The above changes are not applied or visible until the session is completed. See content.library.item.update_session.

Operation	HTTP request	Description
add	POST https://{server}/rest/com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=add	Requests file content to be changed (either created, or updated). Depending on the source type of the file, this operation will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this operation will be used to update the content of the existing file. When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.
get	POST https://{server}/rest/com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=get	Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
list	GET https://{server}/rest/com/vmware/content/library/item/updatesession/file	Lists all files in the library item associated with the update session.
probe	POST https://{server}/rest/com/vmware/content/library/item/updatesession/file?~action=probe	Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove	POST https://{server}/rest/com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=remove	Requests a file to be removed. The file will only be effectively removed when the update session is completed.
validate	POST https://{server}/rest/com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=validate	Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this operation will return its name in the content.library.item.updatesession.file.validation_result.missing_files set. The user can add the missing files and try re-validating. For other type of errors, content.library.item.updatesession.file.validation_result.invalid_files will contain the list of invalid files.

item path

The item_path service provides operations for managing library items.

Operation	HTTP request	Description
get_by_datastore_path	POST https://{server}/rest/com/vmware/content/library/item-path?~action=get-by-datastore-path	Returns the content.library.item_model for an item that contains the file specified by the given datastore path.

subscribed item

The subscribed_item service manages the unique features of library items that are members of a subscribed library.

Operation HTTP request Description

evict

POST https://{server}/rest/com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=evict

Evicts the cached content of a library item in a subscribed library.

This operation allows the cached content of a library item to be removed to free up storage capacity. This operation will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set content.library.item_model.cached to false.

sync

POST https://{server}/rest/com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=sync

Forces the synchronization of an individual library item in a subscribed library.

Synchronizing an individual item will update that item's metadata from the remote source. If the source library item on the remote library has been deleted, this operation will delete the library item from the subscribed library as well.

The default behavior of the synchronization is determined by the content.library.subscription_info of the library which owns the library item.

If content.library.subscription_info.on_demand is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the force_sync_content parameter.
If content.library.subscription_info.on_demand is false, then this call will always synchronize the file content. The force_sync_content parameter is ignored when the subscription is not on-demand.

When the file content has been synchronized, the content.library.item_model.cached field will be true.

This operation will return immediately and create an asynchronous task to perform the synchronization.

subscriptions

The subscriptions service provides operations for managing the subscription information of the subscribers of a published library. This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/content/library/subscriptions/id:{library}	Creates a subscription of the published library. This operation was added in vSphere API 6.7.2.
delete	POST https://{server}/rest/com/vmware/content/library/subscriptions/id:{library}?~action=delete	Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. This operation was added in vSphere API 6.7.2.
get	POST https://{server}/rest/com/vmware/content/library/subscriptions/id:{library}?~action=get	Returns information about the specified subscription of the published library. This operation was added in vSphere API 6.7.2.
list	GET https://{server}/rest/com/vmware/content/library/subscriptions	Lists the subscriptions of the published library. This operation was added in vSphere API 6.7.2.
update	PATCH https://{server}/rest/com/vmware/content/library/subscriptions/id:{library}	Updates the specified subscription of the published library. This is an incremental update to the subscription. Except for the content.library.subscriptions.update_spec_placement structure, fields that are unset in the update specification will be left unchanged. If `spec#subscribedLibraryPlacement` is specified, all fields of the current subscribed library placement will be replaced by this placement. . This operation was added in vSphere API 6.7.2.

local library

The local_library service manages local libraries.

The local_library service provides support for creating and maintaining local library instances. A local library may also use the content.library service to manage general library functionality.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/content/local-library	Creates a new local library.
delete	DELETE https://{server}/rest/com/vmware/content/local-library/id:{library_id}	Deletes the specified local library. Deleting a local library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.
get	GET https://{server}/rest/com/vmware/content/local-library/id:{library_id}	Returns a given local library.
list	GET https://{server}/rest/com/vmware/content/local-library	Returns the identifiers of all local libraries in the Content Library.
publish	POST https://{server}/rest/com/vmware/content/local-library/id:{library_id}?~action=publish	Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions. This operation was added in vSphere API 6.7.2.
update	PATCH https://{server}/rest/com/vmware/content/local-library/id:{library_id}	Updates the properties of a local library. This is an incremental update to the local library. Fields that are unset in the update specification will be left unchanged.

subscribed library

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/content/subscribed-library	Creates a new subscribed library. Once created, the subscribed library will be empty. If the content.library_model.subscription_info property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.
delete	DELETE https://{server}/rest/com/vmware/content/subscribed-library/id:{library_id}	Deletes the specified subscribed library. Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.
evict	POST https://{server}/rest/com/vmware/content/subscribed-library/id:{library_id}?~action=evict	Evicts the cached content of an on-demand subscribed library. This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand.
get	GET https://{server}/rest/com/vmware/content/subscribed-library/id:{library_id}	Returns a given subscribed library.
list	GET https://{server}/rest/com/vmware/content/subscribed-library	Returns the identifiers of all subscribed libraries in the Content Library.
probe	POST https://{server}/rest/com/vmware/content/subscribed-library?~action=probe	Probes remote library subscription information, including URL, SSL certificate and password. The resulting content.subscribed_library.probe_result structure describes whether or not the subscription configuration is successful.
sync	POST https://{server}/rest/com/vmware/content/subscribed-library/id:{library_id}?~action=sync	Forces the synchronization of the subscribed library. Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The content.library.subscription_info.on_demand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect.
update	PATCH https://{server}/rest/com/vmware/content/subscribed-library/id:{library_id}	Updates the properties of a subscribed library. This is an incremental update to the subscribed library. Fields that are unset in the update specification will be left unchanged.

type

The type service exposes the content.library.item_model types that this Content Library Service supports.

A library item has an optional type which can be specified with the content.library.item_model.type field. For items with a type that is supported by a plugin, the Content Library Service may understand the files which are part of the library item and can produce metadata for the item.

In other cases, uploads may require a process in which one upload implies subsequent uploads. For example, an Open Virtualization Format (OVF) package is composed of an OVF descriptor file and the associated virtual disk files. Uploading an OVF descriptor can enable the Content Library Service to understand that the complete OVF package requires additional disk files, and it can set up the transfers for the disks automatically by adding the file entries for the disks when the OVF descriptor is uploaded.

When a type is not supported by a plugin, or the type is not specified, the Content Library Service can handle a library item in a default way, without adding metadata to the item or guiding the upload process.

Operation	HTTP request	Description
list	GET https://{server}/rest/com/vmware/content/type	Returns a array of content.type.info instances which describe the type support plugins in this Content Library.

esx attestation

The esx.attestation API provides services to manage the vSphere Trust Authority Attestation Service.

esx attestation certificate

certificate

The certificate service provides operations to get or update the attestation report signing certificate.

The result of attestation is a signed report that verifies the attested host's authenticity. This service allows the report signing certificate to be read by anyone who needs to trust the signature.

Operation

HTTP request

Description

GET https://{server}/api/esx/attestation/certificate

Return the certificate.

Returns the certificate that is used to sign attestation reports.

PUT https://{server}/api/esx/attestation/certificate

Set the certificate.

Sets the certificate that is used to sign attestation reports. The existing certificate will be replaced by the one specified.

This is method is used after generating a CSR, and the specified certificate must match a pending CSR.

csr

The csr service provides operations to create a certificate signing request (CSR) for the attestation report signing certificate.

Operation

HTTP request

Description

POST https://{server}/api/esx/attestation/certificate/csr

Generate a CSR.

Generate a certificate signing request (CSR) for the attestation signing certificate.

Calling this operation repeatedly will result in a generating a new CSR each time and generating a new private key. An existing CSR, if it exists, will be discarded.

delete

DELETE https://{server}/api/esx/attestation/certificate/csr

Delete an existing CSR.

Discards the existing CSR. Completes successfully if no CSR is present.

GET https://{server}/api/esx/attestation/certificate/csr

Get the CSR.

Return the most recently generated CSR.

esx attestation os esx

The esx.attestation.os.esx API provides services to manage remote attestation OS configuration for ESX trust.

base images

The base_images service provides operations to manage trusted instances of ESX software.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/attestation/os/esx/base-images/{version}	Remove a trusted ESX base image.
get	GET https://{server}/api/esx/attestation/os/esx/base-images/{version}	Get the trusted ESX base version details.
import_from_imgdb	POST https://{server}/api/esx/attestation/os/esx/base-images	Import ESX metadata as a new trusted base image. Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host over HTTP using: https://[hostname]/boot_imgdb.tgz
list	GET https://{server}/api/esx/attestation/os/esx/base-images	Return a list of trusted ESX base images.

raw config

The raw_config service provides operations to get or put the attestation service persistent user configuration.

This service is most useful when either replicating existing configuration settings to a new host, or when applying a known desired configuration across several hosts in a cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/attestation/raw-config	Return the configuration information. Returns the attestation service persistent user configuration.
set	PUT https://{server}/api/esx/attestation/raw-config	Set the configuration. Overwrites all existing persistent user configuration with the specified configuration.

report

The report interface provides operations to get attestation reports.

Operation	HTTP request	Description
attest	POST https://{server}/api/esx/attestation/report	Request a report using remote attestation.

status

The status service provides operations to get the attestation service health status.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/attestation/status	Return the servie status. Returns the attestation service health status.

esx attestation tpm2

The esx.attestation.tpm2 API provides services to manage remote attestation configuration for TPM trust.

ca certificates

The ca_certificates service provides operations to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This service allows the CA certificate to be registered with the attestation service in order to validate TPM EK certificates when presented at attestation time.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/attestation/tpm2/ca-certificates	Add a new TPM CA certificate.
delete	DELETE https://{server}/api/esx/attestation/tpm2/ca-certificates/{name}	Remove a TPM CA certificate.
get	GET https://{server}/api/esx/attestation/tpm2/ca-certificates/{name}	Get the TPM CA certificate details.
list	GET https://{server}/api/esx/attestation/tpm2/ca-certificates	Return a list of configured TPM CA certificates.

endorsement keys

The endorsement_keys service provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK).

Operation	HTTP request	Description
create	POST https://{server}/api/esx/attestation/tpm2/endorsement-keys	Add a new TPM endorsement key.
delete	DELETE https://{server}/api/esx/attestation/tpm2/endorsement-keys/{name}	Remove a TPM endorsement key.
get	GET https://{server}/api/esx/attestation/tpm2/endorsement-keys/{name}	Get the TPM endorsement key details.
list	GET https://{server}/api/esx/attestation/tpm2/endorsement-keys	Return a list of configured TPM endorsement keys.

settings

The settings service provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/attestation/tpm2/settings	Return the TPM 2.0 protocol settings.
update	PATCH https://{server}/api/esx/attestation/tpm2/settings	Set the TPM 2.0 protocol settings.

esx authentication

The esx.authentication API provides services for managing ESX authentication and identity management.

client profiles

The client_profiles service provides operations to manage ESX authentication tokens claims. Subject matching is used to provide permission claims described by esx.authentication.client_profiles.access_grant list.

When multiple profiles match, union of the esx.authentication.client_profiles.access_grant elements is applied. When no profiles match, no permission claims are applied.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/authentication/client-profiles	Create a new client profile.
delete	DELETE https://{server}/api/esx/authentication/client-profiles/{profile}	Delete an existing client profile.
get	GET https://{server}/api/esx/authentication/client-profiles/{profile}	Get the details of a client profile.
list	GET https://{server}/api/esx/authentication/client-profiles	List the existing client profiles.
update	PATCH https://{server}/api/esx/authentication/client-profiles/{profile}	Update the access grants in an existing client profile.

token

ESXi Authentication service

This token service is providing tokens for accessing control plane services on the host.

It is reading the user's credentials from the call context and creates a signed API access token. The token can be presented as authentication to the other host APIs. API clients should treat the token as opaque value. Future ESXi releases may utilize different token technology. There are no backwards compatibility guarantees about the token format and technology. The current implementation uses JSON Web Tokens (JWT) as per RFC 7519.

Operation

HTTP request

Description

POST https://{server}/api/esx/authentication/token

Creates API access token using API user credentials in the call context. The returned token can be used to authenticate access to other host APIs

The ESXi Authentication service accepts the following types of user credentials:

Username and password
vCenter SAML tokens

esx authentication trust

security token issuers

The security_token_issuers service provides operations to manage ESX trust to Security Token Issuers. For example WS-Trust SSO STS or OAuth Identity Providers, that issue authentication tokens.

Each record contains a list of X.509 certificate chains that apply for a unique token issuer. The certificates are used to verify security tokens from this issuer.

Symmetric signing keys are not suported.

If a security token is received with issuer that has no configured security_token_issuers instance, the authentication fails and an error is returned.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/authentication/trust/security-token-issuers	Create a new trust to a Security Token Issuer.
delete	DELETE https://{server}/api/esx/authentication/trust/security-token-issuers/{issuerAlias}	Delete an existing security token issuer trust.
get	GET https://{server}/api/esx/authentication/trust/security-token-issuers/{issuerAlias}	Get the details of a security token issuer.
list	GET https://{server}/api/esx/authentication/trust/security-token-issuers	List the available security token issuer trusts.
update	PATCH https://{server}/api/esx/authentication/trust/security-token-issuers/{issuerAlias}	Update an existing security token issuer trust.

verification

ESX Authentication service

This verification service is providing a verification tool for tokens issued by Esx Authentication service.

Operation	HTTP request	Description
verify	GET https://{server}/api/esx/authentication/verify	Verifies the provided token

esx gdp

The esx.gdp API provides services to manage and use the Guest Data Publisher Service.

guest data

The guest_data service provides operations to get guest data published from a set of virtual machines on a set of topics. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	POST https://{server}/api/esx/gdp/guest-data	Return a stream of published guest data. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx hcl

The esx.hcl API provides services to query the hardware compatibility for an ESXi or a cluster.

compatibility data

This service provides operations to update the local compatibility data residing on the vCenter Appliance or to get information about the said data. The information in the data is generic VMware compatibility information for servers and devices.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/hcl/compatibility-data/status	Provides information about the compatibility data located on the vCenter Appliance.
update-task	POST https://{server}/api/esx/hcl/compatibility-data	Replaces the local compatibility data with the latest version found from VMware official source.

esx hcl hosts

compatibility releases

This service provides operations to list available releases for generating compatibility report for a specific ESXi host.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/hcl/hosts/{host}/compatibility-releases	Lists the locally available ESXi releases for a given host that can be used to generate a compatiblity report. Each host has its own list of supported releases depending on its current release.

compatibility report

This service provides operations to generate hardware compatibility report for a given ESXi host against a specific ESXi release.

Operation	HTTP request	Description
create-task	POST https://{server}/api/esx/hcl/hosts/{host}/compatibility-report	Generates hardware compatibility report for a specified ESXi host against specific ESXi release. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
get	GET https://{server}/api/esx/hcl/hosts/{host}/compatibility-report	Returns the last generated hardware compatibility report for the given host.

reports

This service provides operations to download information generated from the hardware compatibility feature residing on the vCenter Appliance.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/hcl/reports/{report}	Returns the location esx.hcl.reports.location information for downloading a compatibility report.

esx health clusters

esx health clusters perspectives planned maintenance

status

The service provides methods for querying if the cluster can safely be put into maintenance mode.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/clusters/{cluster}/perspectives/planned-maintenance/status	Get the current health status of a cluster for planned maintenance.

esx health clusters perspectives ready for apply

status

The service provides methods for querying if the cluster is ready to be applied a new desired configuration.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/clusters/{cluster}/perspectives/ready-for-apply/status	Check if the cluster is ready to be applied a new desired configuration.

status

The service provides methods for querying if the cluster can safely be put into a target state. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/clusters/{cluster}/status	Check the cluster status against the given spec. This operation was added in vSphere API 7.0.1.0.

esx health hosts

esx health hosts perspectives before exit maintenance mode

status

The service provides methods for querying if the host is ready to exit maintenance mode.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/hosts/{host}/perspectives/before-exit-maintenance-mode/status	Check if the given host is ready to exit maintenance mode.

esx health hosts perspectives initialization

status

The service provides methods for querying if the host is ready to receive workloads.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/hosts/{host}/perspectives/initialization/status	Check if the given host is ready to accept workloads.

esx health hosts perspectives planned maintenance

status

The service provides methods for querying if the host can safely be put into maintenance mode.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/hosts/{host}/perspectives/planned-maintenance/status	Check if the given host can safely enter maintenance mode.

status

The service provides methods for querying if the host can safely be put into a target state. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
check	POST https://{server}/api/esx/health/hosts/{host}/status	Check the host status against the given spec. This operation was added in vSphere API 7.0.1.0.

esx health perspectives

esx health perspectives checks

disabled

This service provides operations for disabling checks from perspectives.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/health/perspectives/{perspective}/checks/disabled	Get the set of checks that are disabled for the given perspective.
set	POST https://{server}/api/esx/health/perspectives/{perspective}/checks/disabled	Disable the checks with the given IDs for all health status queries. No validation is done on whether the given IDs are valid.

credentials

This service provides operations for configuring the credentials that EHP will use when communicating with other services. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/health/perspectives/credentials	Creates server credentials that will be used by the EHP service to perform operations. The credentials are bound to the lifetime of the session of the user which called this method. This operation was added in vSphere API 7.0.1.0.

esx hosts software

The esx.hosts.software API provides services to get information about current software on ESX.

installed components

The installed_components service provides operations to get installed list of components.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/hosts/{host}/software/installed-components	Returns the installed components on the host.

esx kms

The esx.kms API provides services to manage the vSphere Trust Authority Key Provider Service.

key operation

The key_operation service provides operations to encrypt and decrypt data using a key that is provisioned for a Key Provider.

Operation	HTTP request	Description
decrypt	POST https://{server}/rest/esx/kms/key-operation?action=decrypt	Decrypt ciphertext.
encrypt	POST https://{server}/rest/esx/kms/key-operation?action=encrypt	Encrypt plaintext.
generate_key	POST https://{server}/rest/esx/kms/key-operation?action=generate-key	Generate a new data encryption key.

esx kms providers

The esx.kms.providers API provides services to manage Key Providers.

providers

The providers service provides operations to create, update and delete Key Providers.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/kms/providers	Add a new Key Provider.
delete	DELETE https://{server}/api/esx/kms/providers/{provider}	Remove a Key Provider.
get	GET https://{server}/api/esx/kms/providers/{provider}	Return information about a Key Provider.
list	GET https://{server}/api/esx/kms/providers	Return a list of Key Providers.
update	PATCH https://{server}/api/esx/kms/providers/{provider}	Update an existing Key Provider.

esx kms providers client certificate

The esx.kms.providers.client_certificate API provides services to manage client certificates.

client certificate

The client_certificate service provides operations to add and retrieve client certificate.

Operation

HTTP request

Description

POST https://{server}/api/esx/kms/providers/{provider}/client-certificate

Generate a new self signed client certificate. Existing client certificate is overwritten. The key management server will use this certificate to validate the client connection.

GET https://{server}/api/esx/kms/providers/{provider}/client-certificate

Return the existing client certificate.

PUT https://{server}/api/esx/kms/providers/{provider}/client-certificate

Set the client certificate.

The key management server will use this certificate to validate the client connection. If a client certificate already exists, it will be replaced.

An optional private key can be specified if the certificate has already been provisioned.

csr

The csr service provides operations to create a certificate signing request(CSR).

Operation

HTTP request

Description

POST https://{server}/api/esx/kms/providers/{provider}/client-certificate/csr

Generate a certificate signing request (CSR) for the client certificate. This overwrites any existing CSR.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

Calling the API repeatedly will result in a generating a new CSR each time.

GET https://{server}/api/esx/kms/providers/{provider}/client-certificate/csr

Get existing certificate signing request (CSR) for the client certificate and optionally the private key.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

PUT https://{server}/api/esx/kms/providers/{provider}/client-certificate/csr

Set the certificate signing request (CSR) and private key.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

credential

The credential service provides operations to add a credential for key management server(s).

Operation	HTTP request	Description
get	GET https://{server}/api/esx/kms/providers/{provider}/credential	Get key server credential. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/kms/providers/{provider}/credential	Set key server credential.

esx kms providers server certificates

The esx.kms.providers.server_certificates API provides services to manage server certificates.

server certificates

The server_certificates service provides operations to add and retrieve trusted server certificates.

A provider must be configured with a trusted server certificate before performing any key operations.

Operation

HTTP request

Description

GET https://{server}/api/esx/kms/providers/{provider}/server-certificates

Return trusted server certificates.

PUT https://{server}/api/esx/kms/providers/{provider}/server-certificates

Add trusted server certificate(s).

The client will use these certificates to validate the server connection. The existing list of trusted certificates will be overwritten.

The client will not trust the server connection until a server certificate has been set.

remote

The remote service provides operations to retrieve remote key server certificate.

Operation

HTTP request

Description

GET https://{server}/api/esx/kms/providers/{provider}/server-certificates/remote

Return the remote server certificates.

Contacts the configured key servers and attempts to retrieve their certificates. These certificates might not yet be trusted.

If the returned certificates are to be considered trustworthy, then it must be added to the list of trusted server certificates by adding to the certificates returned by get and invoking set with the updated array of certificates.

status

The status service provides status of a Key Provider.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/kms/providers/{provider}/status	Return the status of a provider.

raw config

The raw_config service provides operations to get or put the key management service persistent user configuration.

This service is most useful when either replicating existing configuration settings to a new host, or when applying a known desired configuration across several hosts in a cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/kms/raw-config	Return the configuration information. Returns the key management service persistent user configuration.
set	PUT https://{server}/api/esx/kms/raw-config	Set the configuration. Overwrites all existing persistent user configuration with the specified configuration.

status

The status service provides operations to get the key management service health status.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/kms/status	Returns the key management service health status.

esx settings

The esx.settings API provides services to manage ESX settings.

esx settings clusters

The esx.settings.clusters API provides services to manage desired state configuration and software for a cluster of ESX hosts.

esx settings clusters configuration reports

last apply result

The last_apply_result service provides operations to get the most recent available result of applying the configuration to all hosts within a cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/configuration/reports/last-apply-result	Returns the most recent available result of applying the configuration document to all hosts within the cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

depot overrides

The depot_overrides service provides operations to manage software depots overriden for a given cluster. In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX clusters can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This service allows setting cluster level overrides for depots. If any depots are provided for a cluster, then vCenter level depots are not used for that cluster's remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations.

Operation	HTTP request	Description
add	POST https://{server}/api/esx/settings/clusters/{cluster}/depot-overrides	Adds a new depot override to the list of currently configured depot overrides for a given cluster.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/depot-overrides	Returns the information about currently configured depot overrides for a given cluster.
remove	POST https://{server}/api/esx/settings/clusters/{cluster}/depot-overrides	Removes a depot override from the list of currently configured depot overrides for a given cluster.

esx settings clusters enablement

The esx.settings.clusters.enablement API provides services to manage enablement of the feature that allows to collectively manage hosts within the cluster with a single software specification.

software

The software service provides operations to control whether the cluster is managed with a single software specification.

Operation	HTTP request	Description
check-task	POST https://{server}/api/esx/settings/clusters/{cluster}/enablement/software	Checks the possibility to manage the cluster with a single software specification.
enable-task	PUT https://{server}/api/esx/settings/clusters/{cluster}/enablement/software	Enables the feature which manages the cluster with a single software specification.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/enablement/software	Returns whether the given cluster is managed with a single software specification.

esx settings clusters policies

The esx.settings.clusters.policies API provides services to manage policies that affect management of desired state configuration and software for an ESXi cluster. Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential

esx settings clusters policies apply

The esx.settings.clusters.policies.apply API provides services to manage policies that affect application of desired state configuration and software for an ESXi cluster. Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/policies/apply	Returns the configured policy that has been set for the cluster.
set	PUT https://{server}/api/esx/settings/clusters/{cluster}/policies/apply	This API will set the configured policy specification for the cluster.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/policies/apply/effective	Returns the effective apply policy based on system defaults and what has been configured for the cluster.

reset info

The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.clusters.policies.apply.configured_policy_spec are reset.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/policies/apply/reset-info	Returns the information describing the outcome when configured policies are reset.

esx settings clusters software

The esx.settings.clusters.software API provides services to manage desired state software for ESX cluster.

software

The software service provides operations to manage desired software specification of an ESX cluster.

Operation	HTTP request	Description
apply-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software	Applies the desired software document associated with the given cluster to hosts within the cluster. If `commit` field is set, it implies the minimum commit that the apply operation should use, however if subsequent commits have been made to the desired state document the apply operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
check-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software	Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If `commit` field is set it implies the minimum commit that the check operation should use, however if subsequent commits have been made to the desired state document the check operation will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
export	POST https://{server}/api/esx/settings/clusters/{cluster}/software	Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software	Returns the complete desired software specification.
scan-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software	Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

add on

The add_on service provides operations to manage desired OEM add-on specification for a given cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/add-on	Returns the desired OEM add-on specification for a given cluster.

base image

The base_image service provides operations to manage desired ESX base image.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/base-image	Returns the desired base-image specification set for given cluster

commits

The commits service provides operations to manage committed changes to desired software document.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/commits/{commit}	Returns the information about a specific commit.

compliance

The compliance service provides operations to get the last software compliance result for an ESX cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/compliance	Returns the compliance state for the cluster

components

The components service provides operations to get desired component specification for an ESX cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/components/{component}	Returns the component version for the given component in the desired software specification.
list	GET https://{server}/api/esx/settings/clusters/{cluster}/software/components	Returns a list of components in the desired software specification.

esx settings clusters software drafts software

The esx.settings.clusters.software.drafts.software API provides services to manage draft of the software documents for ESX cluster.

add on

The add_on service provides operations to manage the OEM add-on specification in a software draft.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on	Deletes the desired OEM add-on specification in the software draft.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on	Returns the OEM add-on specification in a software draft.
set	PUT https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on	Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.

base image

The base_image service provides operations to manage the base-image specification in a software draft.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image	Returns the base-image specification in a software draft.
set	PUT https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image	Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists.

components

The components service provides operations to manage component specification in a software draft.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}	Deletes the given component from the software draft.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}	Returns the component version for the given component in the software draft.
list	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components	Returns the components that comprise the software draft.
set	PUT https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}	Set the component version for a given component in the software draft. This will overwrite any existing version for the given component.
update	PATCH https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components	Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation.

effective components

The effective_components service provides operations to manage effective list of components.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/effective-components	Returns the components that comprise the desired software state of the cluster.

hardware support

The hardware_support service provides operations to manage a cluster's Hardware Support Package (HSP) configuration in working copy documents.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support	Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support	Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
set	PUT https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support	Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

drafts internal

The drafts service provides internal operations to manage working copy of software documents.

Operation	HTTP request	Description
delete_and_create	POST https://{server}/api/esx/settings/clusters/{cluster}/software/drafts-internal	Creates a new software draft from the desired document. If there is a draft already associated with the user, that draft will be deleted before new draft is created. When the draft is committed successfully, it will be deleted.
delete_and_import	POST https://{server}/api/esx/settings/clusters/{cluster}/software/drafts-internal	Imports the desired software specification as a new draft. If there is a draft already associated with the user for this cluster, that draft will be deleted before new draft is created.

effective components

The effective_components service provides operations to get effective list of components.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/clusters/{cluster}/software/effective-components	Returns the effective components for the cluster.

ha internal

The ha_internal service provides operations to manage desired software state for HA solution on an ESX cluster.

Operation	HTTP request	Description
apply-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/ha-internal	Applies the HA Component specified in the desired specification document to the hosts in the cluster.

hardware support

The hardware_support service provides operations to manage a cluster's Hardware Support Package (HSP) configuration.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/hardware-support	Returns a given cluster's Hardware Support Package (HSP) configuration.

recommendations

The recommendations service provides operations to manage the generation and retrieval of recommended image specs.

Operation	HTTP request	Description
generate-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/recommendations	Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/recommendations	Returns Information about the most recent recommendation generation result.

esx settings clusters software reports

The esx.settings.clusters.software.reports API provides services to manage reports pertaining to the desired state software for a cluster of ESXi hosts.

apply impact

The apply_impact service provides operations to get the impact of an apply operation on a cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/apply-impact	Returns a summary of how hosts within the cluster will be impacted during an apply operation. The impact is generated from the compliance information obtained from get

esx settings clusters software reports hardware compatibility

The esx.settings.clusters.software.reports.hardware_compatibility API provides services to manage reports pertaining to the desired state software for a cluster of ESXi hosts.

hardware compatibility

The hardware_compatibility service provides operations to manage HCL Validation of a software specification of an ESX cluster.

Operation	HTTP request	Description
check-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility	Initiates a Cluster HCL Validation check for a given cluster. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility	Returns the hcl validation check summary.

details

The ComplianceStatus structure contains the possible different status of compliance with respect to target version.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details	Returns the hcl validation check detailed results.

last apply result

The last_apply_result service provides operations to get the most recent available result of applying the desired software document to all hosts within a cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/last-apply-result	Returns the most recent available result of applying the desired software document to all hosts within the cluster.

last check result

The last_check_result service provides operations to get the most recent available result of the checks that have been run on a cluster before the application of the desired software document to all hosts within the cluster.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/reports/last-check-result	Returns the most recent available result of checks run on the cluster before the application of the desired software document to all hosts within the cluster.

esx settings clusters software solutions

The esx.settings.clusters.software.solutions API provides services to manage desired state software for ESXi cluster solutions.

solutions

The solutions service provides operations to manage desired software solution specifications for an ESX cluster.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}	Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}	Returns components registered for the given solution in the desired software specification.
list	GET https://{server}/api/esx/settings/clusters/{cluster}/software/solutions	Returns all solutions in the desired software specification.
set-task	PUT https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}	Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

esx settings clusters software solutions nsx

The esx.settings.clusters.software.solutions.nsx API provides services to manage desired state software for NSX solution on ESXi cluster.

nsx internal

The nsx_internal interface service provides operations to manage desired software state for the NSX solution on an ESX cluster. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
apply-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/nsx	Applies the NSX Component specified in the desired specification document to the hosts in the cluster. This operation was added in vSphere API 7.0.1.0.

solutions internal

The solutions_internal service provides operations to manage a solution desired software specifications for an ESX cluster. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
apply-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/solutions-internal	Apply the solution's components specified in the desired specification document to the hosts in the cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove-task	POST https://{server}/api/esx/settings/clusters/{cluster}/software/solutions-internal	Remove solution's software components associated with the given cluster from hosts within the cluster. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. This operation was added in vSphere API 7.0.1.0.

solutions being applied internal

The solutions_being_applied_internal service provides operations to manage software solution specification that is being considered to be applied.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/clusters/{cluster}/software/solutions-being-applied-internal/{solution}	Returns the components registered for the given solution in the software specification that is being considered to be applied.

esx settings defaults clusters policies

esx settings defaults clusters policies apply

The esx.settings.defaults.clusters.policies.apply API provides services to manage policies that affect application of desired state configuration and software for ESXi clusters. Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019-2020 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi clusters.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/clusters/policies/apply	Returns the configured policy that has been set.
set	PUT https://{server}/api/esx/settings/defaults/clusters/policies/apply	This API will set the configured policy specification.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi clusters.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/clusters/policies/apply/effective	Returns the effective apply policy based on system defaults and what has been configured.

reset info

The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.defaults.clusters.policies.apply.configured_policy_spec are reset.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/clusters/policies/apply/reset-info	Returns the information describing the outcome when configured policies are reset.

esx settings defaults hosts policies

The esx.settings.defaults.hosts.policies API provides services to manage the default policies that affect management of desired state configuration and software for ESXi hosts. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

esx settings defaults hosts policies apply

The esx.settings.defaults.hosts.policies.apply API provides services to manage the policies that affect application of desired state configuration and software for ESXi hosts. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to ESXi hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/hosts/policies/apply	Returns the configured policy that has been set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/settings/defaults/hosts/policies/apply	This API will set the configured policy. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to ESXi hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/hosts/policies/apply/effective	Returns the effective policy based on system defaults and what has been configured. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

reset info

The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.defaults.hosts.policies.apply.configured_policy_spec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/defaults/hosts/policies/apply/reset-info	Returns the information describing the outcome when configured policies are reset. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx settings depot content

The esx.settings.depot_content API provides services to retrieve contents from the depot.

esx settings depot content add ons

The esx.settings.depot_content.add_ons API provides services to retrieve OEM specific add-on versions from the depot.

add ons

The add_ons service provides operations to get OEM add-ons from the sync'ed and imported depots.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/depot-content/add-ons	Returns a list of currently available OEM add-ons in the depot.

versions

The versions service provides operations to get OEM add-on versions from the sync'ed and imported depots.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/depot-content/add-ons/{name}/versions/{version}	Returns information about a given OEM add-on version in the depot.

esx settings depot content base images

The esx.settings.depot_content.base_images API provides services to retrieve base_images from the depot.

base images

The base_images service provides operations to get base-images from the sync'ed and imported depots.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/depot-content/base-images	Returns a list of currently available base-images in the depot.

versions

The versions service provides operations to get versions of base-images from the sync'ed and imported depots.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/depot-content/base-images/versions/{version}	Returns information about a given base-image version in the depot.

esx settings depot content components

The esx.settings.depot_content.components API provides services to retrieve component versions from the depot.

components

The components service provides operations to get Components from the sync'ed and imported depots.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/depot-content/components	Returns a list of currently available components in the depot.

versions

The versions service provides operations to get component versions from the sync'ed and imported depots.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/depot-content/components/{name}/versions/{version}	Returns information about a given component version in the depot.

esx settings depot content hardware support

esx settings depot content hardware support manifests

manifests

The manifests service provides operations to get Hardware Support Package (HSP) manifests from the sync'ed and imported depots.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/depot-content/hardware-support/manifests	Returns a list of currently available Hardware Support Package (HSP) manifests in the depot.

versions

The versions service provides operations to get Hardware Support Package (HSP) manifest versions from the sync'ed and imported depots.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/depot-content/hardware-support/manifests/{manifest}/versions/{version}	Returns a complete description of a Hardware Support Package (HSP) manifest in the depot (including component lists)

esx settings depots

The esx.settings.depots API provides services to manage VUM compatible ESX Depots.

depots

The depots service provides operations to manage Software Depots used during ESX lifecycle management.

Operation	HTTP request	Description
sync-task	POST https://{server}/api/esx/settings/depots	Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

offline

The offline service provides operations to manage Offline Software Depots used during ESX lifecycle management.

Operation	HTTP request	Description
create-task	POST https://{server}/api/esx/settings/depots/offline	Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
delete	DELETE https://{server}/api/esx/settings/depots/offline/{depot}	Removes a depot from the list of imported offline software depots.
get	GET https://{server}/api/esx/settings/depots/offline/{depot}	Gets the information about an imported offline software depot.
list	GET https://{server}/api/esx/settings/depots/offline	Returns currently imported offline software depots.

online

The online service provides operations to manage Online Software Depots used during ESX lifecycle management.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/settings/depots/online	Adds a new online software depot to the list of currently configured online software depots.
delete	DELETE https://{server}/api/esx/settings/depots/online/{depot}	Removes a depot from the list of currently configured online software depots. It will not remove the downloaded metadata and payloads from that depot.
get	GET https://{server}/api/esx/settings/depots/online/{depot}	Gets the information about a currently configured online software depot.
list	GET https://{server}/api/esx/settings/depots/online	Returns a list of currently configured online software depots.
update	PATCH https://{server}/api/esx/settings/depots/online/{depot}	Updates the configuration of a currently configured online software depot.

sync schedule

The sync_schedule service provides operations to manage Schedule of Online Software Depot sync.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/depots/sync-schedule	Returns the currently configured software depot sync schedule.
set	PUT https://{server}/api/esx/settings/depots/sync-schedule	Sets the software depot sync schedule.

umds

The umds service provides operations to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management. This is the depot downloaded using UMDS.

If a UMDS depot is specified then online depots are ignored and data is downloaded only from the UMDS depot.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/depots/umds	Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.
get	GET https://{server}/api/esx/settings/depots/umds	Gets the information about a currently configured UMDS software depot.
set	PUT https://{server}/api/esx/settings/depots/umds	Sets or overwrites information about an UMDS software depot.
update	PATCH https://{server}/api/esx/settings/depots/umds	Updates the configuration of a currently configured UMDS software depot.

esx settings hardware support

esx settings hardware support managers

managers

The managers service provides operations to list Hardware Support Manager (HSM) for a given vCenter.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/hardware-support/managers	Returns the list of registered Hardware Support Managers (HSMs) in the system.

esx settings hardware support managers packages

packages

The packages service provides operations to manage a host's Hardware Support Package (HSP) configuration.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/hardware-support/managers/{manager}/packages	Returns the list of available Hardware Support Packages (HSPs) for a particular host, as specified by its Hardware Support Manager (HSM)

versions

The versions service provides operations to inspect a Hardware Support Package (HSP)'s detailed information.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hardware-support/managers/{manager}/packages/{pkg}/versions/{version}	Returns the detailed information for a specific version of an available Hardware Support Packages (HSPs) as specified by the Hardware Support Manager (HSM)

esx settings hosts

The esx.settings.hosts API provides services to manage desired state configuration and software for a standalone ESX host.

esx settings hosts enablement

The esx.settings.hosts.enablement API provides services to manage standalone host with a single software specification.

software

The software service provides operations to control whether the host is managed with a single software specification. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check-task	POST https://{server}/api/esx/settings/hosts/{host}/enablement/software	Checks the possibility to manage the host with a single software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
enable-task	PUT https://{server}/api/esx/settings/hosts/{host}/enablement/software	Enables the feature which manages the host with a single software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/settings/hosts/{host}/enablement/software	Returns whether the given standalone host is managed with a single software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx settings hosts policies

The esx.settings.hosts.policies API provides services to manage the policies that affect management of desired state configuration and software for an ESXi host. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

esx settings hosts policies apply

The esx.settings.hosts.policies.apply API provides services to manage the policies that affect application of desired state configuration and software for an ESXi host. Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential Copyright 2019 VMware, Inc. All rights reserved. VMware Confidential

apply

The apply service provides operations to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/policies/apply	Returns the configured policy that has been set for the ESXi host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/settings/hosts/{host}/policies/apply	This API will set the configured policy for an ESXi host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

effective

The effective service provides operations to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/policies/apply/effective	Returns the effective policy based on system defaults and what has been configured for the ESXi host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

reset info

The reset_info service provides internal operations to identify the outcome when configured policies esx.settings.hosts.policies.apply.configured_policy_spec are reset. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/policies/apply/reset-info	Returns the information describing the outcome when configured policies are reset. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx settings hosts software

The esx.settings.hosts.software API provides services to manage desired software on a standalone host.

software

The software service provides operations to manage desired software specification of a standalone ESX host.

Operation	HTTP request	Description
scan-task	POST https://{server}/api/esx/settings/hosts/{host}/software	Scans the host against the host's desired state.. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

add on

The add_on service provides operations to manage desired OEM add-on specification for a given standalone host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/add-on	Returns the desired OEM add-on specification for a given host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

base image

The base_image service provides operations to manage desired ESX base image. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/base-image	Returns the desired base-image specification set for given host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

commits

The commits service provides operations to manage committed changes to desired software document. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/commits/{commit}	Returns the information about a specific commit. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

compliance

The compliance service provides operations to get compliance results for a standalone host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/compliance	Returns the compliance state for the host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

components

The components service provides operations to manage desired component specification for a standalone ESX host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/components/{component}	Returns the component version for the given component in the desired software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/settings/hosts/{host}/software/components	Returns a list of components in the desired software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx settings hosts software drafts software

The esx.settings.hosts.software.drafts.software API provides services to manage specifications in a software draft for an ESX host.

add on

The add_on service provides operations to manage the OEM add-on specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on	Deletes the desired OEM add-on specification in the software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on	Returns the OEM add-on specification in a software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on	Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

base image

The base_image service provides operations to manage the base-image specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image	Returns the base-image specification in a software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image	Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

components

The components service provides operations to manage component specification in a software draft. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}	Deletes the given component from the software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}	Returns the component version for the given component in the software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components	Returns the components that comprise the software draft. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}	Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components	Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

effective components

The effective_components service provides operations to manage effective list of components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/effective-components	Returns the components that comprise the desired software state of the host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

hardware support

The hardware_support service provides operations to manage a stand-alone host's Hardware Support Package (HSP) configuration in working copy documents.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/hardware-support	Deletes a given host's working copy document Hardware Support Package configuration.
get	GET https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/hardware-support	Returns a given host's working copy document Hardware Support Package (HSP) configuration.
set	PUT https://{server}/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/hardware-support	Replaces a given host's working copy document Hardware Support Package (HSP) configured.

drafts internal

The drafts service provides internal operations to manage working copy of software documents. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete_and_create	POST https://{server}/api/esx/settings/hosts/{host}/software/drafts-internal	Creates a new software draft from the desired document. If there is a draft already associated with the user, that draft will be deleted before new draft is created. When the draft is committed successfully, it will be deleted. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete_and_import	POST https://{server}/api/esx/settings/hosts/{host}/software/drafts-internal	Imports the desired software specification as a new draft. If there is a draft already associated with the user for this host, that draft will be deleted before new draft is created. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

effective components

The effective_components service provides operations to get effective list of components. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/settings/hosts/{host}/software/effective-components	Returns the effective components for the host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

hardware support

The hardware_support service provides operations to manage a host's Hardware Support Package (HSP) configuration.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/hardware-support	Returns a given host's Hardware Support Package (HSP) configuration.

esx settings hosts software reports

The esx.settings.hosts.software.reports API provides services to manage reports pertaining to the desired state software for standalone ESXi hosts.

apply impact

The apply_impact service provides operations to get the impact of an apply operation on a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/reports/apply-impact	Returns a summary of how a standalone ESXi host will be impacted during an apply operation. The impact is generated from the compliance information obtained from get. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

last apply result

The last_apply_result service provides operations to get the most recent available result of applying the desired software document to a standalone ESXi host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/reports/last-apply-result	Returns the most recent available result of applying the desired software document to the standalone ESXi host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

last check result

The last_check_result service provides operations to get the most recent available result of the checks that have been run on the standalone host before the application of the desired software document to the host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/hosts/{host}/software/reports/last-check-result	Returns the most recent available result of checks run on the standalone host before the application of the desired software document to the host. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

solutions

The solutions service provides operations to manage desired software solution specifications for an ESX host. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/esx/settings/hosts/{host}/software/solutions/{solution}	Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/settings/hosts/{host}/software/solutions/{solution}	Returns components registered for the given solution in the desired software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/settings/hosts/{host}/software/solutions	Returns all solutions in the desired software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set-task	PUT https://{server}/api/esx/settings/hosts/{host}/software/solutions/{solution}	Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

esx settings internal

The esx.settings.internal API provides services to manage ESX internal settings.

software

The software service provides operations to manage software documents for non-existing entities.

Operation	HTTP request	Description
set-task	PUT https://{server}/api/esx/settings/internal/software/{cluster}	Sets the specified software document as the desired state document for the given cluster identifier. It is not verified whether an entity with the given cluster identifier exists or not.

summary

The summary service provides operation to summarize the complaince result of the clusters in the data-center.

Operation	HTTP request	Description
get	GET https://{server}/api/esx/settings/internal/summary	Summarize the compliance result of the clusters. The API will return the cluster summary with an empty compliance result and/or desired software specification if the service failed get this information from the database due to unexpected scenarios.
scan-task	POST https://{server}/api/esx/settings/internal/summary	Scans all the clusters to get their compliance information against its respective desired state.

esx trusted infrastructure attestation

reports

The reports interface provides operations to get the Trusted Host attestation reports. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
list	GET https://{server}/api/esx/trusted-infrastructure/attestation/reports	Return the list of attestation reports. This never returns an empty list. If the ESX host is not attested, then an error is returned which explains why there is no report. This operation was added in vSphere API 7.0.1.0.

services

The services service manages endpoint configuration about the attestation service and its relation to the Key Management Server (KMS) services.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/trusted-infrastructure/attestation/services	Adds a new attestation service instance.
delete	DELETE https://{server}/api/esx/trusted-infrastructure/attestation/services/{service}	Removes a currently configured attestation service instance.
get	GET https://{server}/api/esx/trusted-infrastructure/attestation/services/{service}	Returns the detailed information about an attestation service instance.
list	POST https://{server}/api/esx/trusted-infrastructure/attestation/services	Returns the list of all attestation service instances.

esx trusted infrastructure kms

providers

The providers service provides operations to create, retrieve, update and delete providers.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/trusted-infrastructure/kms/providers	Add a new provider. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/esx/trusted-infrastructure/kms/providers/{provider}	Remove a provider. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/trusted-infrastructure/kms/providers/{provider}	Return information about a provider. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/trusted-infrastructure/kms/providers	Return the list of providers available for key operations.
update	PATCH https://{server}/api/esx/trusted-infrastructure/kms/providers/{provider}	Update an existing provider. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

services

The services service manages endpoint configuration about the Key Management Server (KMS) service and its relation to the attestation services.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/trusted-infrastructure/kms/services	Adds a new KMS service instance.
delete	DELETE https://{server}/api/esx/trusted-infrastructure/kms/services/{service}	Removes a currently configured KMS service instance.
get	GET https://{server}/api/esx/trusted-infrastructure/kms/services/{service}	Returns the detailed information about a KMS service instance.
list	POST https://{server}/api/esx/trusted-infrastructure/kms/services	Returns the list of all KMS service instances.

esx vm

esx vm data sets

data sets

The data_sets service provides operations for sharing information between a virtual machine and its guest operating system.

Information is grouped into data sets, each of which contains key-value entries comprising the data. It's expected that each application using the service will have at least one unique data set in which to store its data to avoid conflict with other applications. Each data set has attributes defining its size limitations, access control and interoperability configuration.

It's not recommended that sensitive data (for example, passwords or private keys) be stored in plain-text. The data will be visible to other applications, running both on the management network and within the guest. The data can also be exposed by backups or templates.

Data set support requires the the virtual machine be at virtual hardware version XXX or later.

Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/esx/vm/{vm}/data-sets	Creates a new data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Delete a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Returns information describing a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/vm/{vm}/data-sets	Lists the data sets of a virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Modifies the attributes of a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

entries

The entries service provides operations for manipulating entries in a data set. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}/entries/{key}	Deletes an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete_multiple	POST https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Deletes multiple entries from a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}/entries/{key}	Gets the value of an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get_multiple	POST https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Gets the value of multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Lists all entry keys in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}/entries/{key}	Sets an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set_multiple	POST https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Sets multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/esx/vm/{vm}/data-sets/{dataSet}	Modifies entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

hlm

The hlm API provides services for managing HLM in Cloud Services Gateway.

hlm deployment

deployment

The deployment service provides operations to get the state of the HLM installation. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/hlm/deployment	Gets the current state of the HLM Install. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
rollback	POST https://{server}/api/hlm/deployment	Rollback a failed HLM install so it can be installed once again. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

install

The install service provides operations to configure the installation of the appliance. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check_cloud_vc	POST https://{server}/api/hlm/deployment/install	Performs the pre install validations such that, provided input, credentials, thumbprints, etc for Cloud vCenter Server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check_onprem_vc	POST https://{server}/api/hlm/deployment/install	Performs the pre install validations such that, provided input, credentials, thumbprints, etc for On prem vCenter Server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/hlm/deployment/install	Retrieve the install specs provided at the time to invoking install api. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
start	POST https://{server}/api/hlm/deployment/install	Start HLM Installation on the Cloud Services Gateway Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vapi metadata authentication

The vapi.metadata.authentication API provides services that expose authentication information for operation elements across all the service elements.

To calculate the effective authentication information for an operation element, you should first see if there is an authentication scheme specified for the operation element. If it is not specified, then authentication scheme for the service element that contains this operation element is used. If it is not specified for the service element as well, then the authentication scheme for the package element that contains this service element is used.

component

The component service provides operations to retrieve authentication information of a component element.

A component element is said to contain authentication information if any one of package elements contained in it has authentication information.

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/authentication/component/id:{component_id}?~action=fingerprint	Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to `component_id`. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get.
get	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/component/id:{component_id}	Retrieves authentication information about the component element corresponding to `component_id`. The vapi.metadata.authentication.component_data contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/component	Returns the identifiers for the component elements that have authentication information.

package

The package service provides operations to retrieve authentication information of a package element.

A package element is said to contain authentication information if there is a default authentication assigned to all service elements contained in the package element or if one of the service element contained in this package element has authentication information.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/package/id:{package_id}	Retrieves authentication information about the package element corresponding to `package_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/package	Returns the identifiers for the package elements that have authentication information.

vapi metadata authentication service

The vapi.metadata.authentication.service API provides services to retrieve authentication information for operation elements.

service

The service service provides operations to retrieve authentication information of a service element.

A service element is said to contain authentication information if there is a default authentication assigned to all operation elements contained in a service element or if one of the operation elements contained in this service element has authentication information.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/service/id:{service_id}	Retrieves authentication information about the service element corresponding to `service_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/service	Returns the identifiers for the service elements that have authentication information.

operation

The operation service provides operations to retrieve authentication information of an operation element.

An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/metadata/authentication/service/operation/id:{service_id}?~action=get	Retrieves the authentication information about an operation element corresponding to `operation_id` contained in the service element corresponding to `service_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/service/operation	Returns the identifiers for the operation elements contained in the service element corresponding to `service_id` that have authentication information.

source

The source service provides operations to manage the sources of authentication metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains authentication information. The generated file can be registered as a source of metadata.

The authentication file contains all the data present in the interface definition files. Each authentication file contains data about one component element. When a authentication file is added as a source, each source contributes only one component element's metadata.

Authentication metadata can also be discovered from a remote server that supports the authentication metadata services (see vapi.metadata.authentication). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vapi/metadata/authentication/source/id:{source_id}	Creates a new metadata source. Once the server validates the registration information of the metadata source, the authentication metadata is retrieved from the source. This populates elements in all the services defined in vapi.metadata.authentication API.
delete	DELETE https://{server}/rest/com/vmware/vapi/metadata/authentication/source/id:{source_id}	Deletes an existing authentication metadata source from the infrastructure.
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/authentication/source/id:{source_id}?~action=fingerprint	Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if `source_id` is specified.
get	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/source/id:{source_id}	Retrieves information about the metadata source corresponding to `source_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/authentication/source	Returns the identifiers of the metadata sources currently registered with the infrastructure.
reload	POST https://{server}/rest/com/vmware/vapi/metadata/authentication/source/id:{source_id}?~action=reload	Reloads the authentication metadata from all the metadata sources or of a particular metadata source if `source_id` is specified.

vapi metadata cli

The vapi.metadata.cli API provides services that expose all the information required to display namespace or command help, execute a command and display it's result.

command

The command service provides operations to get information about command line interface (CLI) commands.

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/cli/command?~action=fingerprint	Returns the aggregate fingerprint of all the command metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for commands has been modified on the server.
get	POST https://{server}/rest/com/vmware/vapi/metadata/cli/command?~action=get	Retrieves information about a command including information about how to execute that command.
list	GET https://{server}/rest/com/vmware/vapi/metadata/cli/command	Returns the identifiers of all commands, or commands in a specific namespace.

namespace

The namespace service provides operations to get information about command line interface (CLI) namespaces.

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/cli/namespace?~action=fingerprint	Returns the aggregate fingerprint of all the namespace metadata from all the metadata sources. The fingerprint provides clients an efficient way to check if the metadata for namespaces has been modified on the server.
get	POST https://{server}/rest/com/vmware/vapi/metadata/cli/namespace?~action=get	Retreives information about a namespace including information about children of that namespace.
list	GET https://{server}/rest/com/vmware/vapi/metadata/cli/namespace	Returns the identifiers of all namespaces registered with the infrastructure.

source

The source service provides operations to manage the sources of command line interface (CLI) metadata information.

A CLI metadata file contains information about one component element. When a CLI metadata file is added as a source, each source contributes only one component element's metadata.

CLI metadata can also be discovered from a remote server that supports the CLI metadata services (see vapi.metadata.cli) API. Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}	Creates a new metadata source. Once the server validates the registration information of the metadata source, the CLI metadata is retrieved from the source. This populates elements in all the services defined in vapi.metadata.cli API.
delete	DELETE https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}	Deletes an existing CLI metadata source from the infrastructure.
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}?~action=fingerprint	Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if `source_id` is specified.
get	GET https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}	Retrieves information about the metadata source corresponding to `source_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/cli/source	Returns the identifiers of the metadata sources currently registered with the infrastructure.
reload	POST https://{server}/rest/com/vmware/vapi/metadata/cli/source/id:{source_id}?~action=reload	Reloads the CLI metadata from all the metadata sources or of a particular metadata source if `source_id` is specified.

vapi metadata metamodel

The vapi.metadata.metamodel API provides services that expose all the information present in the interface definition language (IDL) specification.

Metamodel metadata is organized into an hierarchy of elements. The main elements are:

Enumeration: An enumeration element that has a list of enumeration value elements.
Constant: A constant element has a name and a value.
Structure: A structure element can have field elements, constant elements and enumeration elements.
Operation: An operation has a list of parameter elements, result element and error elements.
Service: A service is a collection of operation elements, structure elements, enumerated elements and constant elements.
Package: A package is a collection of service elements, structure elements and enumeration elements.
Component: A component is a collection of package elements.

The vapi.metadata.metamodel API has services that enables two styles of client applications:

A client can retrieve the exact pieces of information it requires using the various granularities the API supports (that is vapi.metadata.metamodel.component, vapi.metadata.metamodel.package, vapi.metadata.metamodel.service, vapi.metadata.metamodel.structure, vapi.metadata.metamodel.enumeration and vapi.metadata.metamodel.service.operation). In this case, it doesn't cache any information locally and always invokes operations to get the metamodel information it requires.
A client can retrieve all the metamodel information in fewer operation invocations using the vapi.metadata.metamodel.component service and cache the output locally. It can then poll on the fingerprint information exposed by the vapi.metadata.metamodel.component service to monitor changes in API definition.

component

The component service providers operations to retrieve metamodel information of a component element.

A component defines a set of functionality that is deployed together and versioned together. For example, all the services that belong to VMware Content Library are part of a single component. A component element describes a component. A component element contains one or more package elements.

The operations for package elements are provided by service vapi.metadata.metamodel.package.

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/metamodel/component/id:{component_id}?~action=fingerprint	Retrieves the fingerprint computed from the metamodel metadata of the component element corresponding to `component_id`. The fingerprint provides clients an efficient way to check if the metadata for a particular component element has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get.
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/component/id:{component_id}	Retrieves metamodel information about the component element corresponding to `component_id`. The vapi.metadata.metamodel.component_data contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/component	Returns the identifiers for the component elements that are registered with the infrastructure.

enumeration

The enumeration service provides operations to retrieve metamodel information about an enumeration element in the interface definition language.

The enumeration has a list of enumeration value elements.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id}	Retrieves information about the enumeration element corresponding to `enumeration_id`. The vapi.metadata.metamodel.enumeration_info contains the metamodel information about the enumeration value element contained in the enumeration element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/enumeration	Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.

package

The package service provides operations to retrieve metamodel information about a package element in the interface definition language.

A package is a logical grouping of services, structures and enumerations. A package element describes the package. It contains the service elements, structure elements and enumeration elements that are grouped together.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/package/id:{package_id}	Retrieves information about the package element corresponding to `package_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/package	Returns the identifiers for the packages elements that are contained in all the registered component elements.

vapi metadata metamodel resource

The vapi.metadata.metamodel.resource API provides services to retrieve metamodel information for resource types.

resource

The vapi.metadata.metamodel.resource service provides operations to retrieve information about resource types.

A service is a logical grouping of operations that operate on an entity. Each entity is identifier by a namespace (or resource type) and an unique identifier.

Operation	HTTP request	Description
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/resource	Returns the set of resource types present across all the service elements contained in all the package elements.

model

The model service provides operations to retrieve information about models.

A structure is used as a model if it is used for persisting data about an entity. Some of the fields in the model structure are also used for creating indexes for querying.

One or more services can operate on the same resource type. One or more services can provide the model structure for an entity of this resource type. Using model service you can retrieve the list of all the structure elements that are model structures for a given resource type.

Operation	HTTP request	Description
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/resource/model	Returns the set of identifiers for the structure elements that are models for the resource type corresponding to `resource_id`. The vapi.metadata.metamodel.structure service provides operations to retrieve more details about the structure elements corresponding to the identifiers returned by this operation.

vapi metadata metamodel service

The vapi.metadata.metamodel.service API provides services to retrieve metamodel information about the elements contained in a service element.

service

The service service provides operations to retrieve metamodel information about a service element in the interface definition language.

A service is a logical grouping of operations that operate on some entity. A service element describes a service. It contains operation elements that describe the operations grouped in the service. It also contains structure elements and enumeration elements corresponding to the structures and enumerations defined in the service.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/service/id:{service_id}	Retrieves information about the service element corresponding to `service_id`. The vapi.metadata.metamodel.service_info contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/service	Returns the identifiers for the service elements that are currently registered with the infrastructure. The list of service elements is an aggregate list of all the service elements contained in all the package elements.

hidden

The hidden service provides operations to retrieve the list of services that are hidden and should not be exposed in various presentation layers of API infrastructure.

Operation	HTTP request	Description
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/service/hidden	Returns the service identifiers that should be hidden.

operation

The operation service provides operations to retrieve metamodel information of an operation element in the interface definition language.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/metadata/metamodel/service/operation/id:{service_id}?~action=get	Retrieves the metamodel information about an operation element corresponding to `operation_id` contained in the service element corresponding to `service_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/service/operation	Returns the identifiers for the operation elements that are defined in the scope of `service_id`.

source

The source service provides operations to manage the sources of metamodel metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains metamodel information. The generated file can be registered as a source of metadata.

The metamodel file contains all the data present in the interface definition files. Each metamodel file contains data about one component element. When a metamodel file is added as a source, each source contributes only one component element's metadata.

Metamodel metadata can also be discovered from a remote server that supports the metamodel metadata services (see vapi.metadata.metamodel). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vapi/metadata/metamodel/source/id:{source_id}	Creates a new metadata source. Once the server validates the registration information of the metadata source, the metamodel metadata is retrieved from the source. This populates elements in all the services defined in vapi.metadata.metamodel API.
delete	DELETE https://{server}/rest/com/vmware/vapi/metadata/metamodel/source/id:{source_id}	Deletes an existing metamodel metadata source from the infrastructure.
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/metamodel/source/id:{source_id}?~action=fingerprint	Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if `source_id` is specified.
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/source/id:{source_id}	Retrieves information about the metadata source corresponding to `source_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/source	Returns the identifiers of the metadata sources currently registered with the infrastructure.
reload	POST https://{server}/rest/com/vmware/vapi/metadata/metamodel/source/id:{source_id}?~action=reload	Reloads the metamodel metadata from all the metadata sources or of a particular metadata source if `source_id` is specified.

structure

The structure service providers operations to retrieve metamodel information about a structure element in the interface definition language.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/structure/id:{structure_id}	Retrieves information about the structure element corresponding to `structure_id`. The vapi.metadata.metamodel.structure_info contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/metamodel/structure	Returns the identifiers for the structure elements that are contained in all the package elements and service elements.

vapi metadata privilege

The vapi.metadata.privilege API provides services that expose privilege information for operation elements across all the service elements.

An entity has a unique identifier and a resource type. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements.

Privileges can be assigned to either operation elements or entities used in the operation element. A list of privileges can also be applied on a package element. This list of privileges would be used as a default for all the operation elements and the entities that do not have any defined privileges.

component

The component service provides operations to retrieve privilege information of a component element.

A component element is said to contain privilege information if any one of package elements in it contains privilege information.

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/privilege/component/id:{component_id}?~action=fingerprint	Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to `component_id`. The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of get.
get	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/component/id:{component_id}	Retrieves privilege information about the component element corresponding to `component_id`. The vapi.metadata.privilege.component_data contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.
list	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/component	Returns the identifiers for the component elements that have privilege information.

package

The package service provides operations to retrieve privilege information of a package element.

A package element is said to contain privilege information if there is a default privilege assigned to all service elements contained in the package element or if one of the operation elements contained in one of the service elements in this package element has privilege information.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/package/id:{package_id}	Retrieves privilege information about the package element corresponding to `package_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/package	Returns the identifiers for the package elements that have privilege information.

vapi metadata privilege service

The vapi.metadata.privilege.service API provides services to retrieve privilege information for operation elements.

service

The service service provides operations to retrieve privilege information of a service element.

A service element is said to contain privilege information if one of the operation elements contained in this service element has privilege information.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/service/id:{service_id}	Retrieves privilege information about the service element corresponding to `service_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/service	Returns the identifiers for the service elements that have privilege information.

operation

The operation service provides operations to retrieve privilege information of an operation element.

An operation element is said to contain privilege information if there are any privileges assigned to the operation element or if one of the parameter elements contained in it has privileges assigned in privilege definition file.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/metadata/privilege/service/operation/id:{service_id}?~action=get	Retrieves the privilege information about an operation element corresponding to `operation_id` contained in the service element corresponding to `service_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/service/operation	Returns the identifiers for the operation elements contained in the service element corresponding to `service_id` that have privilege information.

source

The source service provides operations to manage the sources of privilege metadata information.

The interface definition language infrastructure provides tools to generate various kinds of metadata in JSON format from the interface definition files and additional properties files. One of the generated files contains privilege information. The generated file can be registered as a source of metadata.

The privilege file contains all the data present in the interface definition files. Each privilege file contains data about one component element. When a privilege file is added as a source, each source contributes only one component element's metadata.

Privilege metadata can also be discovered from a remote server that supports the privilege metadata services (see vapi.metadata.privilege). Since multiple components can be registered with a single metadata server, when a remote server is registered as a source, that source can contribute more than one component.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vapi/metadata/privilege/source/id:{source_id}	Creates a new metadata source. Once the server validates the registration information of the metadata source, the privilege metadata is retrieved from the source. This populates elements in all the services defined in vapi.metadata.privilege API.
delete	DELETE https://{server}/rest/com/vmware/vapi/metadata/privilege/source/id:{source_id}	Deletes an existing privilege metadata source from the infrastructure.
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/privilege/source/id:{source_id}?~action=fingerprint	Returns the aggregate fingerprint of metadata from all the metadata sources or from a particular metadata source if `source_id` is specified.
get	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/source/id:{source_id}	Retrieves information about the metadata source corresponding to `source_id`.
list	GET https://{server}/rest/com/vmware/vapi/metadata/privilege/source	Returns the identifiers of the metadata sources currently registered with the infrastructure.
reload	POST https://{server}/rest/com/vmware/vapi/metadata/privilege/source/id:{source_id}?~action=reload	Reloads the privilege metadata from all the metadata sources or of a particular metadata source if `source_id` is specified.

vapi metadata routing

component

Operations to retrieve information about the routing information in a vAPI component. A Component is said to contain routing information if any of its packages, services or methods contain routing information

Operation	HTTP request	Description
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/routing/component/id:{component_id}?~action=fingerprint	Checksum of all routing metadata for a vAPI component on the server
get	GET https://{server}/rest/com/vmware/vapi/metadata/routing/component/id:{component_id}	Get the routing information for a vAPI component
list	GET https://{server}/rest/com/vmware/vapi/metadata/routing/component	List all the vAPI components that contain operations which have routing information.

package

Operations to retrieve information about routing information in a vAPI package A Package is said to contain routing information if there is a default RoutingInfo assigned to all operations within a package or if one of the operations within this package has explicit routing information

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/routing/package/id:{package_id}	Get the routing information for a vAPI package
list	GET https://{server}/rest/com/vmware/vapi/metadata/routing/package	List of all vAPI packages that have routing information

vapi metadata routing service

service

Operations to retrieve information about routing information of a vAPI service

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/metadata/routing/service/id:{service_id}	Get the routing information for a vAPI service
list	GET https://{server}/rest/com/vmware/vapi/metadata/routing/service	Get list of all vAPI services that have operations with routing information

operation

Operations to retrieve information about routing in a vAPI operation

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/metadata/routing/service/operation/id:{service_id}?~action=get	Get information about a vAPI operation that contains routing information
list	GET https://{server}/rest/com/vmware/vapi/metadata/routing/service/operation	Get the IDs of all the vAPI operations in the given service that contain routing information

source

Operations to manage the metadata sources for routing information

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vapi/metadata/routing/source/id:{source_id}	Create a new metadata source.
delete	DELETE https://{server}/rest/com/vmware/vapi/metadata/routing/source/id:{source_id}	Delete a metadata source.
fingerprint	POST https://{server}/rest/com/vmware/vapi/metadata/routing/source/id:{source_id}?~action=fingerprint	Returns the fingerprint of all the sources or of a particular source.
get	GET https://{server}/rest/com/vmware/vapi/metadata/routing/source/id:{source_id}	Get the details about a metadata source.
list	GET https://{server}/rest/com/vmware/vapi/metadata/routing/source	List all the metadata sources.
reload	POST https://{server}/rest/com/vmware/vapi/metadata/routing/source/id:{source_id}?~action=reload	Reload metadata from all the sources or of a particular source.

vapi std activation

The vapi.std.activation API provides services that TODO.

activation manager

WARNING: Use only as a sample. The API is experimental and subject to change in future versions.

Activation tracking/management service.

An activation describes a method invocation in the runtime.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/com/vmware/vapi/std/activation/activation-manager?~action=cancel	Asks for cancellation of a running activation. Whether or not the cancellation request will have any effect depends on the implementation of the method that has to be canceled.

vapi std introspection

The vapi.std.introspection API provides services that expose basic information about the vAPI services registered with a vAPI provider.

operation

The vapi.std.introspection.operation service provides operations to retrieve information about the operations present in a vAPI service.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/std/introspection/operation/id:{service_id}?~action=get	Returns the vapi.std.introspection.operation.info for a given vAPI operation.
list	GET https://{server}/rest/com/vmware/vapi/std/introspection/operation	Returns the set of operation identifiers for a given vAPI service.

provider

The vapi.std.introspection.provider service provides operations to retrieve information about a vAPI Provider. A provider is a container that exposes one or more vAPI services.

Operation	HTTP request	Description
get	POST https://{server}/rest/com/vmware/vapi/std/introspection/provider?~action=get	Returns a vapi.std.introspection.provider.info describing the vAPI provider on which the operation is invoked

service

The vapi.std.introspection.service service provides operations to retrieve information about the services exposed by a vAPI provider. A provider is a container that exposes one or more vAPI services.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vapi/std/introspection/service/id:{id}	Returns the vapi.std.introspection.service.info for the specified service
list	GET https://{server}/rest/com/vmware/vapi/std/introspection/service	Returns the set of service identifiers.

vcenter

The vcenter API provides services for managing VMware vSphere environments. The API is available starting in vSphere 6.5.

vcenter activedirectory

The vcenter.activedirectory API provides Active Directory Domain operations services.

active directory

The active_directory service provides operations to join, check the status of domain join of the appliance to a given domain or leave the current domain.

Operation	HTTP request	Description
join	POST https://{server}/rest/vcenter/system/active-directory	Join the appliance to given domain.
leave	PATCH https://{server}/rest/vcenter/system/active-directory	Leave the registered domain, if registered to any.
status	GET https://{server}/rest/vcenter/system/active-directory	Returns the Active Directory Domain Join Status of the system the identity server is executing on.

vcenter certificate authority

certificate

The certificate interface provides operations to provide info about certificates present on server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
cert_status	GET https://{server}/rest/vcenter/certificate-authority/certificate?action=cert-status	Verify the provided certificate on the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
count_certs	GET https://{server}/rest/vcenter/certificate-authority/certificate?action=count-certs	Get the count of certificates on the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
enum_certs	GET https://{server}/rest/vcenter/certificate-authority/certificate?action=enum-certs	List all the certs in the server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
gen_cert	POST https://{server}/rest/vcenter/certificate-authority/certificate?action=gen-cert	Get the signed certificate for the given Spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
generate_keys	POST https://{server}/rest/vcenter/certificate-authority/certificate?action=generate-keys	Generate the public and private key pair for given keysize. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

get root

The get_root interface provides operations to get VMCA's trusted root cert. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get_root	GET https://{server}/rest/vcenter/certificate-authority/get-root	Returns the rhttpproxy TLS certificate. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

sign cert

The sign_cert interface provides operations to generate certificate using CSR (certificate signing request). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
sign_cert_from_CSR	POST https://{server}/rest/vcenter/certificate-authority/sign-cert?action=sign-cert-from-csr	Sign the provided CSR and generate a certificate. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter certificate management vcenter

The vcenter.certificate_management.vcenter API provides services to manage certificates.

tls

The tls interface provides operations to replace Tls certificate. This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/certificate-management/vcenter/tls	Returns the rhttpproxy TLS certificate. This operation was added in vSphere API 6.7.2.
renew	POST https://{server}/rest/vcenter/certificate-management/vcenter/tls?action=renew	Renews the TLS certificate for the given duration period. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. . This operation was added in vSphere API 6.7.2.
replace_vmca_signed	POST https://{server}/rest/vcenter/certificate-management/vcenter/tls?action=replace-vmca-signed	Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. . This operation was added in vSphere API 6.9.1.
set	PUT https://{server}/rest/vcenter/certificate-management/vcenter/tls	Replaces the rhttpproxy TLS certificate with the specified certificate. This operation can be used in three scenarios : When the CSR is created and the private key is already stored, this operation can replace the certificate. The vcenter.certificate_management.vcenter.tls.spec.cert (but not vcenter.certificate_management.vcenter.tls.spec.key and vcenter.certificate_management.vcenter.tls.spec.root_cert) must be provided as input. When the certificate is signed by a third party certificate authority/VMCA and the root certificate of the third party certificate authority/VMCA is already one of the trusted roots in the trust store, this operation can replace the certificate and private key. The vcenter.certificate_management.vcenter.tls.spec.cert and vcenter.certificate_management.vcenter.tls.spec.key (but not vcenter.certificate_management.vcenter.tls.spec.root_cert) must be provided as input. When the certificate is signed by a third party certificate authority and the root certificate of the third party certificate authority is not one of the trusted roots in the trust store, this operation can replace the certificate, private key and root CA certificate. The vcenter.certificate_management.vcenter.tls.spec.cert,vcenter.certificate_management.vcenter.tls.spec.key and vcenter.certificate_management.vcenter.tls.spec.root_cert must be provided as input. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. The above three scenarios are only supported from vsphere 7.0 onwards. . This operation was added in vSphere API 6.7.2.

tls csr

The tls_csr interface provides operations to generate certificate signing request. This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/certificate-management/vcenter/tls-csr	Generates a CSR with the given Spec. This operation was added in vSphere API 6.7.2.

trusted root chains

The trusted_root_chains interface provides operations to create, modify, delete and read trusted root certificate chains. This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/certificate-management/vcenter/trusted-root-chains	Creates a new trusted root certificate chain from the CreateSpec. This operation was added in vSphere API 6.7.2.
delete	DELETE https://{server}/rest/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}	Deletes trusted root certificate chain for a given identifier. This operation was added in vSphere API 6.7.2.
get	GET https://{server}/rest/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}	Retrieve a trusted root certificate chain for a given identifier. This operation was added in vSphere API 6.7.2.
list	GET https://{server}/rest/vcenter/certificate-management/vcenter/trusted-root-chains	Returns summary information for each trusted root certificate chain. This operation was added in vSphere API 6.7.2.

vmca root

The vmca_root interface provides operations to replace VMware Certificate Authority (VMCA) root certificate. This service was added in vSphere API 6.9.1.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/certificate-management/vcenter/vmca-root	Replace Root Certificate with VMCA signed one using the given Spec. After this operation completes, the services using the certificate will be restarted for the new certificate to take effect. . This operation was added in vSphere API 6.9.1.

vcenter cluster

cluster

The cluster service provides operations to manage clusters in the vCenter Server.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/cluster	Create a new cluster in the vCenter inventory. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/rest/vcenter/cluster/{cluster}	Delete an empty cluster from the vCenter Server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/cluster/{cluster}	Retrieves information about the cluster corresponding to `cluster`.
list	GET https://{server}/rest/vcenter/cluster	Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the vcenter.cluster.filter_spec.

vcenter cluster edrs

The vcenter.cluster.edrs API provides services for interacting with EDRS, such as, query EDRS scaling recommendation, set algo parameter, etc.

algo parameter

The algo_parameter service provides operations to set/get EDRS algorithm parameters for a cluster. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/cluster/{cluster}/edrs/algo-parameter	Gets EDRS algorithm parameters for a given cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
set	PUT https://{server}/rest/vcenter/cluster/{cluster}/edrs/algo-parameter	Sets EDRS algorithm parameters for a given cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

maintenance mode

The maintenance_mode service provides operations to handle the scale out request when entering cluster maintanence mode and the scale in request when exiting maintenance mode. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
enter	POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode?action=enter	Request the cluster to enter the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
enter-task	POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode?vmw-task=true&action=enter	Request the cluster to enter the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
exit	POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode?action=exit	Request the cluster to exit the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
exit-task	POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode?vmw-task=true&action=exit	Request the cluster to exit the maintenance mode, EDRS would generate the scaling recommendation based on cluster resources utilization. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
get	GET https://{server}/rest/vcenter/cluster/{cluster}/edrs/maintenance-mode	Get the status of the cluster maintenance mode. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

recommendation

The recommendation service provides operations to give scale in (to remove host) / scale out (to add host) recommendation for a cluster. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
generate	POST https://{server}/rest/vcenter/cluster/{cluster}/edrs/recommendation?action=generate	Gives a recommendation to scale in a cluster when all resources (CPU/memory/storage) are underutilized, or to scale out a cluster when any resource is being heavily utilized. NO_ACTION will be returned if cluster resources are well utilized. This operation was added in vSphere API 7.0.1.0.

vcenter cluster modules vm

members

The members service provides operations to manage the membership of virtual machines in a cluster module. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
add	POST https://{server}/rest/vcenter/cluster/modules/vm/{module}/members?action=add	Adds virtual machines to the module. These virtual machines are required to be in the same vCenter cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/cluster/modules/vm/{module}/members	Returns the virtual machines that are members of the module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove	POST https://{server}/rest/vcenter/cluster/modules/vm/{module}/members?action=remove	Removes virtual machines from the module. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter compute

The vcenter.compute API provides services for managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

vcenter compute policies

The vcenter.compute.policies API provides structures for managing compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

policies

The policies service provides operations to manage compute policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. A compute policy defines the intended behavior for a collection of vSphere objects identified by a tag. A compute policy is an instance of a capability. It is created by providing a value for the creation type specified by the capability. See vcenter.compute.policies.capabilities.info.create_spec_type. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/compute/policies	Creates a new compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
delete	DELETE https://{server}/api/vcenter/compute/policies/{policy}	Deletes a specific compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
get	GET https://{server}/api/vcenter/compute/policies/{policy}	Returns information about a specific compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
list	GET https://{server}/api/vcenter/compute/policies	Returns information about the compute policies available in this vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

capabilities

The capabilities service provides operations to manage compute policy capabilities in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. The description of the capability provides information about the intent of a policy based on this capability. A capability provides a type to create a policy (see create). A capability also provides a type that describes the information returned when retrieving information about a policy (see get). Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/compute/policies/capabilities/{capability}	Returns information about a specific compute policy capability in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
list	GET https://{server}/api/vcenter/compute/policies/capabilities	Returns information about the compute policy capabilities available in this vCenter server in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

tag usage

The tag_usage service provides operations to query which tags are used by policies in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/compute/policies/tag-usage	Returns information about the tags used by policies available in this vCenter server matching the vcenter.compute.policies.tag_usage.filter_spec in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

VM

The VM service provides operations to enumerate the policies that are associated with virtual machines and their status. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/compute/policies/vm	Returns policies associated with virtual machines and their compliance status. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter content registries

The vcenter.content.registries API provides structures and services for managing image registries in vCenter.

vcenter content registries harbor

The vcenter.content.registries.harbor API provides structures and services for managing Harbor registry in vCenter.

harbor

The harbor service provides operations to manage the lifecycle of an integrated Harbor container registry in vCenter.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/content/registries/harbor	Creates a Harbor registry in the cluster.
delete	DELETE https://{server}/rest/vcenter/content/registries/harbor/{registry}	Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.
get	GET https://{server}/rest/vcenter/content/registries/harbor/{registry}	Get detailed information of the Harbor registry.
list	GET https://{server}/rest/vcenter/content/registries/harbor	Returns basic information of all Harbor registries.

vcenter content registries harbor project

The vcenter.content.registries.harbor.project API provides structures and services for managing Harbor projects.

members

The members service provides operations to manage Harbor project members.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}/members	Create a project member for specified Harbor project.
delete	DELETE https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}/members/{member}	Remove a project member from specified Harbor project.
get	GET https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}/members/{member}	Get detailed Harbor project member information for specified user or group.
list	GET https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}/members	Returns all members basic information in the specified Harbor project.
update	PATCH https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}/members/{member}	Update access control for a member in a registry project.

projects

The projects service provides operations for managing the lifecycle of Harbor project that stores and distributes container repositories and images.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects	Creates a project in a Harbor registry using the supplied specification. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is created, a project with same name as the namespace is created in the Harbor registry, so this operation should not be called.
delete	DELETE https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}	Deletes the specified project from Harbor registry. Repositories and images in the project will be removed upon project deletion. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor registry is deployed in a vSphere cluster with vSphere namespaces enabled. When a namespace is deleted, a project with same name as the namespace is deleted from the Harbor registry, so this operation should not be called.
get	GET https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}	Returns detailed information about the specified Harbor project.
list	GET https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects	Returns basic information of all projects in a Harbor registry.
purge	POST https://{server}/rest/vcenter/content/registries/harbor/{registry}/projects/{project}?action=purge	Remove all repositories, images and members in the project. Storage space of deleted images in the project will be reclaimed through next scheduled Harbor registry garbage collection.

health

The health service provides operations to retrieve health status for a container registry.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/content/registries/{registry}/health	Returns the health information of a container registry in the vCenter.

datacenter

The datacenter service provides operations to manage datacenters in the vCenter Server.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/datacenter	Create a new datacenter in the vCenter inventory
delete	DELETE https://{server}/rest/vcenter/datacenter/{datacenter}	Delete an empty datacenter from the vCenter Server
get	GET https://{server}/rest/vcenter/datacenter/{datacenter}	Retrieves information about the datacenter corresponding to `datacenter`.
list	GET https://{server}/rest/vcenter/datacenter	Returns information about at most 1000 visible (subject to permission checks) datacenters in vCenter matching the vcenter.datacenter.filter_spec.

vcenter datastore

datastore

The Datastore service provides operations for manipulating a datastore.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/datastore/{datastore}	Retrieves information about the datastore indicated by `datastore`.
list	GET https://{server}/rest/vcenter/datastore	Returns information about at most 2500 visible (subject to permission checks) datastores in vCenter matching the vcenter.datastore.filter_spec.

default policy

The default_policy service provides operations related to storage policies associated with datastore object. The get operation provides information about the default storage policy associated with the specific datastore. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/datastore/{datastore}/default-policy	Returns the identifier of the current default storage policy associated with the specified datastore. This operation was added in vSphere API 6.7.

vcenter deployment

deployment

The deployment service provides operations to get the status of the vCenter appliance deployment. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/deployment	Get the current status of the appliance deployment. This operation was added in vSphere API 6.7.
rollback	POST https://{server}/rest/vcenter/deployment?action=rollback	Rollback a failed appliance so it can be configured once again. This operation was added in vSphere API 6.7.

import history

The import_history service provides operations for managing the import of vCenter historical data, e.g. Tasks, Events and Statistics, when is is imported separately from the upgrade or migration process. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/vcenter/deployment/history?action=cancel	Cancels the task for importing vCenter historical data. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/vcenter/deployment/history	Get the current status of the vCenter historical data import. This operation was added in vSphere API 6.7.
pause	POST https://{server}/rest/vcenter/deployment/history?action=pause	Pauses the task for importing vCenter historical data. This operation was added in vSphere API 6.7.
resume	POST https://{server}/rest/vcenter/deployment/history?action=resume	Resumes the task for importing vCenter historical data. This operation was added in vSphere API 6.7.
start	POST https://{server}/rest/vcenter/deployment/history?action=start	Creates and starts task for importing vCenter historical data. This operation was added in vSphere API 6.7.

vcenter deployment install

install

The install service provides operations to configure the installation of the appliance. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/vcenter/deployment/install?action=cancel	Cancel the appliance installation that is in progress. This operation was added in vSphere API 6.7.
check	POST https://{server}/rest/vcenter/deployment/install?action=check	Run sanity checks using the InstallSpec parameters passed. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/vcenter/deployment/install	Get the parameters used to configure the ongoing appliance installation. This operation was added in vSphere API 6.7.
start	POST https://{server}/rest/vcenter/deployment/install?action=start	Start the appliance installation. This operation was added in vSphere API 6.7.

vcenter deployment install initial config remote psc

thumbprint

The thumbprint service provides operations to get the thumbprint of the remote PSC. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/deployment/install/initial-config/remote-psc/thumbprint	Gets the SHA1 thumbprint of the remote PSC. This operation was added in vSphere API 6.7.

vcenter deployment install psc

replicated

The replicated service provides operations to check if the configuring vCenter Server can be replicated to the remote PSC. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/deployment/install/psc/replicated?action=check	Checks whether the provided remote PSC is reachable and can be replicated. This operation was added in vSphere API 6.7.

standalone

The standalone service provides operations to check if the values provided for the standalone PSC satisfies the requirements. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/deployment/install/psc/standalone?action=check	Checks that the information to configure a non-replicated PSC satisfies the requirements. This operation was added in vSphere API 6.7.

remote psc

The remote_psc service provides operations to check if the deployed vCenter Server can register with the remote PSC. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/deployment/install/remote-psc?action=check	Checks whether the remote PSC is reachable and the deployed vCenter Server can be registered with the remote PSC. This operation was added in vSphere API 6.7.

vcenter deployment migrate

migrate

The migrate service provides operations to configure the migration of this appliance from an existing vCenter for Windows. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/vcenter/deployment/migrate?action=cancel	Cancel the appliance migration that is in progress. This operation was added in vSphere API 7.0.0.0.
check	POST https://{server}/rest/vcenter/deployment/migrate?action=check	Run sanity checks using the MigrateSpec parameters passed. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/rest/vcenter/deployment/migrate	Get the MigrateSpec parameters used to configure the ongoing appliance migration. This operation was added in vSphere API 7.0.0.0.
start	POST https://{server}/rest/vcenter/deployment/migrate?action=start	Start the appliance migration. This operation was added in vSphere API 7.0.0.0.

active directory

The active_directory service provides operations to check if the migrated vCenter Server appliance can join to the given domain using the provided credentials. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/deployment/migrate/active-directory?action=check	Checks whether the provided Active Directory user has permission to join the migrated vCenter Server appliance to the domain. This operation was added in vSphere API 7.0.0.0.

question

The question service provides operations to get the question raised during deployment and to answer them. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
answer	POST https://{server}/rest/vcenter/deployment/question?action=answer	Supply answer to the raised question. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/vcenter/deployment/question	Get the question that was raised during the configuration. This operation was added in vSphere API 6.7.

upgrade

The upgrade service provides operations to configure the upgrade of this appliance from an existing vCenter appliance. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
cancel	POST https://{server}/rest/vcenter/deployment/upgrade?action=cancel	Cancel the appliance upgrade that is in progress. This operation was added in vSphere API 6.7.
check	POST https://{server}/rest/vcenter/deployment/upgrade?action=check	Run sanity checks using the UpgradeSpec parameters passed. This operation was added in vSphere API 6.7.
get	GET https://{server}/rest/vcenter/deployment/upgrade	Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This operation was added in vSphere API 6.7.
start	POST https://{server}/rest/vcenter/deployment/upgrade?action=start	Start the appliance installation. This operation was added in vSphere API 6.7.

vcenter extension

tasks

The tasks service provides operations for creating tasks for an operation in vCenter extension and updating the description, state and progress of the task. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/extension/tasks	Returns a taskId for the task using the CreateSpec. The taskId can be used for querying or updating the status of the task by the client. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/extension/tasks/{task_id}	Updates the information of the operation associated with a task on the ManagedObjects. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter files nfc tickets

The vcenter.files.nfc.tickets API provides services for creating NFC tickets.

datastore

The datastore service provides operations to create Network File Copy (NFC) tickets to access files on a datastore. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/files/nfc/tickets/datastore	Creates NFC tickets for datastore access. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

folder

The Folder service provides operations for manipulating a vCenter Server folder.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/folder	Create a new folder in the vCenter inventory. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/rest/vcenter/folder/{folder}	Delete an empty folder from the vCenter Server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/folder/{folder}	Retrieves information about the folder corresponding to `folder`. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/folder	Returns information about at most 1000 visible (subject to permission checks) folders in vCenter matching the vcenter.folder.filter_spec.

vcenter guest

The vcenter.guest API provides services for managing guest customization specifications in the vCenter Server.

customization specs

The customization_specs service provides operations to manage guest customization specifications in the vCenter Server. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/guest/customization-specs	Creates a customization specification. This operation was added in vSphere API 7.0.0.0.
delete	DELETE https://{server}/rest/vcenter/guest/customization-specs/{name}	Deletes a customization specification with the specified identifier. This operation was added in vSphere API 7.0.0.0.
export	POST https://{server}/rest/vcenter/guest/customization-specs/{name}?action=export	Returns the content of the customization specification in the specified format. Note that any passwords in the customization specification will be set to blank values during the export operation. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/rest/vcenter/guest/customization-specs/{name}	Returns the guest customization specification from vCenter with the specified identifier. This operation was added in vSphere API 7.0.0.0.
import_specification	POST https://{server}/rest/vcenter/guest/customization-specs?action=import	Converts a well formatted string to a vcenter.guest.customization_specs.create_spec. The resulting object can be passed to create operation. This operation was added in vSphere API 7.0.0.0.
list	GET https://{server}/rest/vcenter/guest/customization-specs	Returns information about at most 1000 visible (subject to permission checks) guest customization specifications in vCenter matching the vcenter.guest.customization_specs.filter_spec. This operation was added in vSphere API 6.7.1.
set	POST https://{server}/rest/vcenter/guest/customization-specs/{name}	Sets an existing specification, possibly after retrieving (by using get) and editing it. This operation was added in vSphere API 7.0.0.0.

vcenter hlm

The vcenter.hlm API provides services to manage various linked modes. Usage beyond VMware Cloud on AWS is not supported.

community

The community service provides operations to add and remove nodes to a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
add-task	POST https://{server}/rest/vcenter/hlm/community?vmw-task=true&action=add	Adds the target node to the community. By default, the first member of the community id the local node. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check	POST https://{server}/rest/vcenter/hlm/community?action=check	Performs network checks between nodes in the community. This can be called before the add to validate network requirements prior to performing the action or after adding to check network connectivity within a peers of a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check-task	POST https://{server}/rest/vcenter/hlm/community?vmw-task=true&action=check	Performs network checks between nodes in the community. This can be called before the add to validate network requirements prior to performing the action or after adding to check network connectivity within a peers of a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/hlm/community	Information about the community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove-task	POST https://{server}/rest/vcenter/hlm/community?vmw-task=true&action=remove	Removes a specified node from a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

convergence

The convergence check whether the community is converged. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
converge-task	GET https://{server}/rest/vcenter/hlm/convergence?vmw-task=true	Performs convergence checks for whole community in all services. This can be called after link finished to check whether the system is available. Or anytime want to know whether the system is converged after data been modified. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

multi sddc

The multi_sddc service provides operations to set MultiSDDC specific config information. This API is used only to set configuration and get is intentionally not provided by this api. The actual feature related APIs will throw relevant exceptions , if the configuration for Multi sddc is not enabled. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
set	PUT https://{server}/rest/vcenter/hlm/multiSddc	Sets the Multi SDDC feature to enabled on the appliance. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

remote worker

The remote_worker service provides operations to do operations related to HLM on remote node. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
link	POST https://{server}/rest/vcenter/hlm/remote/link	Does operations for link as hvc solution user on the remote or target node. Currently, it creates a new trust for domain per the given spec. Note: This is only a pass through API which will call VCTrusts.create after validating privileges required to create trusts as part of creating Linked vCenters. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

sddcs

The sddcs service provides the operation to list the Sddcs under an organization. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/hlm/sddcs	Lists all Sddcs that are under the same organization as the local node. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter host

host

The host service provides operations to manage hosts in the vCenter Server.

Operation	HTTP request	Description
connect	POST https://{server}/rest/vcenter/host/{host}/connect	Connect to the host corresponding to `host` previously added to the vCenter server.
create	POST https://{server}/rest/vcenter/host	Add a new standalone host in the vCenter inventory. The newly connected host will be in connected state. The vCenter Server will verify the SSL certificate before adding the host to its inventory. In the case where the SSL certificate cannot be verified because the Certificate Authority is not recognized or the certificate is self signed, the vCenter Server will fall back to thumbprint verification mode as defined by vcenter.host.create_spec.thumbprint_verification.
delete	DELETE https://{server}/rest/vcenter/host/{host}	Remove a standalone host from the vCenter Server.
disconnect	POST https://{server}/rest/vcenter/host/{host}/disconnect	Disconnect the host corresponding to `host` from the vCenter server
list	GET https://{server}/rest/vcenter/host	Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the vcenter.host.filter_spec.

vcenter host features

tech preview

The tech_preview service provides operations to get and set the status of Tech Preview feature state switches on a host managed by vcenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/host/{host}/features/tech-preview	Returns the current status of the feature switches in Tech Preview mode for the feature names in the input set. If the input set is empty, returns the status of all the features. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/host/{host}/features/tech-preview	Sets the status to enabled/disabled for the Tech Preview feature switches passed in the input key/value pairs. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter host maintenance

requests v1

The requests_v1 service provides operations to manage host maintenance requests in the vCenter Server. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/host/maintenance/requests-v1	Creates a maintenance request on multiple hosts. If a maintenance request already exists for a host with the same description, then the exiting request identifier is returned. This operation was added in vSphere API 7.0.1.0.
delete	POST https://{server}/api/vcenter/host/maintenance/requests-v1	Deletes the given set of maintenance requests. This operation was added in vSphere API 7.0.1.0.
list	GET https://{server}/api/vcenter/host/maintenance/requests-v1	Returns information about maintenance requests matching the vcenter.host.maintenance.requests_v1.filter_spec. This operation was added in vSphere API 7.0.1.0.

vcenter hvc

The vcenter.hvc API provides services to manage hybrid links between a local and remote Platform Service Controller. Usage beyond VMware Cloud on AWS is not supported.

vcenter hvc links

links

The links service provides operations to create, delete, get information, and list hybrid links between the local and foreign Platform Service Controller (PSC). Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
create	POST https://{server}/rest/hvc/links	Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
delete	DELETE https://{server}/rest/hvc/links/{link}	Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
delete_with_credentials	POST https://{server}/rest/hvc/links/{link}?action=delete	Deletes an existing hybrid link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/hvc/links/{link}	Gets information for a link. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/hvc/links	Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter hvc links sync

sync

The sync service provides operations to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
remediate	POST https://{server}/rest/hvc/links/{link}/sync?action=remediate	Remediates the sync state between the linked domains by initiating a fresh sync for certificate providers. If an existing sync is in progress this cancels the sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
reset	POST https://{server}/rest/hvc/links/{link}/sync?action=reset	Resets the sync state between the linked domains by initiating a fresh sync for all providers. If an existing sync is in progress this cancels the sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

providers

The providers service provides operations to create a sync session, get information on Sync. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
get	GET https://{server}/rest/hvc/links/{link}/sync/providers/{provider}	Gets Sync information for a sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
list	GET https://{server}/rest/hvc/links/{link}/sync/providers	Enumerates the sync providers. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
start	POST https://{server}/rest/hvc/links/{link}/sync/providers/{provider}?action=start	Initiates synchronization between the local and remote replicas for the sync provider. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter hvc management

administrators

The administrators provides operations to update, delete, and list groups in the local sso group. This is limited to the Hybrid Linked Mode service. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
add	POST https://{server}/rest/hvc/management/administrators?action=add	Add the local sso group with the new group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
get	GET https://{server}/rest/hvc/management/administrators	Enumerates the set of all the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
remove	POST https://{server}/rest/hvc/management/administrators?action=remove	Remove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
set	PUT https://{server}/rest/hvc/management/administrators	Sets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter identity

The vcenter.identity API provides services to manage VcIdentity.

foreign security principals

The foreign_security_principals interface provides operations to read and modify foreign security principals. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/identity/foreign-security-principals	Create a foreign security principal. If the same Id already exists, update the record. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/identity/foreign-security-principals/{principal}	Retrieve foreign security principal based on the identifier. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list_domains	GET https://{server}/rest/vcenter/identity/foreign-security-principals/domains	Retrieve all domain names associated with foreign security principals. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/identity/foreign-security-principals/{id}	Update a foreign security principal. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

providers

The providers interface provides operations to list, read and modify vCenter Server identity providers. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/identity/providers	Create a vCenter Server identity provider. This operation was added in vSphere API 7.0.0.0.
delete	DELETE https://{server}/rest/vcenter/identity/providers/{provider}	Delete a vCenter Server identity provider. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/rest/vcenter/identity/providers/{provider}	Retrieve detailed information of the specified identity provider. This operation was added in vSphere API 7.0.0.0.
list	GET https://{server}/rest/vcenter/identity/providers	Retrieve all identity providers. This operation was added in vSphere API 7.0.0.0.
update	PATCH https://{server}/rest/vcenter/identity/providers/{provider}	Update a vCenter Server identity provider. This operation was added in vSphere API 7.0.0.0.

vc identity

The vc_identity interface provides operations to read and modify local vCenter identity. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/identity/vc-identity	Retrieve VcIdentity for local domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/identity/vc-identity	Update the VcIdentity for local domain with data in given UpdateSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter inventory

The vcenter.inventory component provides operations and structures for retrieving vCenter datastore and network information for a given array of identifiers.

datastore

The datastore service provides operations to retrieve information about datastores.

Operation	HTTP request	Description
find	POST https://{server}/rest/com/vmware/vcenter/inventory/datastore?~action=find	Returns datastore information for the specified datastores. The key in the result key/value pairs is the datastore identifier and the value in the key/value pairs is the datastore information.

network

The network service provides operations to retrieve information about vCenter Server networks.

Operation	HTTP request	Description
find	POST https://{server}/rest/com/vmware/vcenter/inventory/network?~action=find	Returns network information for the specified vCenter Server networks. The key in the result key/value pairs is the network identifier and the value in the key/value pairs is the network information.

vcenter iso

The vcenter.iso API provides structures and services that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

image

Provides an interface to mount and unmount an ISO image on a virtual machine.

This is an API that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.

Operation	HTTP request	Description
mount	POST https://{server}/rest/com/vmware/vcenter/iso/image/id:{library_item}?~action=mount	Mounts an ISO image from a content library on a virtual machine.
unmount	POST https://{server}/rest/com/vmware/vcenter/iso/image/id:{vm}?~action=unmount	Unmounts a previously mounted CD-ROM using an ISO image as a backing.

iso path

Provides an interface to perform datastore path related operations on a library item.

This is an API that will let its client lookup the datastore path of a .iso file within an ISO content library item.

Operation	HTTP request	Description
get_datastore_path	GET https://{server}/rest/com/vmware/vcenter/iso/iso-path/id:{library_item_id}/datastore-path	Returns the datastore path of a .iso file within an ISO content library item.

vcenter lcm

The vcenter.lcm API provides services for managing the vCenter Server lifecycle.

vcenter lcm discovery

The vcenter.lcm.discovery API provides services for discovering products registered with vCenter Server and interoperability between those products and vCenter Server.

associated products

The associated_products service provides options to list, add, modify, and delete VMware products associated with vCenter Server. Some products can be auto-detected by the system while others can be added manually.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/lcm/discovery/associated-products	Associates a VMware product with vCenter Server manually. The product must be taken from the product catalog API.
delete	DELETE https://{server}/api/vcenter/lcm/discovery/associated-products/{product}	Deletes or dissociates a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be deleted or dissociated.
get	GET https://{server}/api/vcenter/lcm/discovery/associated-products/{product}	Returns the detailed information of a product associated with vCenter Server.
list	GET https://{server}/api/vcenter/lcm/discovery/associated-products	Retrieves a list of all associated VMware product deployments with vCenter Server in the environment. The list contains both product deployments discovered automatically and deployments registered manually through the API.
update	PATCH https://{server}/api/vcenter/lcm/discovery/associated-products/{product}	Modifies a VMware product associated with vCenter Server which was added manually. Automatically discovered VMware products cannot be modified.

interop report

The interop_report interface provides operations to report the interoperability between a vCenter Server release version and the other installed VMware products registered in the vCenter Server instance.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/lcm/discovery/interop-report	Creates interoperability report between a vCenter Server release version and all registered products with the vCenter Server instance. The result of this operation can be queried by calling the get operation where `task` is the response of this operation.

product catalog

The product_catalog service provides information which VMware products can be associated with vCenter Server.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/lcm/discovery/product-catalog	Retrieves a list of all VMware products that can be associated with vCenter Server.

vcenter lcm install

The vcenter.lcm.install API provides services for querying and modifying a scheduled install operation. Scheduled install perations can be queried and modified only when they have not started.

install

The service to install Embedded VCSA, PSC, Management VCSA, VMC gateway. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/lcm/install?action=check	Performs a precheck for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
start	POST https://{server}/rest/vcenter/lcm/install?action=start	Deploys the appliance for the given specification. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

scheduled

Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/lcm/install/scheduled/{task}	Retrieves information of the install operation that has the given id. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/rest/vcenter/lcm/install/scheduled/{task}	Updates the information of the task that has the given identifier. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

reports

The Report service provides an operation to download the report generated by the interop and precheck operations. To download a report, you must use the get operation. A Report.Location structure represents the location of the file which has Report.Token structure which represents the token ID (@name String) and the expiration time of the token Report.Token.expiry DateTime. Report.Location structure also has the URI for the file which needs to be downloaded.

Operation

HTTP request

Description

GET https://{server}/api/vcenter/lcm/reports/{report}

Returns the location vcenter.lcm.reports.location information for downloading the report for the specified file name.

Retrieving a report involves two steps:

Step 1: Invoke the get operation to provision a token and a URI.
Step 2: Make an HTTP GET request by using the URI and the token returned in step 1 to retrieve the report.

The HTTP GET request will:

Return 401 (Not Authorized) if the download URI is recognized, but the token is invalid, 404 if the URL is not recognized otherwise return 200 (OK)
Provide the CSV contents as the output of the request. The API accepts the file name as input, reads the contents of that CSV file, and returns this text as the result of the API.

status manager

Operation	HTTP request	Description
check	GET https://{server}/rest/vcenter/lcm/appliance-status	Retrieves the status of the appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter lcm tasks

The vcenter.lcm.tasks API provides services for querying the status of the operation. To query a scheduled task, use the Scheduled provider. To query running task, use Active provider. To query for tasks that has finished, use the Historical provider.

tasks

The service of life cycle management tasks. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/rest/vcenter/lcm/tasks/{task}	Removes the task of the given identifier. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

active

Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/lcm/tasks/active	Retrieves information of the tasks that are being executed. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

historical

Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/lcm/tasks/historical	Retrieves information of the tasks that are has been executed. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

scheduled

Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/lcm/tasks/scheduled	Retrieves information of the tasks that are scheduled to be executed in the future. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter lcm topology

The vcenter.lcm.topology API provides services for discovering vCenter Server topology in Enhanced Linked Mode (ELM).

nodes

The nodes interface provides operations to retrieve information about all linked vCenter Server nodes. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/lcm/topology/nodes	This operation retrieves detailed information about all linked vCenter Server nodes. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter lcm update

The vcenter.lcm.update API provides services for updating vCenter Server to a newer version.

pending

The pending service provides operation for listing pending minor or major updates of vCenter Server.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/lcm/update/pending/{version}	Gets detailed update information.
list	GET https://{server}/api/vcenter/lcm/update/pending	Lists all available minor and major updates.

precheck report

The precheck_report service generates precheck report for a vCenter Server instance against a target update version.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/lcm/update/pending/{version}/precheck-report	Creates a vCenter Server pre-update compatibility check report for the pending update version. The report can be exported and downloaded in CSV format. The result of this operation can be queried by calling the get operation where `task` is the response of this operation.

validation

The service that provides validation of a section of full deployment specification. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check_appliance_name-task	POST https://{server}/rest/vcenter/lcm/validation?action=check-appliance-name&vmw-task=true	Validate the name of the appliance to be deployed. 1. Return False if the there is already an appliance that has the same name as given in the spec exist in the path. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter namespace management

The vcenter.namespace_management API provides services for managing Namespaces.

vcenter namespace management certificate management

tls csr

The tls_csr interface provides operations to generate certificate signing requests.

Operation	HTTP request	Description
create	POST https://{server}/api/{cluster}/csr/tls-endpoint	Create a Certificate Signing Request for Kubernetes API Server. Certificate issued using this request can be used to update cluster configuration using {name UpdateSpec}.
create_ncp_default_ingress_tls	POST https://{server}/api/{cluster}/csr/ncp-default-ingress-tls	Create a Certificate Signing Request used by NSX as a default, fallback certificate for Kubernetes Ingress objects. The certificate issued using this request can be used to update cluster configuration using {name UpdateSpec}.

cluster available versions

The {@name cluster-available-versions} service provides operations to retrieve available upgrade versions of WCP and detailed information about each upgrade.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/namespace-management/software/cluster-available-versions	Get information about each available upgrade.

cluster compatibility

The cluster_compatibility service provides operations to get Namespace-related compatibility information for clusters in this vCenter.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/namespace-management/cluster-compatibility	Returns Namespaces compatibility information for all clusters in vCenter matching the vcenter.namespace_management.cluster_compatibility.filter_spec. The result contains only visible (subject to permission checks) clusters.

cluster size info

The {@name cluster-size-info} service provides operations to retrieve various sizes available for enabling Namespaces and information about each size.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/namespace-management/cluster-size-info	Get information about the default values associated with various sizes.

clusters

The clusters service provides operations to enable and disable vSphere Namespaces on a vSphere cluster.

Operation	HTTP request	Description
disable	POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.
enable	POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.
get	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Returns information about a specific cluster.
list	GET https://{server}/api/vcenter/namespace-management/clusters	Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
rotate_password	POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.
set	PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.
update	PATCH https://{server}/api/vcenter/namespace-management/clusters/{cluster}	Update configuration on the cluster object. The specified configuration is applied partially and unset fields in `spec` will leave those parts of configuration as-is.

distributed switch compatibility

The distributed_switch_compatibility service provides operations to get Namespaces compatibility information of Distributed Switches in this vCenter.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/namespace-management/distributed-switch-compatibility	Returns Namespaces compatibility information of Distributed Switches in vCenter associated with the vCenter cluster, matching the vcenter.namespace_management.distributed_switch_compatibility.filter_spec.

edge cluster compatibility

The edge_cluster_compatibility service provides operations to get Namespaces compatibility information of NSX Edge Clusters.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/namespace-management/edge-cluster-compatibility	Returns Namespaces compatibility information of NSX-T Edge Clusters matching the vcenter.namespace_management.edge_cluster_compatibility.filter_spec.

vcenter namespace management events

The vcenter.namespace_management.events API provides service for gathering Kubernetes events related to a Kubernetes Cluster.

events

The events service provides operations to get Kubernetes events related to a particular cluster.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/namespace-management/events/{cluster}	Returns Kubernetes events related to a specific cluster.

hosts config

The Compatibility service provides operations to retrieve information about vSphere Namespaces support and licensing.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/namespace-management/capability	Returns support and licensing information about hosts under a VC.

load balancers

load_balancers represent the user provisioned load balancers. The load balancers provided may be used to front the API servers in both, vSphere Namespaces Cluster and Tanzu Kubernetes Grid clusters. Note: The lifecycle of these load balancers is not managed by vSphere. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/	Create a load balancer config to associate a user provisioned load balancer with a cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}	Removes a load balancer configuration associated with a cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}	Returns information vcenter.namespace_management.load_balancers.info about the load balancer associated with the given cluster. This operation was added in vSphere API 7.0.1.0.
list	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers	Returns information about all load balancers associated with the given cluster. This operation was added in vSphere API 7.0.1.0.
set	PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}	Applies the entire load balancer `spec` to an existing load balancer configuration. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}	Updates the load balancer configuration. The specified configuration is applied partially and unset fields in `spec` will leave those parts of configuration as-is. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

namespace resource options

The namespace_resource_options service provides operations to get the objects used to create and modify resource quotas on a namespace.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/workload-resource-options	Get the information about the objects used to set and update resource quota keys for version of Kubernetes running on {#link cluster}.

networks

The networks service provides lifecycle operations on vSphere Namespaces networks associated with a vSphere cluster. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks	Create a vSphere Namespaces network object associated with the given cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}	Delete the vSphere Namespaces object in the cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}	Return information about a specific vSphere Namespaces network. This operation was added in vSphere API 7.0.1.0.
list	GET https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks	Return information about all vSphere Namespaces networks in the cluster. This operation was added in vSphere API 7.0.1.0.
set	PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}	Set a new configuration for the vSphere Namespaces network object associated with the given cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}	Update the configuration of the vSphere Namespaces network object associated with the given cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

nodes

The nodes service provides operations to manage the state of Kubernetes nodes of a Namespaces cluster.

Operation	HTTP request	Description
enter_maintenance_mode	POST https://{server}/rest/vcenter/namespace-management/clusters/{cluster}/nodes?action=enter_maintenance_mode	Enter Namespaces maintenance mode on the node. This operation removes Kubernetes pods from the given node and prevents further scheduling of pods on the node. This operation can be cancelled by calling exitMaintenanceMode operation on the node.
exit_maintenance_mode	POST https://{server}/rest/vcenter/namespace-management/clusters/{cluster}/nodes?action=exit_maintenance_mode	Exit Namespaces maintenance mode on the node. This operation enables scheduling of Kubernetes pods on the node.

vcenter namespace management software

The vcenter.namespace_management.software API provides services for managing namespaces software components.

clusters

The clusters service provides operations to upgrade the vSphere clusters.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/namespace-management/software/clusters/{cluster}	Returns upgrade related information of a specific cluster.
list	GET https://{server}/api/vcenter/namespace-management/software/clusters	Returns upgrade related information about all WCP enabled clusters.
upgrade	POST https://{server}/api/vcenter/namespace-management/software/clusters/{cluster}	Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted
upgrade_multiple	POST https://{server}/api/vcenter/namespace-management/software/clusters	Upgrade a set of clusters to its corresponding specific version.

vcenter namespace management stats

The vcenter.namespace_management.stats API provides services for gathering statistics related to various Namespaces related components.

time series

The time_series service provides operations to gather statistical values for clusters, namespaces and pods.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/namespace-management/stats/time-series	Gather statistical values for a cluster, namespace, or pod.

vcenter namespace management supervisor services

The vcenter.namespace_management.supervisor_services API provides services for managing supervisor services that are extensions to the vSphere Supervisor clusters.

supervisor services

The supervisor_services service provides operations to manage a supervisor service object. Supervisor services can be extensions to the vSphere Supervisor clusters and provide services to applications running in vSphere Supervisor clusters. They are often provided by 3rd party vendors. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespace-management/supervisor-services	Create a supervisor service. If version specs are provided in the `spec`, new supervisor service versions will be created as part of the operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}	Delete a supervisor service. All versions of this service which are enabled in the vSphere Supervisor clusters will be removed. This will also remove the service from vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}	Return the information for the specified supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/vcenter/namespace-management/supervisor-services	Return the information about all supervisor services on this vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}	Update a supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

versions

The versions service provides operations to manage a version object of a supervisor service. A supervisor service version can be enabled on the vSphere Supervisor clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions	Create a supervisor service version based on the provided service definition information for the version. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}	Delete a supervisor service version. This operation deletes the supervisor service version from vCenter and tears down all resources for the service version in the vSphere Supervisor clusters that have the supervisor service version enabled. Note that deleting the last version of the `supervisor_service` does not delete the `supervisor_service` instance automatically. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}	Return the information for the specified supervisor service version. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions	Return the information about all versions of the supervisor service. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

support bundle

The support_bundle service provides operations to retrieve the cluster's Namespaces-related support bundle download location.

Operation

HTTP request

Description

POST https://{server}/api/vcenter/namespace-management/clusters/{cluster}/support-bundle

Returns the location vcenter.namespace_management.support_bundle.location information for downloading the Namespaces-related support bundle for the specified cluster.

Retrieving a support bundle involves two steps:

Step 1: Invoke operation to provision a token and a URI.
Step 2: Make an HTTP GET request using URI and one time used token returned in step 1 to generate the support bundle and return it.

There can only be one valid token per cluster at any given time. If this operation is invoked again for the same cluster identifier while a token still valid, the API will return the same vcenter.namespace_management.support_bundle.location response.

The HTTP GET request will:

return 401 (Not Authorized) if the download URL is recognized, but the token is invalid.
otherwise return 200 (OK), mark the token used (invalidating it for any future use), open a application/tar download stream for the client, and start the bundle process. As part of its work, the API will orchestrate support bundling on the worker nodes of a cluster. If a failure occurs during the collection of support bundle from worker node, the API will not abort the request, but will log a warning and move on to processing other worker nodes' bundles. The API will only abort its operation if the content of the stream has been corrupted. When the API has to abort its operation (and the response stream), it will not provide any indication of failures to the client. The client will need to verify validity of the resultant file based on the format specified in the response's Content-Disposition header.

trial

The trial service allows the admin to set the status of user trail to true. This flag would be later on used by the UI via dataprovider to show or hide the User Data Acquire UI before work load management UI. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
enable	POST https://{server}/api/vcenter/namespace-management/trial	Enables the end-user data acquired flag or sets the end-user trial enabled to true. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter namespaces

The vcenter.namespaces API provides services for managing namespaces related operations.

access

The access service provides operations to manage access control of subjects on namespaces.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}	Set up access control for the subject on given domain on the namespace.
delete	DELETE https://{server}/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}	Remove access control of the subject on given domain from the namespace.
get	GET https://{server}/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}	Get the information about the access control of the subject on given domain on the namespace.
set	PUT https://{server}/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}	Set new access control on the namespace for the subject on given domain.

vcenter namespaces events

The vcenter.namespaces.events API provides service for gathering Kubernetes events related to a Kubernetes Namespace.

events

The events service provides operations to get Kubernetes events related to a particular namespace.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/namespaces/events/{namespace}	Returns Kubernetes events related to a specific namespace.

instances

The instances service provides operations to create and delete a namespace object. In this version, an Instance is an abstraction around a Kubernetes namespace.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/namespaces/instances	Create namespace object in the cluster.
delete	DELETE https://{server}/api/vcenter/namespaces/instances/{namespace}	Delete the namespace object in the cluster.
get	GET https://{server}/api/vcenter/namespaces/instances/{namespace}	Returns information about a specific namespace.
list	GET https://{server}/api/vcenter/namespaces/instances	Returns the information about all namespaces on this vCenter.
set	PUT https://{server}/api/vcenter/namespaces/instances/{namespace}	Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
update	PATCH https://{server}/api/vcenter/namespaces/instances/{namespace}	Update the namespace object. The specified configuration is applied partially and unset fields in `spec` will leave those parts of configuration as-is.

supervisor services

The supervisor_services service provides operations to set the desired state of Supervisor Services, as well as list them. Supervisor Services are extensions to the vSphere Namespace Supervisor, often provided by 3rd party vendors. They run in a highly privileged mode, and that should be considered before enabling them. This service was added in vSphere API 7.0.0.10200.

Operation	HTTP request	Description
set	PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}/supervisorservices/{serviceID}	Update the desired state for a Supervisor Service. The desired state is stored and updated in the vCenter Namespaces Supervisor Kubernetes layer. It may also be updated directly within Kubernetes, where the state is authoratively kept. Desired state is a combination of the enabled and version fields. The desired state is set and will be asynchronously remediated. This operation was added in vSphere API 7.0.0.10200.

vcenter namespaces systemregistry

The vcenter.namespaces.systemregistry API provides service to manage namespaces-related operations for the integrated container registry.

instances

The instances service provides operations to manage namespace object for an integrated container registry. In this version, an Instances is an abstraction around a Kubernetes namespace whose name prefixed with "vmware-system-registry", there is one to one mapping between a cluster and an integrated registry namespace.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/namespaces/systemregistry/instances	Create a namespace object whose name prefixed with "vmware-system-registry" for an integrated registry in the cluster.
delete	DELETE https://{server}/rest/vcenter/namespaces/systemregistry/instances/{namespace}	Delete the namespace object created for an integrated registry in the cluster.

vcenter namespaces user

The vcenter.namespaces.user API provides services to access namespaces for non-administrative users.

instances

The instances service provides operations to access namespaces for non-administrative users.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/namespaces-user/namespaces	Returns namespaces that user making the call is authorized to access.

vcenter network

The vcenter.network API provides services for managing network-related objects such as switches and port groups.

network

The Network service provides operations for manipulating a vCenter Server network.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/network	Returns information about at most 1000 visible (subject to permission checks) networks in vCenter matching the vcenter.network.filter_spec.

distributed switches

The DistributedSwitches service provides operations for manipulating a vSphere Distributed Switch (VDS). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/network/distributed-switches	Returns information about at most 1000 visible (subject to permission checks) vSphere distributed switches in vCenter matching the vcenter.network.distributed_switches.filter_spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter nsx

The vcenter.nsx API provides services for configuration of NSX capabilities on VC clusters.

vcenter nsx clusters

The vcenter.nsx.clusters API provides services for operations that can be used to assist in enabling NSX networking on a vSphere cluster.

clusters

The clusters service provides operations to configure NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/clusters/{cluster}	Returns information about NSX networking specification on a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

configuration

The configuration service provides operations to configure NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
disable	POST https://{server}/api/vcenter/nsx/clusters/{cluster}/configuration	Disables NSX networking on the hosts in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
enable	POST https://{server}/api/vcenter/nsx/clusters/{cluster}/configuration	Enables NSX networking on the hosts in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

networking status

The networking_status service provides operations to query the networking status of a vSphere cluster on which NSX networking is enabled. Networking status is comprised of the overall configuration status of the cluster, status of the vSphere Distributed Switch (VDS) which was used for the overlay network configuration of the cluster, configuration status and health status of NSX Edge node(s) in the cluster, configuration status and health status of ESXi hosts in the cluster and information about the logical router in the NSX Edge node(s). Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/clusters/{cluster}/networking-status	Returns information about the overall configuration status of the cluster, status of the VDS which was used for the overlay network configuration of the cluster, configuration status and health status of the NSX Edge node(s) in the cluster, configuration status and health status of ESXi hosts in the cluster and information about the logical router in the NSX Edge node(s). Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

status

The status service provides operations to get the status of configuration of NSX networking on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/clusters/{cluster}/status	Return the status of NSX configuration on the cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

validation

The validation service provides operations to validate a specification that can be used to enable NSX networking with transport node configuration on all the hosts in a vSphere cluster and enable NSX Edge nodes in a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check_edge_cluster_update_spec	POST https://{server}/api/vcenter/nsx/clusters/{cluster}/validation	Performs validation checks on the specification that can be used to update NSX Edge capabilities in an existing NSX Edge Cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check_enable_specs	POST https://{server}/api/vcenter/nsx/clusters/{cluster}/validation	Performs validation checks on the specification that can be used for enabling NSX networking with transport node configuration on all the hosts in a vSphere cluster and enabling NSX Edge cluster in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter nsx deployment

The vcenter.nsx.deployment API provides services for configuration of NSX capabilities on VC clusters.

compatibility

The compatibility service provides compatibility information between current vCenter server version and currently installed NSX version. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check	GET https://{server}/api/vcenter/nsx/deployment/compatibility/latest-version	Gets the latest update or patch version of the latest supported NSX binary available in my.vmware.com portal. This will be utilized by customers having the access to `my.vmware.com` portal from vCenter server. This operation requires that vCenter has internet access. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/nsx/deployment/compatibility	Gets the compatibility information between the currently installed NSX version and the current vCenter Server version. This operation is executed against data bundled in vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

configuration

The configuration service contains the information about currently deployed NSX. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/deployment/configuration	Gets the configuration details of currently installed NSX on the vCenter Server Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

install

The install service provides operations to create, query and delete an NSX appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
cancel	POST https://{server}/api/vcenter/nsx/deployment/install	Cancels the ongoing NSX installation on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/nsx/deployment/install	Gets the NSX appliance deployment status on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
start	POST https://{server}/api/vcenter/nsx/deployment/install	Starts the NSX appliance deployment on the current vCenter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
uninstall	POST https://{server}/api/vcenter/nsx/deployment/install	Uninstalls the NSX appliance deployed on the current vCenter. This API can only uninstall NSXI and cannot be used to uninstall NSXT. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

install recommendations

The install_recommendations service defines the resource requirements for various NSX appliance sizes and recommends an NSX size based on the vCenter size. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/deployment/install-recommendations	Gets the NSX appliance deployment sizes and recommended NSX size as per the vCenter size to which we want to install NSX. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

license

The license service provides operations to query, validate and apply license to the NSX Manager Appliance attached to the vCenter. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/deployment/license	Gets the NSX licensing details applied to the NSX Manager Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/nsx/deployment/license	Updates the license key on the NSX Manager Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
validate	POST https://{server}/api/vcenter/nsx/deployment/license	Validates the license key. This operation checks if the license key can be successfully applied and is a valid WCP license. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

software package

The software_package service contains operations related to staging NSX integrated binaries needed to install and manage NSX integrated functionality. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
cancel	POST https://{server}/api/vcenter/nsx/deployment/software-package	Cancel running NSX download or upload process. This would interrupt the NSX binary upload or download process and clean up the NSX binary being uploaded. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
download	POST https://{server}/api/vcenter/nsx/deployment/software-package	Download NSX binaries from the my.vmware.com portal on vCenter Server. To call this API user needs to first Authenticate, then get List of accounts, select a listed account and check its entitlement and then invoke download. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/nsx/deployment/software-package	Gets Stage operation status like MUB file staged version, staging in progress, stage percentage etc. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
upload	POST https://{server}/api/vcenter/nsx/deployment/software-package	Upload NSX binaries to vCenter server. This API would provide the URI which has to be used to upload the content. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

supported version

The supported_version service provides information about the supported NSX version for vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/deployment/supported-version	Gets the supported NSX version for a current vCenter Server. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

upgrade

The upgrade service represents all the operations of NSX Upgrade from vCenter server. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
check	POST https://{server}/api/vcenter/nsx/deployment/upgrade	Runs checks for available NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/nsx/deployment/upgrade	Gets NSX deployment information, this includes the overall upgrade status, the available release version, the last precheck run time, the current operation details and the list of clusters with their upgrade status. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
pause	POST https://{server}/api/vcenter/nsx/deployment/upgrade	Pauses already running NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
resume	POST https://{server}/api/vcenter/nsx/deployment/upgrade	Resumes already paused NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
start	POST https://{server}/api/vcenter/nsx/deployment/upgrade	Applies available NSX upgrade. This is an asynchronous call with fast return. The result of the operation can be queried by calling the get operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

upgrade status

The upgrade_status service represents the status with respect to current NSX upgrade. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/deployment/upgrade-status	Gets the information about the current NSX upgrade operation. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter nsx edge clusters

The vcenter.nsx.edge_clusters API provides services for operations that can be used to assist in enabling NSX Edge capabilities on a vSphere cluster.

edge clusters

The {@name Edge-clusters} service provides operations to configure NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/edge-clusters/{cluster}	Return information about NSX Edge cluster specification on a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	POST https://{server}/api/vcenter/nsx/edge-clusters/{cluster}	Update NSX Edge capabilities of an existing NSX Edge cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

configuration

The configuration service provides operations to set up and tear down NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
disable	POST https://{server}/api/vcenter/nsx/edge-clusters/{cluster}/configuration	Disables NSX Edge capabilities in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
enable	POST https://{server}/api/vcenter/nsx/edge-clusters/{cluster}/configuration	Enable NSX Edge capabilities in a vSphere cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

status

The status service provides operations to get the status of configuration of NSX Edge capabilities on a vSphere cluster. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/edge-clusters/{cluster}/status	Return the status of configuration of NSX Edge capabilities on the cluster. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

ip pools

The ip_pools service provides operations to read NSX IP pools used on NSX enabled vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/nsx/ip-pools/{ipPool}	Read the NSX IP pool. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/vcenter/nsx/ip-pools	Returns the list of the NSX IP pools. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

management network compatibility

The management_network_compatibility service provides operations to get compatibility information for distributed port groups (DVPG) and their associated VMKernel NICs. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/nsx/management-network-compatibility	List the distributed port groups (DVPG) and the network configuration of VMKernel NICs associated with the given `cluster` and `dv_switch`. This information will be used in populating the ManagementNetworkSpec for the enable API. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

recovery

The recovery service represents all the operations of NSXi Infrastructure Recovery for vSphere clusters. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
execute	POST https://{server}/api/vcenter/nsx/recovery	Recovers the system from the loss of WCP service and/or NSX. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
execute_status	GET https://{server}/api/vcenter/nsx/recovery/execute/status	Gets the recovery status. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	POST https://{server}/api/vcenter/nsx/recovery	Returns whether recovery is needed. If needed, then returns the type of loss that needs recovery. If recovery is not needed, then clears the recovery state to allow the WCP service to enter steady state. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter ovf

The vcenter.ovf API provides services to capture and deploy Open Virtualization Format (OVF) packages to and from the content library.

It provides the ability to deploy OVF packages from the content library with support for advanced network topologies, network services, creating virtual appliances and virtual machines in hosts, resource pools or clusters. It also provides the ability to export virtual appliances and virtual machines from hosts, resource pools or clusters as OVF packages to the content library.

capability

The capability service provides operations for retrieving information about the capabilities supported by the OVF service server.

Operation	HTTP request	Description
get	GET https://{server}/rest/com/vmware/vcenter/ovf/capability/id:{server_guid}	Returns information about the capability of the given vCenter server.

export flag

The export_flag service provides operations for retrieving information about the export flags supported by the server. Export flags can be specified in a vcenter.ovf.library_item.create_spec to customize an OVF export.

Operation

HTTP request

Description

GET https://{server}/rest/com/vmware/vcenter/ovf/export-flag

Returns information about the supported export flags by the server.

The supported flags are:

PRESERVE_MAC: Include MAC addresses for network adapters.
EXTRA_CONFIG: Include extra configuration in OVF export.

Future server versions might support additional flags.

export session

The export_session service provides operations to export a virtual machine or virtual appliance as an OVF package. The OVF package can either be downloaded using HTTP GETs or directly transferred to a content library.

The export session is represented by an info resource, which includes the current state of the transfer and also provides the list of files that can be downloaded.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vcenter/ovf/export-session	Creates a new export session for a virtual machine or virtual appliance. The state of the new export session is EXPORT_PREPARING. This operation is idempotent. Two calls with the same client token will receive the same export session object.
delete	DELETE https://{server}/rest/com/vmware/vcenter/ovf/export-session/id:{id}	Deletes (or cancels) an export session. If no export session with the specified identifier exists, this call will return with success. A client should terminate a session to free up resources on the server. An export session will automatically be reclaimed after a period of inactivity. For example, it will only remain in EXPORT_ERROR and EXPORT_COMPLETED state for a period of time.
get	GET https://{server}/rest/com/vmware/vcenter/ovf/export-session/id:{id}	Retrieves information about an export session.
preview	POST https://{server}/rest/com/vmware/vcenter/ovf/export-session?~action=preview	Do a preview of an export for a virtual machine of virtual appliance. This can be used to get an overview of the files that will need to be transferred during the actual export.
progress	POST https://{server}/rest/com/vmware/vcenter/ovf/export-session/id:{id}?~action=progress	Used by the client to set the progress of download when target is DOWNLOAD_TARGET. Should be called regularly to keep the given export session alive.

import flag

The import_flag service provides operations for retrieving information about the import flags supported by the deployment platform. Import flags can be specified in a vcenter.ovf.library_item.resource_pool_deployment_spec to customize an OVF deployment.

Operation

HTTP request

Description

GET https://{server}/rest/com/vmware/vcenter/ovf/import-flag

Returns information about the import flags supported by the deployment platform.

The supported flags are:

LAX: Lax mode parsing of the OVF descriptor.

Future server versions might support additional flags.

import session

The import_session service provides operations to import an OVF package.

OVF package data can be transferred by the server pulling them from a HTTP(S) source or a content library item, or the client can push them using HTTP(S) PUT requests.

An OVF import proceeds as follows:

Create import session: Create import session object by specifying the source type (PUSH_SOURCE, PULL_SOURCE, CONTENT_LIBRARY_SOURCE).
Wait for descriptor: Wait for the OVF descriptor and localization bundles to be available.
Query options: Querying the import session for OVF instantiation parameters.
Select parameters: Selecting instantiation parameters.
Instantiate: Initiate instantiate.
Wait for completion: Wait for completion and push files if this is a push upload.

The steps query option/select parameters can happen multiple times. For example, an OVF deployment wizard would typically query for parameters multiple times to get more specific information about possible values for instantiation parameters, as well as validating the provided values as the user progresses through the wizard.

Concurrent import of files is supported. For push import the client can push multiple files at the same time.

Operation	HTTP request	Description
create_for_resource_pool	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{resource_pool}?~action=create-for-resource-pool	Creates an import session that can instantiate an OVF package to a resource pool. This operation is idempotent. Two calls with the same client token will receive the same import session object.
delete	DELETE https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}	Deletes (or cancels) an import session. A client should terminate a session to free up resources on the server. An import session will automatically be reclaimed after a period of inactivity. For example it will only remain in IMPORT_ERROR and IMPORT_COMPLETED state for a period of time.
get	GET https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}	Retrieves information about an import session.
instantiate	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}?~action=instantiate	Instantiates the virtual machine or virtual appliance. This method is only valid to call with an import session in state IMPORT_SELECTING_OVF_PARAMS. During the execution of this method the session state will progress over IMPORT_FILE_TRANSFER and IMPORT_INSTANTIATING to IMPORT_COMPLETED. This method must be called to complete the session. After the call it is an error to call instantiate.
preview	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session?~action=preview	Do a preview of an OVF descriptor. This can be used to get an overview of the required files that need to be transferred, and basic validation result during an OVF template import. The OVF descriptor can be in plain text or compressed by gzip and followed by base64 encoding. Note that the compression must be gzip and must be encoded with base64 after compression, otherwise `InvalidArgument` exception will be thrown.
probe	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session?~action=probe
progress	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}?~action=progress	Used by the client to set the progress of disk upload when the source type is PUSH_SOURCE. Should be called regularly to keep the given export session alive.
try_instantiate	POST https://{server}/rest/com/vmware/vcenter/ovf/import-session/id:{id}?~action=try-instantiate	Returns information about the instantiation parameters that can be specified for the import session when an import session is in the IMPORT_SELECTING_OVF_PARAMS state. The instantiation parameters returned may depend on the choices specified in any instantiation parameters provided as input arguments. This method can be iteratively called with progressively more detailed instantiation parameters. The operation does not change the state of the import session. The call must supply all instantiation parameters each time. They are not remembered from one invocation to the next. This also means that the operation is naturally idempotent.

library item

The library_item service provides operations to deploy virtual machines and virtual appliances from library items containing Open Virtualization Format (OVF) packages in content library, as well as operations to create library items in content library from virtual machines and virtual appliances.

To deploy a virtual machine or a virtual appliance from a library item:

Create a vcenter.ovf.library_item.deployment_target to specify the target deployment type and target deployment designation.
Create a vcenter.ovf.library_item.resource_pool_deployment_spec to specify the parameters for the target deployment.
Use the deploy operation with the created target and parameter specifications, along with the identifier of the specified source content library item. See deploy.

To create a library item in content library from a virtual machine or virtual appliance:

Create a vcenter.ovf.library_item.deployable_identity to specify the source virtual machine or virtual appliance to be used as the OVF template source.
Create a vcenter.ovf.library_item.create_target to specify the target library and library item.
Create a vcenter.ovf.library_item.create_spec to specify the settings for the OVF package to be created.
Use the create operation with the created target and parameter specifications, along with the specified source entity. See create.

Operation	HTTP request	Description
create	POST https://{server}/rest/com/vmware/vcenter/ovf/library-item	Creates a library item in content library from a virtual machine or virtual appliance. This operation creates a library item in content library whose content is an OVF package derived from a source virtual machine or virtual appliance, using the supplied create specification. The OVF package may be stored as in a newly created library item or in an in an existing library item. For an existing library item whose content is updated by this operation, the original content is overwritten. Meta data such as name and description is not updated for the exisitng library item.
deploy	POST https://{server}/rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=deploy	Deploys an OVF package stored in content library to a newly created virtual machine or virtual appliance. This operation deploys an OVF package which is stored in the library item specified by `ovf_library_item_id`. It uses the deployment specification in `deployment_spec` to deploy the OVF package to the location specified by `target`.
filter	POST https://{server}/rest/com/vmware/vcenter/ovf/library-item/id:{ovf_library_item_id}?~action=filter	Queries an OVF package stored in content library to retrieve information to use when deploying the package. See deploy. This operation retrieves information from the descriptor of the OVF package stored in the library item specified by `ovf_library_item_id`. The information returned by the operation can be used to populate the deployment specification (see vcenter.ovf.library_item.resource_pool_deployment_spec when deploying the OVF package to the deployment target specified by `target`.

probe import session

The probe_import_session service provides operations to dry-run an import of an OVF package without having selected a target. This can be used for querying instantiation parameters such as name and EULA that are not dependent on the target. Parameters that depend on the target such as networks are omitted.

Once a target has been chosen, a new session must be created with vcenter.ovf.import_session. The probe session cannot be instantiated or altered to refer to a target.

Operation	HTTP request	Description
create_probe_import_session	POST https://{server}/rest/com/vmware/vcenter/ovf/probe-import-session?~action=create-probe-import-session	Creates a probe import session. This can be used for inspecting various instantiation parameters using try_instantiate. This operation is idempotent. Two calls with the same client token will result in the same session.
delete	DELETE https://{server}/rest/com/vmware/vcenter/ovf/probe-import-session/id:{id}	Deletes (or cancels) a probe import session. A client should terminate a session to free up resources on the server. A probe session will automatically be reclaimed after a period of inactivity. For example it will only remain in PROBE_IMPORT_ERROR state for a period of time. Deleting an already deleted session has no effect.
get	GET https://{server}/rest/com/vmware/vcenter/ovf/probe-import-session/id:{id}	Retrieves a probe import session.
try_instantiate	POST https://{server}/rest/com/vmware/vcenter/ovf/probe-import-session/id:{id}?~action=try-instantiate	When a probe import session is in the PROBE_IMPORT_SELECTING_OVF_PARAMS state, this method returns information about instantiation parameters that can be specified for the probe session. The instantiation parameters returned depend on the choices specified in the instantiation parameters provided as input arguments. This method can be iteratively called with progressively more detailed instantiation parameters. The operation does not change the state of the probe session. The call must supply all instantiation parameters each time. They are not remembered from one invocation to the next. This also means that the operation is naturally idempotent.

resource pool

The ResourcePool service provides operations for manipulating a vCenter Server resource pool.

This service does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/resource-pool	Creates a resource pool. This operation was added in vSphere API 7.0.0.0.
delete	DELETE https://{server}/rest/vcenter/resource-pool/{resource_pool}	Deletes a resource pool. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/rest/vcenter/resource-pool/{resource_pool}	Retrieves information about the resource pool indicated by `resource_pool`.
list	GET https://{server}/rest/vcenter/resource-pool	Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the vcenter.resource_pool.filter_spec.
update	PATCH https://{server}/rest/vcenter/resource-pool/{resource_pool}	Updates the configuration of a resource pool. This operation was added in vSphere API 7.0.0.0.

vcenter services

service

The service service provides operations to manage a single/set of vCenter Server services. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/services/{service}	Returns the state of a service. This operation was added in vSphere API 6.7.
list_details	GET https://{server}/rest/vcenter/services	Lists details of vCenter services. This operation was added in vSphere API 6.7.
restart	POST https://{server}/rest/vcenter/services/{service}/restart	Restarts a service. This operation was added in vSphere API 6.7.
start	POST https://{server}/rest/vcenter/services/{service}/start	Starts a service. This operation was added in vSphere API 6.7.
stop	POST https://{server}/rest/vcenter/services/{service}/stop	Stops a service. This operation was added in vSphere API 6.7.
update	PATCH https://{server}/rest/vcenter/services/{service}	Updates the properties of a service. This operation was added in vSphere API 6.7.

vcenter settings

The vcenter.settings API provides services to manage a syncable SettingsStore where configuration or settings information can be stored and retrieved. Usage beyond VMware Cloud on AWS is not supported.

vcenter settings namespaces

namespaces

The namespaces provides operations to create, read, update, and delete settings store namespaces. A namespace is a logical container that holds a group of configuration items. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/settings/namespaces	Creates a namespace. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/rest/vcenter/settings/namespaces/{namespace}	Deletes a namespace along with its associated item data. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/settings/namespaces/{namespace}	Retrieves the details of the namespace. System.Read privilege is required. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/settings/namespaces	Lists all the namespaces in Settings Service. System.Read privilege is required. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/settings/namespaces/{namespace}	Update a namespace with a changing configuration. Requires the SettingsStore.Manage privilege. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

items

The items provides operations to create, list, update, and delete configuration items that are stored in a namespace in the Settings Store of HVC. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/settings/namespaces/{namespace}/items	Returns a map of item values corresponding to the keys in the namespace. The readPrivilege defined in the namespace is checked before the operation is initiated. If keys is not passed in, the entire map of KV pairs are returned. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
put	PATCH https://{server}/rest/vcenter/settings/namespaces/{namespace}/items	Put a map of key value pairs in the namespace. This overrides any existing key/value if they already exist in the namespace. The writePrivilege defined in the namespace is checked before the operation is initiated. When the value is not passed in the map items, the item in the namespace is deleted. When an empty (0 length) String, "", is passed in as the value, the value is set to "". Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter storage

vcenter storage policies

policies

The policies service provides operations for managing the storage policies. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
check_compatibility	POST https://{server}/rest/vcenter/storage/policies/{policy}?action=check-compatibility	Returns datastore compatibility summary about a specific storage policy. This operation was added in vSphere API 6.7.
list	GET https://{server}/rest/vcenter/storage/policies	Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. This operation was added in vSphere API 6.7.

vcenter storage policies compliance

compliance

The Compliance service provides operations related to all the associated entities of given compliance statuses. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/storage/policies/entities/compliance	Returns compliance information about entities matching the filter vcenter.storage.policies.compliance.filter_spec. Entities without storage policy association are not returned. This operation was added in vSphere API 6.7.

VM

The VM structure provides operations related to query virtual machines of given compliance statuses. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/storage/policies/compliance/vm	Returns compliance information about at most 1000 virtual machines matching the filter vcenter.storage.policies.compliance.VM.filter_spec. If there are no virtual machines matching the vcenter.storage.policies.compliance.VM.filter_spec an empty List is returned. Virtual machines without storage policy association are not returned. This operation was added in vSphere API 6.7.

VM

The VM service provides operations managing the storage policy association for a virtual machine and its virtual disks. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/storage/policies/{policy}/vm	Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This operation was added in vSphere API 6.7.

vcenter svcaccountmgmt

The vcenter.svcaccountmgmt API provides Token services.

password

The password interface provides operations to manage service account passwords. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
change	POST https://{server}/rest/vcenter/svc-account-mgmt/password?action=change	Change the service account password. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
reset	POST https://{server}/rest/vcenter/svc-account-mgmt/password?action=reset	Reset the service account password. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

service account

The service_account interface provides operations to manage service accounts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/svc-account-mgmt/service-account?action=create	Create a service account with the input configuration parameters. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	POST https://{server}/rest/vcenter/svc-account-mgmt/service-account?action=delete	Delete the service account with the input name. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter system

The vcenter.system API provides services for getting system information in vCenter.

announcements

The announcements service provides operations to manage system wide announcements

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/system/announcements	Create a new announcement
delete	DELETE https://{server}/rest/vcenter/system/announcements/{announcement}	Delete an announcement
get	GET https://{server}/rest/vcenter/system/announcements/{announcement}	Return information about a specific announcements in the system.
list	GET https://{server}/rest/vcenter/system/announcements	Return information about all the announcements in the system.
set	PUT https://{server}/rest/vcenter/system/announcements/{announcement}	Set announcement properties.

vcenter system config

ceip

The ceip service provides operations to get and set the CEIP (Customer Experience Improvement Program) value. If CEIP is set to True, the customer agrees to participate in the CEIP program. Setting the CEIP value to True or False affects the whole MxN deployment. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/system-config/ceip	Get CEIP (Customer Experience Improvement Program) value. This operation was added in vSphere API 6.7.
set	PUT https://{server}/rest/vcenter/system-config/ceip	Set CEIP (Customer Experience Improvement Program) value. This operation was added in vSphere API 6.7.

deployment type

The deployment_type service provides operations to get/set the type of the appliance. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/system-config/deployment-type	Get the type of the vCenter appliance. This operation was added in vSphere API 6.7.
reconfigure	POST https://{server}/rest/vcenter/system-config/deployment-type	Reconfigure the type of the vCenter appliance. This operation was added in vSphere API 6.7.

feature state

The feature_state service provides operations to get the status of feature state switches. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/system-config/feature-state	Returns the current status of feature state switches. This operation was added in vSphere API 6.7.

vcenter system config features

tech preview

The tech_preview service provides operations to get and set the status of Tech Preview feature state switches. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/system-config/features/tech-preview	Returns the current status of all the feature switches in Tech Preview. mode. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/system-config/features/tech-preview	Sets the status to enabled/disabled for the Tech Preview feature switches present in the input key/value pairs. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

psc registration

The psc_registration service provides operations to get and set the PSC_EXTERNAL appliance a VCSA_EXTERNAL appliance is registered with. This service was added in vSphere API 6.7.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/system-config/psc-registration	Get information of the PSC that this appliance is registered with. This operation was added in vSphere API 6.7.
repoint	POST https://{server}/rest/vcenter/system-config/psc-registration	Repoint this vCenter Server appliance to a different external PSC. This operation was added in vSphere API 6.7.

vcenter tag associations

host

The host service provides operations to query tag associations that have a host identifier. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/tag-associations/host	Returns tag associations that match the specified filter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

VM

The VM service provides operations to manage tag associations that have a virtual machine identifier. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/tag-associations/vm	Returns tag associations that match the specified filter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter tagging

The vcenter.tagging API provides services for managing tags.

associations

The associations service provides operations to list tag associations. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
list	GET https://{server}/api/vcenter/tagging/associations	Returns tag associations that match the specified iteration spec. This operation was added in vSphere API 7.0.0.0.

vcenter tags

vcenter tags host

host

The host service provides operations to manage which tags can be associated with hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/rest/vcenter/tags/host/{tag}	Deletes any existing associations of this tag with hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/tags/host	Returns information about the tags that are associated with hosts on this vCenter Server, where the tags need to match vcenter.tags.host.filter_spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

associations

The associations service provides operations to manage associations of a single tag to multiple hosts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
add	POST https://{server}/rest/vcenter/tags/host/{tag}/associations?action=add	Attaches a tag to multiple hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/tags/host/{tag}/associations	Lists all hosts that have this tag attached. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove	POST https://{server}/rest/vcenter/tags/host/{tag}/associations?action=remove	Detaches a tag from multiple hosts. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter tags vm

VM

The VM service provides operations to manage which tags can be associated with virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
delete	DELETE https://{server}/rest/vcenter/tags/vm/{tag}	Deletes any existing associations of this tag with virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/tags/vm	Returns information about the tags that are associated with virtual machines on this vCenter Server, where the tags need to match vcenter.tags.VM.filter_spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

associations

The associations service provides operations to manage associations of a single tag to multiple virtual machines. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
add	POST https://{server}/rest/vcenter/tags/vm/{tag}/associations?action=add	Attaches a tag to multiple virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/tags/vm/{tag}/associations	Lists all virtual machine that have this tag attached. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
remove	POST https://{server}/rest/vcenter/tags/vm/{tag}/associations?action=remove	Detaches a tag from multiple virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter tokenservice

The vcenter.tokenservice API provides Token services.

token exchange

The token_exchange interface provides possibility to exchange between different tokens types. Implementation of "OAuth 2.0 Token Exchange" standard (https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12).

Operation	HTTP request	Description
exchange	POST https://{server}/rest/vcenter/tokenservice/token-exchange	Exchanges incoming token based on the spec and current client authorization data.

vcenter topology

The vcenter.topology API provides services to retrieve all vCenter and Platform Services Controller nodes and replication status in the topology.

vcenter topology nodes

nodes

The nodes interface provides operations to retrieve vCenter and Platform Services Controller nodes information in the topology. This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/topology/nodes/{node}	Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This operation was added in vSphere API 6.7.2.
list	GET https://{server}/rest/vcenter/topology/nodes	Returns information about all vCenter and Platform Services Controller nodes matching the vcenter.topology.nodes.filter_spec. This operation was added in vSphere API 6.7.2.

embedded

The embedded service provides operations to manage the vCenter Server node in the topology. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
decommission-task	POST https://{server}/rest/vcenter/topology/nodes/embedded/{hostname}?action=decommission&vmw-task=true	Decommission the vCenter Server node. Decommissioning a vCenter Server node from the topology is irreversible. Any workloads associated with the node will be lost. Make sure to move the workloads before decommissioning the vCenter Server node. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

replication status

The replication_status interface provides operations to retrieve replication status information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type). This service was added in vSphere API 6.7.2.

Operation	HTTP request	Description
list	GET https://{server}/rest/vcenter/topology/replication-status	Returns the replication information of vCenter and Platform Services Controller nodes of type VCSA_EMBEDDED/PSC_EXTERNAL (see vcenter.topology.nodes.info.type) matching the vcenter.topology.replication_status.filter_spec. This operation was added in vSphere API 6.7.2.

vcenter trust

The vcenter.trust API provides services to manage VcTrusts.

subscriptions

The subscriptions interface provides operations to create, update, delete and list vCenter trusts subscription. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
add	POST https://{server}/rest/vcenter/trust/subscriptions?action=add	Add a new subscription record into database. There are two possible situations for add. A. In the first case, the client is only interested in one VCTrust object and the VCTrust object has to exist in database. To make such a subscription, the client need to tell database which VCTrust object he is interested in. The GUID (VCTrust Id) field stands for that specific VCTrust and need to be specified. In this way, the client will only receive notification from that specified object changes. There is no limit on how many subscription an endpoint can add. B. In the second case, the client makes a subscription without a specified VCTrust object, which means the client is interested in every VCTrust object. Whenever the database changes (e.g add a new VCTrust, delete VCTrust, update...), the client gets notified. All the records in the database will not be deleted automatically. The only way to delete a record is to invoke delete API. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/rest/vcenter/trust/subscriptions/{subscription}?action=delete	If the client is no longer interested in the subscription, it can delete it by invoking this API and specify the subscription id. The subscription id is returned to the endpoint when it was created. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
info	GET https://{server}/rest/vcenter/trust/subscriptions/{subscription}?action=info	This API is used by client to request for detailed information of a specific susbcription. It is queried using subscription id. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/trust/subscriptions?action=list	List all the subscriptions that a client have. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/trust/subscriptions/{subscription_id}?action=update	This API is used by client to renew a subscription by extend the expiration time of its existing subscriptions. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vc trusts

The vc_trusts interface provides operations to create, modify, delete and read vCenter trusts. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/rest/vcenter/trust/vc-trusts	Creates a new trust for domain in given spec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/rest/vcenter/trust/vc-trusts/{domain}	Deletes a trust for given domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/rest/vcenter/trust/vc-trusts/{domain}	Retrieve trust for given domain. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/rest/vcenter/trust/vc-trusts	Returns summary information for each trust of the local node. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/rest/vcenter/trust/vc-trusts/{domain}	Update a trust for given domain with data in given UpdateSpec. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter trusted infrastructure

The vcenter.trusted_infrastructure API provides services that enable a Trusted Infrastructure. They are responsible for ensuring that infrastructure nodes are running trusted software and for releasing encryption keys only to trusted infrastructure nodes.

vcenter trusted infrastructure attestation

The vcenter.trusted_infrastructure.attestation API provides services for configuring Attestation Services for Trusted vCenter.

services

The services service contains information about the registered instances of the Attestation Service in vCenter. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/trusted-infrastructure/attestation/services	Registers a new Attestation Service instance in this vCenter. This operation was added in vSphere API 7.0.0.0.
delete	DELETE https://{server}/api/vcenter/trusted-infrastructure/attestation/services/{service}	Removes a registered Attestation Service instance from this vCenter. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/api/vcenter/trusted-infrastructure/attestation/services/{service}	Returns the detailed information about a registered Attestation Service instance in this vCenter. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/attestation/services	Returns detailed information about all registered Attestation Service instances in this vCenter. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure kms

The vcenter.trusted_infrastructure.kms API provides services for configuring Key Provider Services for Trusted vCenter.

services

The services service contains information about the registered instances of the Key Provider Service in vCenter. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/trusted-infrastructure/kms/services	Registers a Key Provider Service instance in this vCenter. This operation was added in vSphere API 7.0.0.0.
delete	DELETE https://{server}/api/vcenter/trusted-infrastructure/kms/services/{service}	Removes a currently registered Key Provider Service instance from this vCenter. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/api/vcenter/trusted-infrastructure/kms/services/{service}	Returns the detailed information about a registered Key Provider Service instance in this vCenter. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/kms/services	Returns basic information about all registered Key Provider Service instances in this vCenter. This operation was added in vSphere API 7.0.0.0.

principal

The principal service contains information about the certificates which sign the tokens used by vCenter for authentication. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/trusted-infrastructure/principal	Returns information about the STS used by this vCenter instance. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority clusters

The vcenter.trusted_infrastructure.trust_authority_clusters API provides the Trust Authority Components.

trust authority clusters

The trust_authority_clusters service manages all the Trust Authority Components on each Trust Authority Host in the cluster. The trust_authority_clusters service transforms a ClusterComputeResource into Trust Authority Cluster and vice versa. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}	Get the result of the last Update operation which matches the cluster id. This operation was added in vSphere API 7.0.0.0.
list	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters	Returns a list of clusters for this vCenter instance which matches the vcenter.trusted_infrastructure.trust_authority_clusters.filter_spec. This operation was added in vSphere API 7.0.0.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}	Updates the state of a cluster. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority clusters attestation

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation API provides services for configuring the Attestation Service. It attests the state of a remote infrastructure node.

vcenter trusted infrastructure trust authority clusters attestation os esx

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation.os.esx API provides the interfaces for configuring ESX host metadata.

base images

The base_images service provides operations to manage trusted instances of ESX software on a cluster level. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}	Remove a trusted ESX base image of each ESX in the cluster. This operation was added in vSphere API 7.0.0.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}	Get the trusted ESX base version details. This operation was added in vSphere API 7.0.0.0.
import_from_imgdb-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images	Import ESX metadata as a new trusted base image to each host in the cluster. Import a boot_imgdb.tgz file which contains metadata that describes a trusted ESX base image. A boot_imgdb.tgz file can be downloaded from a representative host. . This operation was added in vSphere API 7.0.0.0.
list-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images	Return a list of trusted ESX base images. This operation was added in vSphere API 7.0.0.0.

service status

The service_status service provides operations to get the Attestation Service health status. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/service-status	Return the Attestation service health in the given cluster. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority clusters attestation tpm2

The vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2 API provides services to manage remote attestation configuration for TPM trust.

ca certificates

The ca_certificates service provides operations to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This service allows the CA certificate to be registered with the Attestation Service in order to validate TPM EK certificates when presented at attestation time.

. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates	Add a new TPM CA certificate on a cluster. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}	Remove a TPM CA certificate on a cluster. This operation was added in vSphere API 7.0.0.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}	Get the TPM CA certificate details on a cluster. This operation was added in vSphere API 7.0.0.0.
list-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates	Return a list of configured TPM CA certificates on a cluster. This operation was added in vSphere API 7.0.0.0.

endorsement keys

The endorsement_keys service provides operations to manage Trusted Platform Module (TPM) Endorsement Keys (EK) on a cluster level. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys	Add a new TPM endorsement key on a cluster. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}	Remove a TPM endorsement key on a cluster. This operation was added in vSphere API 7.0.0.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}	Get the TPM endorsement key details on a cluster. This operation was added in vSphere API 7.0.0.0.
list-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys	Return a list of configured TPM endorsement keys in a cluster. This operation was added in vSphere API 7.0.0.0.

settings

The settings interface provides operations to get or update settings related to the TPM 2.0 attestation protocol behavior. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings	Return the TPM 2.0 protocol settings. This operation was added in vSphere API 7.0.0.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings	Set the TPM 2.0 protocol settings. This operation was added in vSphere API 7.0.0.0.

consumer principals

The consumer_principals service configures the token policies and STS trust necessary for the workload vCenter to query the trusted services for their status. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals	Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}	Removes the read-only policy configured on ESX for a specific principal. This operation was added in vSphere API 7.0.0.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}	Retrieve information for a specific profile. This operation was added in vSphere API 7.0.0.0.
list-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals	Lists all policies configured on a specific cluster. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority clusters kms

The vcenter.trusted_infrastructure.trust_authority_clusters.kms API provides the interfaces for configuring the Key Provider Service. It encapsulates one or more key servers and exposes Trusted Key Providers.

vcenter trusted infrastructure trust authority clusters kms providers

The vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers API provides the services for configuring the Key Providers of a Trust Authority Cluster.

providers

The providers interface provides operations to create, update and delete Key Providers that handoff to key servers. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers	Add a new Key Provider. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}	Remove a Key Provider. This operation was added in vSphere API 7.0.0.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}	Return information about a Key Provider. This operation was added in vSphere API 7.0.0.0.
list-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers	Return a list of summary of Key Providers. This operation was added in vSphere API 7.0.0.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}	Update an existing Key Provider. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority clusters kms providers client certificate

The vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.client_certificate API provides the interfaces for configuring the Client Certificate used by the Key Provider Service to authenticate against the Key Servers.

client certificate

The client_certificate interface provides operations to add and retrieve client certificate. This service was added in vSphere API 7.0.0.0.

Operation

HTTP request

Description

create-task

POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate

Generate a new self signed client certificate. Existing client certificate is overwritten. The key server will use this certificate to validate the client connection. This operation was added in vSphere API 7.0.0.0.

get-task

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate

Return the existing client certificate. This operation was added in vSphere API 7.0.0.0.

update-task

PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate

Update the client certificate.

The key server will use this certificate to validate the client connection. If a client certificate already exists, it will be replaced.

An optional private key can be specified if the certificate has already been provisioned.

. This operation was added in vSphere API 7.0.0.0.

csr

The csr interface provides operations to create a certificate signing request(CSR). This service was added in vSphere API 7.0.0.0.

Operation

HTTP request

Description

create-task

POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr

Generate a certificate signing request (CSR) for the client certificate. This overwrites any existing CSR.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

Calling the API repeatedly will result in a generating a new CSR each time.

. This operation was added in vSphere API 7.0.0.0.

get-task

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr

Get existing certificate signing request (CSR) for the client certificate.

The CSR will allow the certificate to be signed by a third party. Once the CSR is signed, certificate may be added as a client certificate.

. This operation was added in vSphere API 7.0.0.0.

credential

The credential interface provides operations to add a credential for external key management service(s). This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
set-task	PUT https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/credential	Set the key server credential. This operation was added in vSphere API 7.0.0.0.

current peer certificates

Retrieves the list of TLS certificates used by peer key servers. Those are meant for review. Following approval these certificates should be added as trusted certificates in the vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.trusted_peer_certificates service. This service was added in vSphere API 7.0.0.0.

Operation

HTTP request

Description

list-task

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/current

Return the remote server certificates.

Contacts the configured key servers and attempts to retrieve their certificates. These certificates might not yet be trusted.

. This operation was added in vSphere API 7.0.0.0.

trusted peer certificates

Provides management operations for the TLS certificates trusted for communication with peer key servers.

To obtain the currently used TLS certificates use the vcenter.trusted_infrastructure.trust_authority_clusters.kms.providers.current_peer_certificates service

. This service was added in vSphere API 7.0.0.0.

Operation

HTTP request

Description

get-task

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted

Return the list of trusted server certificates. This operation was added in vSphere API 7.0.0.0.

update-task

PATCH https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted

Update trusted server certificate(s).

The client will use these certificates to validate the server connection. The existing list of trusted certificates will be overwritten.

The client will not trust the server connection until a server certificate has been set.

. This operation was added in vSphere API 7.0.0.0.

service status

The service_status service provides operations to get the Key Provider Service health status. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/service-status	Return the Key Provider Service health in the given cluster. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trust authority hosts

The vcenter.trusted_infrastructure.trust_authority_hosts API provides services that provide information necessary to connect to the hosts running the Trust Authority Components.

attestation

The attestation service contains information necessary to connect to the hosts running Attestation Service. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/attestation/	Returns the connection info about the Attestation Service running on the specified host. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-hosts/attestation	Returns a list of the hosts running a Attestation Service matching the specified vcenter.trusted_infrastructure.trust_authority_hosts.attestation.filter_spec. This operation was added in vSphere API 7.0.0.0.

kms

The kms service contains information necessary to connect to the hosts running Key Provider Service. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/	Returns the connection info about the Key Provider Service running on the specified host. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-hosts/kms	Returns a list of the hosts running a Key Provider Service matching the specified vcenter.trusted_infrastructure.trust_authority_hosts.kms.filter_spec. This operation was added in vSphere API 7.0.0.0.

vcenter trusted infrastructure trusted clusters

The vcenter.trusted_infrastructure.trusted_clusters API provides services for configuring Trusted Clusters.

vcenter trusted infrastructure trusted clusters attestation

The vcenter.trusted_infrastructure.trusted_clusters.attestation API provides services for configuring Attestation Services for Trusted Clusters.

services

The services service manages the Attestation Service instances a Trusted Cluster is configured to use. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services	Configures the cluster to use a the given registered Attestation Service. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}	Removes the Attestation Service instance from the configuration of the given cluster. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}	Returns detailed information about the given registered Attestation Service instance that is configured for the given cluster. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services	Returns the basic information about all configured Attestation Service instances used by this cluster. This operation was added in vSphere API 7.0.0.0.

services applied config

The services_applied_config service provides information about the aggregate health of the applied Attestation Service configuration on the Trusted Clusters. The desired state of the Attestation Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The services_applied_config service is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Attestation Service configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to put the applied Attestation Service configuration into a consistent state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config	Delete the Attestation Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Attestation Service configuration from any Trusted Hosts within the given cluster. This operation was added in vSphere API 7.0.1.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config	Returns detailed information about the health of the specified Attestation Service configuration applied to the cluster with respect to the desired state. This operation was added in vSphere API 7.0.1.0.
list-task	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config	Returns basic information about the health of all Attestation Service configurations applied to the cluster with respect to the desired state. This operation was added in vSphere API 7.0.1.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config	Update the applied Attestation Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This operation was added in vSphere API 7.0.1.0.

vcenter trusted infrastructure trusted clusters kms

The vcenter.trusted_infrastructure.trusted_clusters.kms API provides services for configuring Key Provider Services for Trusted Clusters.

services

The services service manages the Key Provider Service instances a Trusted Cluster is configured to use. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
create-task	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services	Configures the cluster to use a the given registered Key Provider Service. This operation was added in vSphere API 7.0.0.0.
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}	Removes the Key Provider Service instance from the configuration of the given cluster. This operation was added in vSphere API 7.0.0.0.
get	GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}	Returns detailed information about the given Key Provider Service instance used by the given cluster. This operation was added in vSphere API 7.0.0.0.
list	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services	Returns basic information about all configured Key Provider Service instances used by this cluster. This operation was added in vSphere API 7.0.0.0.

services applied config

The services_applied_config service provides information about the aggregate health of the applied Key Provider Service configuration on the Trusted Clusters. The desired state of the Key Provider Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The services_applied_config service is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Key Provider Service configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to put the applied Key Provider Service configuration into a consistent state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config	Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster. This operation was added in vSphere API 7.0.1.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config	Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state. This operation was added in vSphere API 7.0.1.0.
list-task	POST https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config	Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state. This operation was added in vSphere API 7.0.1.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config	Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This operation was added in vSphere API 7.0.1.0.

services applied config

The services_applied_config service provides information about the aggregate health of the applied Trust Authority Component configurations on the Trusted Clusters. The desired state of the Trust Authority Component configurations is stored within vCenter, while the applied configuration is stored on the hosts in the cluster and is a copy of the desired state. The services_applied_config service is available for all clusters, not only Trusted Clusters. When an applied Trust Authority Component configuration is found outside of a Trusted Cluster it is considered an ERROR. The services_applied_config service is able to make the applied Trust Authority Component configuration consistent with the desired state when individual host configurations have diverged from the desired state. This service was added in vSphere API 7.0.1.0.

Operation	HTTP request	Description
delete-task	DELETE https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config	Delete all Trust Authority Components configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Trust Authority Component configurations from any Trusted Hosts within the given cluster. This operation was added in vSphere API 7.0.1.0.
get-task	GET https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config	Returns detailed information about the health of the applied Trust Authority Component configurations in the given cluster. This operation was added in vSphere API 7.0.1.0.
update-task	PATCH https://{server}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config	Update all applied Trust Authority Component configuration on the given cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. If the cluster is not a Trusted Cluster, the method will remove all Trust Authority Component configuration from the Trusted Hosts in the cluster, if such hosts are found. This operation was added in vSphere API 7.0.1.0.

vcenter vcha

The vcenter.vcha API provides services for deploying and monitoring a vCenter High Availability (VCHA) Cluster.

capabilities

The capabilities service provides operations to get the capabilities of a vCenter High Availability (VCHA) node. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vcha/capabilities	Gets the capabilities of the active node of a VCHA cluster. This operation was added in vSphere API 6.7.1.

vcenter vcha cluster

The vcenter.vcha.cluster API provides services for redeploying and monitoring a vCenter High Availability (VCHA) Cluster after a successful initial deployment.

cluster

The cluster service provides operations to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
deploy-task	POST https://{server}/rest/vcenter/vcha/cluster?vmw-task=true&action=deploy	Prepares, clones, and configures a VCHA cluster. This operation was added in vSphere API 6.7.1.
failover-task	POST https://{server}/rest/vcenter/vcha/cluster?vmw-task=true&action=failover	Initiates failover from the active vCenter node to the passive node. For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover. For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss. A failover is allowed only in the following cases: Cluster's mode is enabled and all cluster members are present. Cluster's mode is maintenance and all cluster members are present. . This operation was added in vSphere API 6.7.1.
get	POST https://{server}/rest/vcenter/vcha/cluster?action=get	Retrieves the status of a VCHA cluster. This operation was added in vSphere API 6.7.1.
undeploy-task	POST https://{server}/rest/vcenter/vcha/cluster?vmw-task=true&action=undeploy	Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed. If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed. . This operation was added in vSphere API 6.7.1.

active

The active service provides operations to get information related to the active vCenter High Availability (VCHA) node. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
get	POST https://{server}/rest/vcenter/vcha/cluster/active?action=get	Retrieves information about the active node of a VCHA cluster. This operation was added in vSphere API 6.7.1.

deployment type

The DeploymentType service provides operations to get the deployment type of a vCenter High Availability Cluster (VCHA Cluster). This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vcha/cluster/deployment-type	Retrieves the deployment type of a VCHA cluster. This operation was added in vSphere API 6.7.1.

mode

The Mode service provides operations to manage the operating mode of a vCenter High Availability Cluster (VCHA Cluster). This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vcha/cluster/mode	Retrieves the current mode of a VCHA cluster. This operation was added in vSphere API 6.7.1.
set-task	PUT https://{server}/rest/vcenter/vcha/cluster/mode?vmw-task=true	Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed: enabled -> disabled - Allowed only in healthy and degraded states. enabled -> maintenance - Allowed only in healthy state. disabled -> enabled - Allowed only in healthy state. maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version. maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version. All other transitions are not allowed. VCHA Cluster configuration remains intact in any of the cluster modes. . This operation was added in vSphere API 6.7.1.

passive

The passive service provides operations to validate a passive's placement configuration and redeploy the passive node in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/vcha/cluster/passive?action=check	Validates the specified passive node's placement configuration. This operation was added in vSphere API 6.7.1.
redeploy-task	POST https://{server}/rest/vcenter/vcha/cluster/passive?vmw-task=true&action=redeploy	Creates the passive node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. This operation was added in vSphere API 6.7.1.

witness

The witness service provides operations to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
check	POST https://{server}/rest/vcenter/vcha/cluster/witness?action=check	Validates the specified witness node's placement configuration. This operation was added in vSphere API 6.7.1.
redeploy-task	POST https://{server}/rest/vcenter/vcha/cluster/witness?vmw-task=true&action=redeploy	Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. This operation was added in vSphere API 6.7.1.

license

The license service provides operations to get the license of a vCenter High Availability (VCHA) feature. This service was added in vSphere API 7.0.0.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vcha/license	Gets the license of the active node of a VCHA cluster. This operation was added in vSphere API 7.0.0.1.

operations

The operations service provides operations to figure out the currently active operations and currently disabled operations in a vCenter High Availability (VCHA) cluster. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vcha/operations	Retrieves the current active and disabled operations of a VCHA cluster. This operation was added in vSphere API 6.7.1.

vc credentials

The vc_credentials service provides operations to validate the credentials of the management vCenter of a vCenter High Availability (VCHA) node. This service was added in vSphere API 6.7.1.

Operation	HTTP request	Description
validate	POST https://{server}/rest/vcenter/vcha/vc-credentials?action=validate	Validates the credentials of the management vCenter server of the active node of a VCHA cluster. This operation was added in vSphere API 6.7.1.

vcenter vm

The vcenter.vm API provides services for managing virtual machines.

VM

The VM service provides operations for managing the lifecycle of a virtual machine.

Operation	HTTP request	Description
clone	POST https://{server}/rest/vcenter/vm?action=clone	Creates a virtual machine from an existing virtual machine. . This operation was added in vSphere API 7.0.0.0.
clone-task	POST https://{server}/rest/vcenter/vm?vmw-task=true&action=clone	Creates a virtual machine from an existing virtual machine. . This operation was added in vSphere API 7.0.0.0.
create	POST https://{server}/rest/vcenter/vm	Creates a virtual machine.
delete	DELETE https://{server}/rest/vcenter/vm/{vm}	Deletes a virtual machine.
get	GET https://{server}/rest/vcenter/vm/{vm}	Returns information about a virtual machine.
instant_clone	POST https://{server}/rest/vcenter/vm?action=instant-clone	Create an instant clone of an existing virtual machine. This operation was added in vSphere API 6.7.1.
list	GET https://{server}/rest/vcenter/vm	Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the vcenter.VM.filter_spec.
register	POST https://{server}/rest/vcenter/vm?action=register	Creates a virtual machine from existing virtual machine files on storage. This operation was added in vSphere API 6.8.7.
relocate	POST https://{server}/rest/vcenter/vm/{vm}?action=relocate	Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. . This operation was added in vSphere API 7.0.0.0.
relocate-task	POST https://{server}/rest/vcenter/vm/{vm}?vmw-task=true&action=relocate	Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks. . This operation was added in vSphere API 7.0.0.0.
unregister	POST https://{server}/rest/vcenter/vm/{vm}?action=unregister	Removes the virtual machine corresponding to `vm` from the vCenter inventory without removing any of the virtual machine's files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. This operation was added in vSphere API 6.8.7.

vcenter vm compute

The vcenter.vm.compute API provides services for quering the status of compute policies on virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

policies

The policies service provides operations to query the status of policies on virtual machines in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This service is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Operation	HTTP request	Description
get	GET https://{server}/api/vcenter/vm/{vm}/compute/policies/{policy}	Returns information about the compliance of a virtual machine with a compute policy in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

vcenter vm console

The vcenter.vm.console API provides services for managing Virtual Machine Consoles.

tickets

The tickets service provides operations for managing the virtual machine console tickets. This service was added in vSphere API 7.0.0.2.

Operation

HTTP request

Description

POST https://{server}/rest/vcenter/vm/{vm}/console/tickets

Creates a virtual machine console ticket of a given ticket type. The created ticket is a one time use URI. The validity of the ticket is 30 minutes, if not used with in the time frame the ticket expires.

The VMRC ticket contains the IP address or the DNS resolvable name of the vCenter server. This ticket requires installation of VMware Workstation, VMware Fusion or VMRC to be installed on the machine where the ticket has to be opened. This ticket can be acquired even when the VM is turned off.

The WEBMKS ticket contains the IP address of the DNS resolvable name of the ESX server. This ticket requires user to embed this ticket in a HTML page using VMware HTML Console SDK - https://www.vmware.com/support/developer/html-console This ticket can be acquired only when the VM is turned on.

. This operation was added in vSphere API 7.0.0.2.

vcenter vm data sets

The vcenter.vm.data_sets API provides services for manipulating entries in data sets.

data sets

The data_sets service provides operations for sharing information between a virtual machine and its guest operating system.

Data set support requires the the virtual machine be at virtual hardware version XXX or later.

Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/vm/{vm}/data-sets	Creates a new data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	DELETE https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Delete a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Returns information describing a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/vcenter/vm/{vm}/data-sets	Lists the data sets of a virtual machine. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Modifies the attributes of a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

entries

Operation	HTTP request	Description
delete	DELETE https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}	Deletes an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete_multiple	POST https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Deletes multiple entries from a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	GET https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}	Gets the value of an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get_multiple	POST https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Gets the value of multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	GET https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Lists all entry keys in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}	Sets an entry in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set_multiple	POST https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Sets multiple entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	PATCH https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}	Modifies entries in a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter vm guest

The vcenter.vm.guest API provides services for dealing with the guest operating system. This includes information about the state of local file systems and network interfaces and operations to manipulate the guest file system and processes.

customization

The customization service provides operations to apply a customization specification to a virtual machine. This service was added in vSphere API 7.0.0.0.

Operation	HTTP request	Description
get	GET https://{server}/rest/vcenter/vm/{vm}/guest/customization	Returns the status of the customization operation that has been applied for the virtual machine in `vm`. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
set	PUT https://{server}/rest/vcenter/vm/{vm}/guest/customization	Applies a customization specification in `spec` on the virtual machine in `vm`. This operation only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If `spec` has unset values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and `spec` has valid content, then the existing customization setting will be overwritten with the new settings. This operation was added in vSphere API 7.0.0.0.

environment

The environment service provides operations to manage environment variables in the guest operating system. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation

HTTP request

Description

POST https://{server}/rest/vcenter/vm/{vm}/guest/environment/{name}?action=get

Reads a single environment variable from the guest operating system.

If the authentication uses vcenter.vm.guest.credentials.interactive_session, then the environment being read will be that of the user logged into the desktop. Otherwise it's the environment of the system user.

. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

POST https://{server}/rest/vcenter/vm/{vm}/guest/environment?action=list

Reads a list of environment variables from the guest operating system.

. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

vcenter vm guest filesystem

The vcenter.vm.guest.filesystem API provides services for dealing with the filesystem of the guest operating system.

directories

The directories service provides operations to manage directories in the guest filesystem. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/directories	Creates a directory in the guest operating system. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
create_temporary	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/directories	Creates a temporary directory. Creates a new unique temporary directory for the user to use as needed. The guest operating system may clean up the directory after a guest specific amount of time if `parent_path` is not set, or the user can remove the directory when no longer needed. The new directory name will be created in a guest-specific format using `prefix`, a guest generated string and `suffix` in `parent_path`. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/directories	Deletes a directory in the guest operating system. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
move	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/directories	Renames a directory in the guest. Renames the directory, or copies and deletes the old contents as required by the underlying filsystem. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

files

The files service provides operations to manage the files in the guest filesystem. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation	HTTP request	Description
create_temporary	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files	Creates a temporary file. Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed. The new file name will be created in a guest-specific format using `prefix`, a guest generated string and `suffix` in `parent_path`. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
delete	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files/{path}	Deletes a file in the guest operating system . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
get	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files/{path}	Returns information about a file or directory in the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
list	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files	Returns information about files and directories in the guest. Files are returned in operating system-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
move	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files	Renames a file in the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
update	POST https://{server}/api/vcenter/vm/{vm}/guest/filesystem/files	Changes the file attributes of a specified file or directory inside the guest. . Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

transfers

The transfers service provides operations to copy files into and out of the guest file system. Warning: This service is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Operation

HTTP request

Description