Developer Documentation

REST API Operations Index

All available Appliance REST API 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).
DCUI
get Get DCUI
Get enabled state of Direct Console User Interface (DCUI TTY2).
put Set DCUI
Set enabled state of Direct Console User Interface (DCUI TTY2).
Shell
get Get Shell
Get enabled state of BASH, that is, access to BASH from within the controlled CLI.
put Set Shell
Set enabled state of BASH, that is, access to BASH from within the controlled CLI.
SSH
get Get SSH
Get enabled state of the SSH-based controlled CLI.
put Set SSH
Set enabled state of the SSH-based controlled CLI.

Appliance

Health
get Messages Health
Get health messages.
Local Accounts
get List Local Accounts
Get a list of the local user accounts.
get Get Local Accounts
Get the local user account information.
put Set Local Accounts
Set local user account properties.
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.
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 Task Networking
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.
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.
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 Task Configs
Imports the desired profile specification.
post Validate Task Configs
Validates the desired profile specification.

Local Accounts

Policy
get Get Policy
Get the global password policy.
put Set Policy
Set the global password policy.

Logging

Forwarding
put Set Forwarding
Sets the configuration for forwarding log messages to remote log servers.
get Get Forwarding
Returns the configuration for forwarding log messages to remote logging 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
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).
get Get No Proxy
Returns servers for which no proxy configuration will be applied.
Proxy
get List Proxy
Gets proxy configuration for all configured protocols.
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.
get Get Proxy
Gets the 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
get List DNS Domains
Get list of DNS search domains.
put Set DNS Domains
Set DNS search domains.
post Add DNS Domains
Add domain to 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
put Set Interfaces IPv6
Set IPv6 network configuration for specific interface.
get Get Interfaces IPv6
Get 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
get List Backup Job
Get list of backup jobs
post Create Backup Job
Initiate backup.
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
delete Delete Backup Schedules
Deletes an existing schedule
get Get Backup Schedules
Returns an existing schedule information based on id
post Create Backup Schedules
Creates a schedule
post Run Backup Schedules
Initiate backup with the specified schedule
put Update Backup Schedules
Updates a schedule
Backup System Name
get 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
get List Backup System Name Archive
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.
get Get Backup System Name Archive
Returns the information for backup corresponding to given backup location and system name.
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

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.
Time Timezone
get Get Time Timezone
Get time zone.
put Set Time Timezone
Set time zone.

Update

Pending
get List Pending
Checks if new updates are available.
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

vMon

Service
get List Details Service
Lists details of services managed by vMon.
get Get Service
Returns the state of a service.
patch Update Service
Updates the properties of a service.
post Restart Service
Restarts a service
post Start Service
Starts a service
post Stop Service
Stops a service
Feedback

Was this page helpful?