Get VM Console URL

    • POST /api/marketplace-resources/<resource_uuid>/actions/get_console_url/ - Get the console URL for a VM.

      This endpoint retrieves a URL that you can use to access the console of the specified virtual machine. This allows you to interact with the VM directly, even if it's not accessible via SSH. You'll need the resource_uuid of the VM, which you can obtain from the "List VMs" endpoint (3.2.2).

      Notes:

      • The console URL might have a limited validity period.
      • The type of console access (e.g., SPICE, VNC) may vary depending on the VM offering and hypervisor.

      Request Example:

      POST [https://api.wayscloud.services/api/marketplace-resources/vm_resource_uuid/actions/get_console_url/](https://www.google.com/search?q=https://api.wayscloud.services/api/marketplace-resources/vm_resource_uuid/actions/get_console_url/)
      Authorization: Token <your_api_token>

      Response Example:

      {
        "console_url": "[https://console.wayscloud.services/vm/vm_resource_uuid/console](https://www.google.com/search?q=https://console.wayscloud.services/vm/vm_resource_uuid/console)" 
      }

      Status Codes:

      • 200 OK: The console URL was successfully retrieved.
      • 401 Unauthorized: The user making the request is not authorized.
      • 404 Not Found: The specified VM resource_uuid does not exist.
      • 409 Conflict: The VM console is not currently accessible (e.g., the VM is not running).
    Published