# Get Parallels Client Version (GetVersion)

The **GetVersion** command allows to determine on the web server side which Parallels Client version is installed on a user device, or if the Parallels Client is installed at all. If Parallels Client is an older version or not installed on a device, you can display a message to the user with a link from which they can download and install the correct version of Parallels Client.

The command works as follows:

1. A user opens a custom scheme URL with the **GetVersion** command in it.
2. The URL starts Parallels Client which receives the parameters contained in the URL, including server name, port number, the web portal session ID, and the path to which Parallels Client needs to connect to pass its version information back to the web portal.
3. The Parallels Client uses the received information and connects to the web portal using the specified path with the version information appended to it.
4. The web portal parses the received data and evaluates the Parallels Client version number. If the request times out (no response is received from Parallels Client), it means that Parallels Client is not installed on the user device.

The following table describes the **GetVersion** command options:

| Key         | Datatype | Value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Command     | String   | The name of the command to execute. In this instance, it's "GetVersion".                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Server      | String   | The server on which the web portal is hosted. Server can be specified by IP address or its local name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Port        | Int      | The port number of the web portal                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Session     | String   | The web portal Session ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Secure      | Boolean  | The SSL boolean value.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| Path        | String   | <p>The path to which Parallels Client needs to connect in order to pass the version information.</p><p>The OS type and the Parallels Client version info need to be specified with the path:</p><p><strong>OS:</strong></p><ul><li><strong>Key:</strong> os</li><li><strong>Type:</strong> Int</li><li><strong>Value:</strong> 0 (Windows); 1 (Linux); 2 (macOS); 4 (Android); 5 (iOS).</li></ul><p><strong>Version:</strong></p><ul><li><strong>Key:</strong> version</li><li><strong>Type:</strong> String</li><li><strong>Value:</strong> The Parallels Client version. This needs to be URL encoded.</li></ul> |
| RequestPage | String   | <p>The exact path of the current web portal page from where the URL was opened.</p><p>This is used in iOS, so that the iOS client can redirect the user back to the RAS Web Portal page.</p>                                                                                                                                                                                                                                                                                                                                                                                                                       |

## **URL example**

{% code overflow="wrap" %}

```
tuxclient:///?Command=GetVersion&Server=my.server.testing&Port=80&Session=adm2dpjq3jomvk45mzktuy45&Secure=NO&Path=%2fmywebportal%2fTuxClientDetection.aspx%3fapp%3d2XClient%26installed%3d1&RequestPage=http://my.server.testing/mywebportal/Logon.aspx
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-client-integration-guide/parallels-client-url-scheme/commands-and-options/get-parallels-client-version-getversion.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.