VMware Workstation Pro REST API allow you to interact programmatically with the core VMware hypervisor and virtual machines.

Overview of Workstation Pro REST API

You can send standard GET, PUT, POST, and DELETE requests through HTTP and HTTPS to control configuration and deployment options. For example, you can use VMware Workstation Pro REST API to perform clone and power operations. You can perform network-related operations, such as to create and update virtual NIC configurations and to retrieve IP addresses from the virtual machine. You can also configure shared folders. Response payloads are delivered in JSON format.

Workstation Pro REST API Considerations

Keep the following considerations in mind when using the Workstation Pro REST API.

  • VMware Workstation Pro REST API are available only for Workstation Pro.
  • The Workstation Pro REST API service depends on the vmrest process.
  • The vmrest service runs as the user who starts it. For example, on Windows hosts, as administrator, you can use a terminal window to start the vmrest service. On Linux hosts, as the root user, you can use the sudo vmrest command.