For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting started

Applications communicate with Parallels RAS by sending HTTP or HTTPS requests. Parallels RAS answers with a JSON file in a response to every HTTP request.

All HTTP requests that you will use to retrieve and manage Parallels RAS resources have the following base structure:

https://<API-host>/api/<URI>

The parameters in the above URL are:

  • <API-host> is the IP address or FQDN of the server on which the RAS Web Administration Service is installed.

  • <URI> is a path to a REST resource that you would like to work with.