Skip to content

VMware Workstation REST API

The VMware Workstation REST API allows users to interact with VMware Workstation Pro programmatically. The service is managed via the vmrest.exe utility located in the VMware Workstation installation directory (typically C:\Program Files (x86)\VMware\VMware Workstation).^[600-developer-tools-vmware-workstation-pro-rest-api-service.md]

Configuration and Authentication

To utilize the API, credentials must be configured using the -C flag.^[600-developer-tools-vmware-workstation-pro-rest-api-service.md] This process involves specifying a username and setting a password.^[600-developer-tools-vmware-workstation-pro-rest-api-service.md] The utility provides feedback during this process, confirming when credentials have been updated successfully.^[600-developer-tools-vmware-workstation-pro-rest-api-service.md]

Starting the Service

Once configured, the API service is activated by executing the vmrest command in a terminal window without arguments.^[600-developer-tools-vmware-workstation-pro-rest-api-service.md] This action starts the HTTP service, allowing the host to receive API requests.^[600-developer-tools-vmware-workstation-pro-rest-api-service.md]

Version Information

The implementation of the REST API is provided by version 1.2.1 of the tool (specifically build-17801498).^[600-developer-tools-vmware-workstation-pro-rest-api-service.md]

  • [[REST API]]
  • [[Virtualization]]

Sources

^[600-developer-tools-vmware-workstation-pro-rest-api-service.md]