Appliance REST APIs Operations Index
All available Appliance REST APIs Operations.
Access
Consolecli
get |
Get Consolecli
Get enabled state of the console-based controlled CLI (TTY1). |
put |
Set Consolecli
Set enabled state of the console-based controlled CLI (TTY1). |
Appliance
Health
get |
Messages Health
Get health messages. |
Health Check Settings
get |
Get Health Check Settings
Get health settings for vCenter Server. |
patch |
Update Health Check Settings
Set health settings based on provided healthSpec |
Local Accounts
get |
List Local Accounts
Get a list of the local user accounts. |
post |
Create Local Accounts
Create a new local user account. |
patch |
Update Local Accounts
Update selected fields in local user account properties. |
delete |
Delete Local Accounts
Delete a local user account. |
get |
Get Local Accounts
Get the local user account information. |
put |
Set Local Accounts
Set local user account properties. |
Monitoring
get |
List Monitoring
Get monitored items list |
get |
Query Monitoring
Get monitoring data. |
get |
Get Monitoring
Get monitored item info |
Networking
get |
Get Networking
Get Networking information for all configured interfaces. |
patch |
Update Networking
Enable or Disable ipv6 on all interfaces |
post |
Change Networking Task
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 |
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. |
Recovery
get |
Get Recovery
Gets the properties of the appliance Recovery subsystem. |
Services
get |
List Services
Lists details of vCenter services. |
get |
Get Services
Returns the state of a service. |
post |
Restart Services
Restarts a service |
post |
Start Services
Starts a service |
post |
Stop Services
Stops a service |
Shutdown
get |
Get Shutdown
Get details about the pending shutdown action. |
post |
Cancel Shutdown
Cancel pending shutdown action. |
post |
Poweroff Shutdown
Power off the appliance. |
post |
Reboot Shutdown
Reboot the appliance. |
Support Bundle
get |
List Support Bundle
Get list of support-bundles generated. |
post |
Create Support Bundle Task
Create a support bundle. |
Timesync
get |
Get Timesync
Get time synchronization mode. |
put |
Set Timesync
Set time synchronization mode. |
Update
get |
Get Update
Gets the current status of the appliance update. |
post |
Cancel Update
Request the cancellation the update operation that is currently in progress. |
Health
Applmgmt
get |
Get Applmgmt
Get health status of applmgmt services. |
Database
get |
Get Database
Returns the health status of the database. |
Databasestorage
get |
Get Databasestorage
Get database storage health. |
Load
get |
Get Load
Get load health. |
Mem
get |
Get Mem
Get memory health. |
Softwarepackages
get |
Get Softwarepackages
Get information on available software updates available in the remote vSphere Update Manager repository. Red indicates that security updates are available. Orange indicates that non-security updates are available. Green indicates that there are no updates available. Gray indicates that there was an error retreiving information on software updates. |
Storage
get |
Get Storage
Get storage health. |
Swap
get |
Get Swap
Get swap health. |
System
get |
Get System
Get overall health of system. |
get |
Lastcheck System
Get last check timestamp of the health of the system. |
Infraprofile
Configs
get |
List Configs
List all the profiles which are registered. |
post |
Export Configs
Exports the desired profile specification. |
post |
Import Profile Configs Task
Imports the desired profile specification. |
post |
Validate Configs Task
Validates the desired profile specification. |
Local Accounts
Policy
put |
Set Policy
Set the global password policy. |
get |
Get Policy
Get the global password policy. |
Logging
Forwarding
get |
Get Forwarding
Returns the configuration for forwarding log messages to remote logging servers. |
put |
Set Forwarding
Sets the configuration for forwarding log messages to remote log servers. |
post |
Test 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 |
List Interfaces
Get list of available network interfaces, including those that are not yet configured. |
get |
Get Interfaces
Get information about a particular network interface. |
No Proxy
get |
Get No Proxy
Returns servers for which no proxy configuration will be applied. |
put |
Set No Proxy
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
get |
List Proxy
Gets proxy configuration for all configured protocols. |
get |
Get Proxy
Gets the proxy configuration for a specific protocol. |
put |
Set 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. |
delete |
Delete Proxy
Deletes a proxy configuration for a specific protocol. |
post |
Test Proxy
Tests a proxy configuration by testing the connection to the proxy server and test host. |
DNS Domains
put |
Set DNS Domains
Set DNS search domains. |
post |
Add DNS Domains
Add domain to DNS search domains. |
get |
List DNS Domains
Get list of DNS search domains. |
DNS Hostname
get |
Get DNS Hostname
Get the Fully Qualified Doman Name. |
put |
Set DNS Hostname
Set the Fully Qualified Domain Name. |
post |
Test DNS Hostname
Test the Fully Qualified Domain Name. |
DNS Servers
get |
Get DNS Servers
Get DNS server configuration. |
put |
Set DNS Servers
Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced. |
post |
Add DNS Servers
Add a DNS server. This method fails if mode argument is "dhcp" |
post |
Test DNS Servers
Test if dns servers are reachable. |
Firewall Inbound
get |
Get 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 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: [dropped table ] 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. |
Interfaces IPv4
get |
Get Interfaces IPv4
Get IPv4 network configuration for specific NIC. |
put |
Set Interfaces IPv4
Set IPv4 network configuration for specific network interface. |
Interfaces IPv6
get |
Get Interfaces IPv6
Get IPv6 network configuration for specific interface. |
put |
Set Interfaces IPv6
Set IPv6 network configuration for specific interface. |
Recovery
Backup
post |
Validate Backup
Check for backup errors without starting backup. |
Restore
post |
Validate Restore
Get metadata before restore |
Backup Job
post |
Create Backup Job
Initiate backup. |
get |
List Backup Job
Get list of backup jobs |
get |
Get Backup Job
See backup job progress/result. |
post |
Cancel Backup Job
Cancel the backup job. |
Backup Parts
get |
List Backup Parts
Gets a list of the backup parts. |
get |
Get Backup Parts
Gets the size (in MB) of the part. |
Backup Schedules
get |
List Backup Schedules
Returns a list of existing schedules with details |
post |
Create Backup Schedules
Creates a schedule |
patch |
Update Backup Schedules
Updates a schedule |
delete |
Delete Backup Schedules
Deletes an existing schedule |
get |
Get Backup Schedules
Returns an existing schedule information based on id |
post |
Run Backup Schedules
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 Backup System Name Archive
Returns the information for backup corresponding to given backup location and system name. |
post |
List Backup System Name Archive
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec. |
Reconciliation Job
get |
Get Reconciliation Job
Get reconciliation job progress/result. |
post |
Create Reconciliation Job
Initiate reconciliation. |
Restore Job
get |
Get Restore Job
See restore job progress/result. |
post |
Create Restore Job
Initiate restore. |
post |
Cancel Restore Job
Cancel the restore job |
Support Bundle
Components
get |
Get 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. |
System
Storage
get |
List Storage
Get disk to partition mapping. |
post |
Resize Storage
Resize all partitions to 100 percent of disk size. |
post |
Resize Ex Storage
Resize all partitions to 100 percent of disk size. |
Time
get |
Get Time
Get system time. |
Uptime
get |
Get Uptime
Get the system uptime. |
Version
get |
Get Version
Get the version. |
Security Global Fips
get |
Get Security Global Fips
Get current appliance FIPS settings. |
put |
Update Security Global Fips
Enable/Disable Global FIPS mode for the appliance. Caution: Changing the value of this setting will reboot the Appliance. |
Time Timezone
get |
Get Time Timezone
Get time zone. |
put |
Set Time Timezone
Set time zone. |
Update
Pending
get |
List Pending
Checks if there are any eligible updates. |
get |
Get Pending
Gets update information |
post |
Install Pending
Starts operation of installing the appliance update. Will fail is the update is not staged |
post |
Precheck Pending
Runs update precheck |
post |
Stage Pending
Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL |
post |
Stage And Install 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 Pending
Validates the user provided data before the update installation. |
Policy
get |
Get Policy
Gets the automatic update checking and staging policy. |
put |
Set Policy
Sets the automatic update checking and staging policy. |
Staged
get |
Get Staged
Gets the current status of the staged update |
delete |
Delete Staged
Deletes the staged update |
vCenter
Settings V1 Config
get |
Get 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. |
post |
Create 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 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. |
post |
Scan Settings V1 Config Task
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. |
post |
Apply Desired State Settings V1 Config Task
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 Settings V1 Config Task
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 |
Scan Desired State Settings V1 Config Task
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. |
Settings V1 Config Current
get |
Get 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. |