Appliance REST APIs Operations Index
All available Appliance REST APIs Operations
Access
Consolecli
GET
Get Access Consolecli
Get enabled state of the console-based controlled CLI (TTY1).
PUT
Set Access Consolecli
Set enabled state of the console-based controlled CLI (TTY1).
Dcui
GET
Get Access Dcui
Get enabled state of Direct Console User Interface (DCUI TTY2).
PUT
Set Access Dcui
Set enabled state of Direct Console User Interface (DCUI TTY2).
Appliance
Health Check Settings
GET
Get Health Settings
Get health settings for vCenter Server.
PATCH
Update Health Settings
Set health settings based on provided healthSpec
Local Accounts
POST
Create Local Accounts
Create a new local user account.
GET
List Local Accounts
Get a list of the local user accounts.
DELETE
Delete Username Local Accounts
Delete a local user account.
GET
Get Username Local Accounts
Get the local user account information.
PUT
Set Username Local Accounts
Set local user account properties.
PATCH
Update Username Local Accounts
Update selected fields in local user account properties.
Monitoring
GET
Get Stat Id Monitoring
Get monitored item info
GET
List Monitoring
Get monitored items list
GET
Get Monitoring Query
Get monitoring data.
Networking
POST
Change Networking Async
Changes the Hostname/IP of the management network of vCenter appliance. The Hostname/IP change invokes the PNID change process which involves LDAP entry modification, updating registry entries, configuration files modification and network configuration changes. vCenter server is expected to be down for few minutes during these changes
GET
Get Networking
Get Networking information for all configured interfaces.
PATCH
Update Networking
Enable or Disable ipv6 on all interfaces
POST
Reset Networking
Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
Ntp
GET
Get 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.
PUT
Set 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.
POST
Test Ntp
Test the connection to a list of ntp servers.
Services
GET
Get Service
Returns the state of a service.
GET
List Services
Lists details of vCenter services.
POST
Restart Service
Restarts a service
POST
Start Service
Starts a service
POST
Stop Service
Stops a service
Shutdown
POST
Cancel Shutdown
Cancel pending shutdown action.
GET
Get Shutdown
Get details about the pending shutdown action.
POST
Poweroff Shutdown
Power off the appliance.
POST
Reboot Shutdown
Reboot the appliance.
Support Bundle
POST
Create Support Bundle Async
Create a support bundle.
DELETE
Delete Id Support Bundle
Deletes the support bundle.
GET
List Support Bundle
Get list of support-bundles generated.
Health
Databasestorage
GET
Get Health Database Storage
Get database storage health.
Infraprofile
Configs
POST
Export Infraprofile Configs
Exports the desired profile specification. if you do not have all of the privileges described as follows: - Operation execution requires Infraprofile.Read.
POST
Import Infraprofile Configs Async
Imports the desired profile specification.
GET
List Infraprofile Configs
List all the profiles which are registered. if you do not have all of the privileges described as follows: - Operation execution requires Infraprofile.Read.
POST
Validate Infraprofile Configs Async
Validates the desired profile specification.
Local Accounts
Logging
Forwarding
GET
Get Logging Forwarding
Returns the configuration for forwarding log messages to remote logging servers.
PUT
Set Logging Forwarding
Sets the configuration for forwarding log messages to remote log servers.
POST
Test Logging Forwarding
Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server."
Networking
Interfaces
GET
Get Interface Name Networking
Get information about a particular network interface.
GET
List Networking Interfaces
Get list of available network interfaces, including those that are not yet configured.
No Proxy
GET
Get Networking Noproxy
Returns servers for which no proxy configuration will be applied.
PUT
Set 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).
Proxy
DELETE
Delete Protocol Networking Proxy
Deletes a proxy configuration for a specific protocol.
GET
Get Protocol Networking Proxy
Gets the proxy configuration for a specific protocol.
PUT
Set Protocol Networking Proxy
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.
GET
List Networking Proxy
Gets proxy configuration for all configured protocols.
POST
Test Protocol Proxy
Tests a proxy configuration by testing the connection to the proxy server and test host.
Dns Domains
POST
Create Networking Dns Domains
Add domain to DNS search domains.
GET
List Networking Dns Domains
Get list of DNS search domains.
PUT
Set Networking Dns Domains
Set DNS search domains.
Dns Hostname
GET
Get Networking Dns Hostname
Get the Fully Qualified Doman Name.
PUT
Set Networking Dns Hostname
Set the Fully Qualified Domain Name.
POST
Test Dns Hostname
Test the Fully Qualified Domain Name.
Dns Servers
POST
Create Networking Dns Servers
Add a DNS server. This method fails if mode argument is "dhcp"
GET
Get Networking Dns Servers
Get DNS server configuration.
PUT
Set Networking Dns Servers
Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced.
POST
Test Dns Servers
Test if dns servers are reachable.
Firewall Inbound
GET
Get 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.
PUT
Set 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: AddressPrefixInterface NamePolicy 10.112.0.10*REJECT 10.112.0.10nic0ACCEPT 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.
Recovery
Backup Job
POST
Cancel Id Job
Cancel the backup job.
POST
Create Recovery Backup Job
Initiate backup.
GET
List Recovery Backup Job
Get list of backup jobs
GET
Get Id Backup Job
See backup job progress/result.
Backup Parts
GET
Get Id Backup Parts
Gets the size (in MB) of the part.
GET
List Recovery Backup Parts
Gets a list of the backup parts.
Backup Schedules
POST
Create Recovery Backup Schedules
Creates a schedule
GET
List Recovery Backup Schedules
Returns a list of existing schedules with details
DELETE
Delete Schedule Backup
Deletes an existing schedule
GET
Get Schedule Backup
Returns an existing schedule information based on id
PATCH
Update Schedule Backup
Updates a schedule
POST
Run Schedule
Initiate backup with the specified schedule
Backup System Name
POST
List Backup System Name
Returns a list of system names for which backup archives exist under locSpec.
Backup Job Details
GET
List Backup Job Details
Returns detailed information about the current and historical backup jobs.
Backup System Name Archive
POST
Get System Name Archive
Returns the information for backup corresponding to given backup location and system name.
POST
List System Name Archives
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.
Support Bundle
System
Storage
GET
List System Storage
Get disk to partition mapping.
POST
Resize System Storage
Resize all partitions to 100 percent of disk size.
POST
Resize Ex System Storage
Resize all partitions to 100 percent of disk size.
Tls
Profiles
GET
Get Profile Tls
Gets the TLS parameters of a particular profile.
GET
List Tls Profiles
Gets the list of all the available standard TLS Profiles and their configuration.
Manual Parameters Global
GET
Get Tls Manual Parameters Global
Gets the current custom/manual global TLS parameters configured in the appliance.
Profiles Global
GET
Get Tls Profiles Global
Gets the name of the current TLS Profile configured globally.
PUT
Set Profiles Global Async
Sets any one of the standard profiles globally in the appliance. 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. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation.
Update
Pending
GET
Get Version Update Pending
Gets update information
POST
Install Version Pending
Starts operation of installing the appliance update. Will fail is the update is not staged
GET
List Update Pending
Checks if there are any eligible updates.
GET
Get Version Pending Components
List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it.
POST
Precheck Version Pending
Runs update precheck
POST
Rollback Update Pending
Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter. Caution: This operation will perform a reboot of appliance.
POST
Stage Version Pending
Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL
POST
Stage And Install Version Pending
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
POST
Validate Version Pending
Validates the user provided data before the update installation.
Vcenter Settings V1
Config
POST
Apply Desired State V1 Config Async
Apply the specified DesiredState spec to the vCenter. 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 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.
POST
Check Desired State V1 Config Async
Validate (Check) the specified DesiredState spec containing configurations, and verify if it can be applied to the vCenter. 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 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.
POST
Create 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. if you do not have all of the privileges described as follows: - Operation execution requires Infraprofile.Write.
DELETE
Delete 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. if you do not have all of the privileges described as follows: - Operation execution requires Infraprofile.Write.
GET
Get 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. if you do not have all of the privileges described as follows: - Operation execution requires Infraprofile.Read.
POST
Scan Desired State V1 Config Async
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.
POST
Scan Version Config Async
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.
Vmon
Service