APIv2

$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession
# Login to the Workspace
$login_params = @{
    username='...';
    password='...';
    domain='...';
} | ConvertTo-Json
$login_url = 'https://demo-psw.parallels.com/api/v2/sessions/'
Invoke-RestMethod -Method 'post' $login_url -Body $login_params `
    -WebSession $session -ContentType 'application/json'

# Extract csrftoken from cookie and set the x-csrftoken header for future requests
$csrftoken = $session.Cookies.GetCookies($login_url)['csrftoken'].Value
$session.Headers.Add('x-csrftoken', $csrftoken)

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

actions

list

GET /api/v2/actions/

Lists the available action methods.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/actions/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

dig

POST /api/v2/actions/dig/

Run dig (a DNS tool) on the specified appliances with the provided arguments.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances
`args_str` required	Command line arguments for the dig command (see dig man page)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions dig -p appliances=... -p args_str=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "dig"]
params = {
    "appliances": ...,
    "args_str": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    args_str='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/dig/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

download_logs

POST /api/v2/actions/download-logs/

Prepare the log files for downloading on the specified appliances from from_date to to_date as ISO datetime strings.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.
`from_date`	Date/time to include logs from, in UTC ISO format.Default is now minus 2 days.
`to_date`	Date/time to include logs up to, in UTC ISO format. Default is now.
`json_output`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions download_logs -p appliances=... -p from_date=... -p to_date=... -p json_output=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "download_logs"]
params = {
    "appliances": ...,
    "from_date": ...,
    "to_date": ...,
    "json_output": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    from_date='...';
    to_date='...';
    json_output='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/download-logs/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

environment_backup_create

POST /api/v2/actions/environment-backup-create/

Create an environment backup. Backups are accessible via SFTP on database and backend appliances.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions environment_backup_create

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "environment_backup_create"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/actions/environment-backup-create/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

environment_backup_list

POST /api/v2/actions/environment-backup-list/

List the file names of the environment backups: the manually created backups via environment-backup-create, the automatically created backups at the configured backup time and the backups uploaded via SFTP to the database appliance (if applicable).

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions environment_backup_list

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "environment_backup_list"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/actions/environment-backup-list/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

environment_backup_restore

POST /api/v2/actions/environment-backup-restore/

Restore a backup of the internal database. The environment will be unavailable while this is in progress.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`filename` required	The file name of the backup to restore (see environment-backup-list)
`password`	Password to decrypt the environment backup. Leave empty if the file is not encrypted (encrypted backups have the '.enc' extension).

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions environment_backup_restore -p filename=... -p password=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "environment_backup_restore"]
params = {
    "filename": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    filename='...';
    password='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/environment-backup-restore/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

ip_address_appliances

POST /api/v2/actions/ip-address-appliances/

Retrieve appliance ip. Sends a command to retrieve the appliances network ip.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions ip_address_appliances -p appliances=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "ip_address_appliances"]
params = {
    "appliances": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/ip-address-appliances/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

ldapsearch

POST /api/v2/actions/ldapsearch/

Run ldapsearch on the specified appliances with the provided arguments.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.
`args_str` required	Command line arguments for the ldapsearch command (see ldapsearch man page)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions ldapsearch -p appliances=... -p args_str=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "ldapsearch"]
params = {
    "appliances": ...,
    "args_str": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    args_str='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/ldapsearch/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

ping

POST /api/v2/actions/ping/

Run ping on the specified appliances with the provided arguments.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.
`args_str` required	Command line arguments for the ping command (see ping man page)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions ping -p appliances=... -p args_str=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "ping"]
params = {
    "appliances": ...,
    "args_str": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    args_str='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/ping/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

shutdown_appliances

POST /api/v2/actions/shutdown-appliances/

Shutdown all appliances. Sends a shutdown instruction with 1 minute delay to allow services to stop.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions shutdown_appliances

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "shutdown_appliances"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/actions/shutdown-appliances/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

sync_appliances_time

POST /api/v2/actions/sync-appliances-time/

Time sync on all appliances. Sends a command to force time sync on all appliances.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions sync_appliances_time

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "sync_appliances_time"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/actions/sync-appliances-time/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

tcpscan

POST /api/v2/actions/tcpscan/

Run nmap on the specified appliances to check tcp ports with the provided ip/host and port/range of ports.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances
`host` required	Hostname or an ip address
`port` required	Single port, ports separated by comma (eg: 80,81) or a range of ports (eg: 80-85)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions tcpscan -p appliances=... -p host=... -p port=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "tcpscan"]
params = {
    "appliances": ...,
    "host": ...,
    "port": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    host='...';
    port='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/tcpscan/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

traceroute

POST /api/v2/actions/traceroute/

Run traceroute on the specified appliances with the provided arguments.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.
`args_str` required	Command line arguments for the traceroute command (see traceroute man page)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions traceroute -p appliances=... -p args_str=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "traceroute"]
params = {
    "appliances": ...,
    "args_str": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    args_str='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/traceroute/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

udpscan

POST /api/v2/actions/udpscan/

Run nmap on the specified appliances to check udp ports with the provided ip/host and port/range of ports.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances
`host` required	Hostname or an ip address
`port` required	Single port, ports separated by comma (eg: 80,81) or a range of ports (eg: 80-85)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions udpscan -p appliances=... -p host=... -p port=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "udpscan"]
params = {
    "appliances": ...,
    "host": ...,
    "port": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    host='...';
    port='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/udpscan/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

uptime

POST /api/v2/actions/uptime/

Run uptime on the specified appliances.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	JSON list of the hostnames of the appliances.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action actions uptime -p appliances=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["actions", "uptime"]
params = {
    "appliances": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/actions/uptime/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

app-icons

list

GET /api/v2/app-icons/

List images.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image_create

POST /api/v2/app-icons/create/

Create a new image from a single source image. Most common image formats are supported, like PNG, ICO, JPEG and GIF. The uploaded image should be maximum 100KiB and preferably square. The request body should be a 'multipart/form-data' encoded object (not JSON).

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required	Provide the file in the body of the request.
`domain` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons image_create -p file=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "image_create"]
params = {
    "file": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file='...';
    domain='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/create/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/app-icons/{id}/

Get details of an image.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this image.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/app-icons/{id}/

Delete an image.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this image.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/{id}/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image_update

POST /api/v2/app-icons/{id}/update/

Updates an existing image from a single source image. Most common image formats are supported, like PNG, ICO, JPEG and GIF. The uploaded image should be maximum 100KiB and preferably square. The request body should be a 'multipart/form-data' encoded object (not JSON).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this image.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required	Provide the file in the body of the request.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons image_update -p id=... -p file=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "image_update"]
params = {
    "id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/{id}/update/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image > read

GET /api/v2/app-icons/{id}/image/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this image.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-icons image read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-icons", "image &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-icons/{id}/image/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

app-servers

list

GET /api/v2/app-servers/

A list of all application servers. Labels are provided in a list of 'key:value' pairs.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/app-servers/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	A description of the app server to help with identification.
`domain` required	Domain this app server belongs to.
`enabled`	Boolean value to define whether the app server can be used.
`host` required	The IPv4 address or FQDN of this app server.
`labels` required	List with labels in the format key:value that are assigned to this application server. Applications with a matching server label will run on the application server.
`max_connections` required	A positive number limiting the number of RDP connections. Use 0 for unlimited connections.
`name` required	The name of the app server.
`port` required	The port number for the RDP service of the app server (default 3389).
`authentication_protocol`	The protocol used for authentication on this app server.
`authentication_host_fqdn`	The authentication host (FQDN), needed for Kerberos.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers create -p description=... -p domain=... -p enabled=... -p host=... -p labels=... -p max_connections=... -p name=... -p port=... -p authentication_protocol=... -p authentication_host_fqdn=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "create"]
params = {
    "description": ...,
    "domain": ...,
    "enabled": ...,
    "host": ...,
    "labels": ...,
    "max_connections": ...,
    "name": ...,
    "port": ...,
    "authentication_protocol": ...,
    "authentication_host_fqdn": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    domain='...';
    enabled='...';
    host='...';
    labels='...';
    max_connections='...';
    name='...';
    port='...';
    authentication_protocol='...';
    authentication_host_fqdn='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/app-servers/{id}/

Get a single application server. Labels are provided in a list of 'key:value' pairs.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app server.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers read -p id=... -p ordering=... -p domain=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/{id}/?ordering=...&domain=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/app-servers/{id}/

Update an application server by providing the complete object.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app server.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	A description of the app server to help with identification.
`domain` required	Domain this app server belongs to.
`enabled`	Boolean value to define whether the app server can be used.
`host` required	The IPv4 address or FQDN of this app server.
`labels` required	List with labels in the format key:value that are assigned to this application server. Applications with a matching server label will run on the application server.
`max_connections` required	A positive number limiting the number of RDP connections. Use 0 for unlimited connections.
`name` required	The name of the app server.
`port` required	The port number for the RDP service of the app server (default 3389).
`authentication_protocol`	The protocol used for authentication on this app server.
`authentication_host_fqdn`	The authentication host (FQDN), needed for Kerberos.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers update -p id=... -p description=... -p domain=... -p enabled=... -p host=... -p labels=... -p max_connections=... -p name=... -p port=... -p authentication_protocol=... -p authentication_host_fqdn=... -p ordering=... -p domain=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "update"]
params = {
    "id": ...,
    "description": ...,
    "domain": ...,
    "enabled": ...,
    "host": ...,
    "labels": ...,
    "max_connections": ...,
    "name": ...,
    "port": ...,
    "authentication_protocol": ...,
    "authentication_host_fqdn": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    domain='...';
    enabled='...';
    host='...';
    labels='...';
    max_connections='...';
    name='...';
    port='...';
    authentication_protocol='...';
    authentication_host_fqdn='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/{id}/?ordering=...&domain=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/app-servers/{id}/

Update a application server by providing only the changes.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app server.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	A description of the app server to help with identification.
`domain`	Domain this app server belongs to.
`enabled`	Boolean value to define whether the app server can be used.
`host`	The IPv4 address or FQDN of this app server.
`labels`	List with labels in the format key:value that are assigned to this application server. Applications with a matching server label will run on the application server.
`max_connections`	A positive number limiting the number of RDP connections. Use 0 for unlimited connections.
`name`	The name of the app server.
`port`	The port number for the RDP service of the app server (default 3389).
`authentication_protocol`	The protocol used for authentication on this app server.
`authentication_host_fqdn`	The authentication host (FQDN), needed for Kerberos.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers partial_update -p id=... -p description=... -p domain=... -p enabled=... -p host=... -p labels=... -p max_connections=... -p name=... -p port=... -p authentication_protocol=... -p authentication_host_fqdn=... -p ordering=... -p domain=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "partial_update"]
params = {
    "id": ...,
    "description": ...,
    "domain": ...,
    "enabled": ...,
    "host": ...,
    "labels": ...,
    "max_connections": ...,
    "name": ...,
    "port": ...,
    "authentication_protocol": ...,
    "authentication_host_fqdn": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    domain='...';
    enabled='...';
    host='...';
    labels='...';
    max_connections='...';
    name='...';
    port='...';
    authentication_protocol='...';
    authentication_host_fqdn='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/{id}/?ordering=...&domain=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/app-servers/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app server.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers delete -p id=... -p ordering=... -p domain=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/{id}/?ordering=...&domain=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

sessioncount > read

GET /api/v2/app-servers/{id}/sessioncount/

Returns the number of RDP connections to the app-server. There are 4 counters: active (established connections), disconnected (admin has disconnected the connection), reserved (state before established connection), closed (terminated RDP connection; number is cleaned up after a while).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app server.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-servers sessioncount read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-servers", "sessioncount &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-servers/{id}/sessioncount/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

app-sessions

list

GET /api/v2/app-sessions/

List all established connections to the app servers.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`status`
`start`
`end`
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions list -p limit=... -p offset=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/?limit=...&offset=...&status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/app-sessions/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app_id` required
`client_ip` required
`dirent`
`gateway_id` required
`rdp_parameters` required
`app_session_id` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions create -p app_id=... -p client_ip=... -p dirent=... -p gateway_id=... -p rdp_parameters=... -p app_session_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "create"]
params = {
    "app_id": ...,
    "client_ip": ...,
    "dirent": ...,
    "gateway_id": ...,
    "rdp_parameters": ...,
    "app_session_id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app_id='...';
    client_ip='...';
    dirent='...';
    gateway_id='...';
    rdp_parameters='...';
    app_session_id='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

resume

POST /api/v2/app-sessions/resume/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app_id` required
`client_ip` required
`dirent`
`gateway_id` required
`rdp_parameters` required
`app_session_id` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions resume -p app_id=... -p client_ip=... -p dirent=... -p gateway_id=... -p rdp_parameters=... -p app_session_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "resume"]
params = {
    "app_id": ...,
    "client_ip": ...,
    "dirent": ...,
    "gateway_id": ...,
    "rdp_parameters": ...,
    "app_session_id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app_id='...';
    client_ip='...';
    dirent='...';
    gateway_id='...';
    rdp_parameters='...';
    app_session_id='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/resume/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/app-sessions/{app_session_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`app_session_id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`status`
`start`
`end`
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions read -p app_session_id=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "read"]
params = {
    "app_session_id": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/{app_session_id}/?status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update > update

PUT /api/v2/app-sessions/{app_session_id}/update/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`app_session_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app_id` required
`client_ip` required
`dirent`
`gateway_id` required
`rdp_parameters` required
`app_session_id` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions update update -p app_session_id=... -p app_id=... -p client_ip=... -p dirent=... -p gateway_id=... -p rdp_parameters=... -p app_session_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "update &gt; update"]
params = {
    "app_session_id": ...,
    "app_id": ...,
    "client_ip": ...,
    "dirent": ...,
    "gateway_id": ...,
    "rdp_parameters": ...,
    "app_session_id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app_id='...';
    client_ip='...';
    dirent='...';
    gateway_id='...';
    rdp_parameters='...';
    app_session_id='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/{app_session_id}/update/'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update > partial_update

PATCH /api/v2/app-sessions/{app_session_id}/update/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`app_session_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app_id`
`client_ip`
`dirent`
`gateway_id`
`rdp_parameters`
`app_session_id`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action app-sessions update partial_update -p app_session_id=... -p app_id=... -p client_ip=... -p dirent=... -p gateway_id=... -p rdp_parameters=... -p app_session_id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["app-sessions", "update &gt; partial_update"]
params = {
    "app_session_id": ...,
    "app_id": ...,
    "client_ip": ...,
    "dirent": ...,
    "gateway_id": ...,
    "rdp_parameters": ...,
    "app_session_id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app_id='...';
    client_ip='...';
    dirent='...';
    gateway_id='...';
    rdp_parameters='...';
    app_session_id='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/app-sessions/{app_session_id}/update/'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

appliances

list

GET /api/v2/appliances/

List appliances.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action appliances list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["appliances", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/appliances/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

available

POST /api/v2/appliances/available/

Get all available appliances. Accepts two optional body arguments: ip_address and time_window. Both are mutually exclusive and the default value of time_window is 5 seconds.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`ip_address`	IP-address of the appliance to check the availability for.
`time_window`	Time window in which available appliances can be discovered.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action appliances available -p ip_address=... -p time_window=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["appliances", "available"]
params = {
    "ip_address": ...,
    "time_window": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    ip_address='...';
    time_window='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/appliances/available/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

appliances_update

POST /api/v2/appliances/update/

Update existing appliances and their services. If changes are made an update (Apply Changes) is triggered.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`appliances` required	List of appliances
`dry_run`	No actual update is done, only validation.
`accept_service_interruption`	Update also if services can be interrupted.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action appliances appliances_update -p appliances=... -p dry_run=... -p accept_service_interruption=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["appliances", "appliances_update"]
params = {
    "appliances": ...,
    "dry_run": ...,
    "accept_service_interruption": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    appliances='...';
    dry_run='...';
    accept_service_interruption='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/appliances/update/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/appliances/{id}/

Get details for an appliance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this appliance.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action appliances read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["appliances", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/appliances/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

current > read

GET /api/v2/appliances/current/

Get details of the current appliance. The current appliance is the one serving the API, thus handling the request.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action appliances current read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["appliances", "current &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/appliances/current/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

apps

list

GET /api/v2/apps/

List applications.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`name`	Name to filter on.
`start_in_foreground`	Filter on start_in_foreground
`category`
`file_type`
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p name=... -p start_in_foreground=... -p category=... -p file_type=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "name": ...,
    "start_in_foreground": ...,
    "category": ...,
    "file_type": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/apps/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&name=...&start_in_foreground=...&category=...&file_type=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/apps/

Create a new application. Same rules apply as with update.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`allow_session_merge`	Whether or not the app is allowed to be started (merged) in an existing user application session.
`ask_for_credentials`	A user will have to provide credentials to start to the application.
`autostart_labels` required	List with autostart labels in the format key:value that are assigned to this app. When logging in, users that match one of these labels and have access to this app will start this app automatically. Recorded applications will not be started automatically.
`command`	- For protocol "RDP": the command used to start the application (when empty, a full desktop session is started). - For protocol "REMOTE-APP": the alias of the RemoteApp (required). - For protocol "HTTP": the URL to the web application (required); when source_host_header is set, changing this value triggers a limited apply changes on the proxy service.
`concurrent_usage`	Whether or not a user is allowed to open multiple instances of this application simultaneously. Cannot be disabled when protocol is "HTTP".
`categories` required	List of names of categories this app belongs to.
`description`	Description of the application (not shown to the end-user).
`domain` required	Domain this application belongs to.
`icon`	The URI of the app-icon.
`labels` required	List with labels in the format key:value that are assigned to this app. These can be used for organizational purposes or to activate certain features such as smartcard support (by adding the "smartcard:" label) or recording ("record:" label).
`file_types` required	List of file extensions (e.g. ["doc", "docx"]).
`name` required	Name of the application.
`notifications_enabled`	Enables all application notifications.
`protocol` required	Protocol of the application. Possible options are: HTTP, RDP or REMOTE-APP.
`working_folder`	Working folder into which the application needs to be launched. Only relevant when protocol is "RDP"
`show_in_applications`	Whether or not to show this application on the Workspace.
`server_labels` required	List with server labels in the format key:value that are assigned to this app. The app will be started on an appserver that also has one of these labels assigned.
`start_in_foreground`	When this application is configured to start automatically at login, "start_in_foreground" will make it run in the foreground. Only one application per domain can be configured to start in foreground. Cannot be enabled when protocol is "HTTP".
`supports_unicode_kbd`	Whether or not the application supports unicode keyboards, which are better in recognizing special characters. Disable this if typing in the application results in odd behavior (like repetition of the first typed character).
`source_host_header`	Setting this field will enable the Workspace to reverse proxy this URL mentioned in the command field. This the hostname shown to the user when opening this HTTP application in their browser (e.g. intranet-pub.mycompany.com). The host header should resolve via DNS to the Workspace, but should be different than the one(s) used to access the Workspace. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`custom_destination_host_header`	When use_default_destination_host_header is disabled, the provided host header is passed to the server hosting the HTTP application. A typical use case is to enter the same value of the source_host_header, which means that the server hosting the HTTP application is aware of the presence of a reverse proxy (which might be a configuration option of the HTTP application). Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`enable_max_size`	Enable maximum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the max_height and max_width fields are required.
`enable_min_size`	Enable minimum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the min_height and min_width fields are required.
`max_width`	Maximum width for apps with protocol: RDP or REMOTE-APP
`max_height`	Maximum height for apps with protocol: RDP or REMOTE-APP
`min_height`	Minimum height for apps with protocol: RDP or REMOTE-APP
`min_width`	Minimum width for apps with protocol: RDP or REMOTE-APP
`use_default_destination_host_header`	If enabled, the host header passed to the server hosting the HTTP application, will be the host name extracted from the url in the command field. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`rewrite`	Whether to rewrite all URLs in the returned content (HTTP headers, cookies and text/html body) from the HTTP application by replacing the host of the (custom) destination_host_header with the specified source_host_header. Rewriting is typically needed when the server hosting the HTTP application is not aware that it is reachable through a reverse proxy. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`user_labels` required	List with user labels in the format key:value that are assigned to this app. When logging in, only users that match one of these labels will have access to this app.
`printer_driver_name`	Determines which printer driver is used when using ' 'the redirected printer.
`color_depth`	Defines the color depth of the streamed application.
`reverse_proxy_ssl_server_name`	If enabled, we will use Server Name Indication (SNI) when contacting the destination server over HTTPS. Only relevant when protocol is "HTTP" and the destination url starts with "https://".
`reverse_proxy_sso_enabled`	If enabled, an HTTP header set by "reverse_proxy_sso_type" field will be passed to the server hosting the HTTP application, enabling SSO for web applications supporting Basic Auth/Remote User. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_type`	Type of reverse proxy sso to use. BASIC_AUTH adds Authentication header while REMOTE_USER adds REMOTE_USER header. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_username_type`	Format of username that is set in the HTTP header for authentication during SSO. Only relevant when protocol is "HTTP".
`context_labels` required	List with context policies in the format key:value that are assigned to this app. Only users that have a context that matches all of these labels will have access to this app.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps create -p allow_session_merge=... -p ask_for_credentials=... -p autostart_labels=... -p command=... -p concurrent_usage=... -p categories=... -p description=... -p domain=... -p icon=... -p labels=... -p file_types=... -p name=... -p notifications_enabled=... -p protocol=... -p working_folder=... -p show_in_applications=... -p server_labels=... -p start_in_foreground=... -p supports_unicode_kbd=... -p source_host_header=... -p custom_destination_host_header=... -p enable_max_size=... -p enable_min_size=... -p max_width=... -p max_height=... -p min_height=... -p min_width=... -p use_default_destination_host_header=... -p rewrite=... -p user_labels=... -p printer_driver_name=... -p color_depth=... -p reverse_proxy_ssl_server_name=... -p reverse_proxy_sso_enabled=... -p reverse_proxy_sso_type=... -p reverse_proxy_sso_username_type=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "create"]
params = {
    "allow_session_merge": ...,
    "ask_for_credentials": ...,
    "autostart_labels": ...,
    "command": ...,
    "concurrent_usage": ...,
    "categories": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
    "labels": ...,
    "file_types": ...,
    "name": ...,
    "notifications_enabled": ...,
    "protocol": ...,
    "working_folder": ...,
    "show_in_applications": ...,
    "server_labels": ...,
    "start_in_foreground": ...,
    "supports_unicode_kbd": ...,
    "source_host_header": ...,
    "custom_destination_host_header": ...,
    "enable_max_size": ...,
    "enable_min_size": ...,
    "max_width": ...,
    "max_height": ...,
    "min_height": ...,
    "min_width": ...,
    "use_default_destination_host_header": ...,
    "rewrite": ...,
    "user_labels": ...,
    "printer_driver_name": ...,
    "color_depth": ...,
    "reverse_proxy_ssl_server_name": ...,
    "reverse_proxy_sso_enabled": ...,
    "reverse_proxy_sso_type": ...,
    "reverse_proxy_sso_username_type": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    allow_session_merge='...';
    ask_for_credentials='...';
    autostart_labels='...';
    command='...';
    concurrent_usage='...';
    categories='...';
    description='...';
    domain='...';
    icon='...';
    labels='...';
    file_types='...';
    name='...';
    notifications_enabled='...';
    protocol='...';
    working_folder='...';
    show_in_applications='...';
    server_labels='...';
    start_in_foreground='...';
    supports_unicode_kbd='...';
    source_host_header='...';
    custom_destination_host_header='...';
    enable_max_size='...';
    enable_min_size='...';
    max_width='...';
    max_height='...';
    min_height='...';
    min_width='...';
    use_default_destination_host_header='...';
    rewrite='...';
    user_labels='...';
    printer_driver_name='...';
    color_depth='...';
    reverse_proxy_ssl_server_name='...';
    reverse_proxy_sso_enabled='...';
    reverse_proxy_sso_type='...';
    reverse_proxy_sso_username_type='...';
    context_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/apps/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/apps/{id}/

Get details of an application.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`name`	Name to filter on.
`start_in_foreground`	Filter on start_in_foreground
`category`
`file_type`
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps read -p id=... -p ordering=... -p domain=... -p domain_name=... -p name=... -p start_in_foreground=... -p category=... -p file_type=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "name": ...,
    "start_in_foreground": ...,
    "category": ...,
    "file_type": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/apps/{id}/?ordering=...&domain=...&domain_name=...&name=...&start_in_foreground=...&category=...&file_type=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/apps/{id}/

Update details of an application. The following rules apply: - Command may not be blank when protocol is "HTTP" or "REMOTE-APP". - Concurrent usage can not be disabled when protocol is "HTTP". - Start in foreground can not be enabled when protocol is "HTTP". - Source host header, destination host header and rewrite can only be set when protocol is "HTTP". - Source host header and destination host header must be set or not set together.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`name`	Name to filter on.
`start_in_foreground`	Filter on start_in_foreground
`category`
`file_type`
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`allow_session_merge`	Whether or not the app is allowed to be started (merged) in an existing user application session.
`ask_for_credentials`	A user will have to provide credentials to start to the application.
`autostart_labels` required	List with autostart labels in the format key:value that are assigned to this app. When logging in, users that match one of these labels and have access to this app will start this app automatically. Recorded applications will not be started automatically.
`command`	- For protocol "RDP": the command used to start the application (when empty, a full desktop session is started). - For protocol "REMOTE-APP": the alias of the RemoteApp (required). - For protocol "HTTP": the URL to the web application (required); when source_host_header is set, changing this value triggers a limited apply changes on the proxy service.
`concurrent_usage`	Whether or not a user is allowed to open multiple instances of this application simultaneously. Cannot be disabled when protocol is "HTTP".
`categories` required	List of names of categories this app belongs to.
`description`	Description of the application (not shown to the end-user).
`domain` required	Domain this application belongs to.
`icon`	The URI of the app-icon.
`labels` required	List with labels in the format key:value that are assigned to this app. These can be used for organizational purposes or to activate certain features such as smartcard support (by adding the "smartcard:" label) or recording ("record:" label).
`file_types` required	List of file extensions (e.g. ["doc", "docx"]).
`name` required	Name of the application.
`notifications_enabled`	Enables all application notifications.
`protocol` required	Protocol of the application. Possible options are: HTTP, RDP or REMOTE-APP.
`working_folder`	Working folder into which the application needs to be launched. Only relevant when protocol is "RDP"
`show_in_applications`	Whether or not to show this application on the Workspace.
`server_labels` required	List with server labels in the format key:value that are assigned to this app. The app will be started on an appserver that also has one of these labels assigned.
`start_in_foreground`	When this application is configured to start automatically at login, "start_in_foreground" will make it run in the foreground. Only one application per domain can be configured to start in foreground. Cannot be enabled when protocol is "HTTP".
`supports_unicode_kbd`	Whether or not the application supports unicode keyboards, which are better in recognizing special characters. Disable this if typing in the application results in odd behavior (like repetition of the first typed character).
`source_host_header`	Setting this field will enable the Workspace to reverse proxy this URL mentioned in the command field. This the hostname shown to the user when opening this HTTP application in their browser (e.g. intranet-pub.mycompany.com). The host header should resolve via DNS to the Workspace, but should be different than the one(s) used to access the Workspace. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`custom_destination_host_header`	When use_default_destination_host_header is disabled, the provided host header is passed to the server hosting the HTTP application. A typical use case is to enter the same value of the source_host_header, which means that the server hosting the HTTP application is aware of the presence of a reverse proxy (which might be a configuration option of the HTTP application). Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`enable_max_size`	Enable maximum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the max_height and max_width fields are required.
`enable_min_size`	Enable minimum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the min_height and min_width fields are required.
`max_width`	Maximum width for apps with protocol: RDP or REMOTE-APP
`max_height`	Maximum height for apps with protocol: RDP or REMOTE-APP
`min_height`	Minimum height for apps with protocol: RDP or REMOTE-APP
`min_width`	Minimum width for apps with protocol: RDP or REMOTE-APP
`use_default_destination_host_header`	If enabled, the host header passed to the server hosting the HTTP application, will be the host name extracted from the url in the command field. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`rewrite`	Whether to rewrite all URLs in the returned content (HTTP headers, cookies and text/html body) from the HTTP application by replacing the host of the (custom) destination_host_header with the specified source_host_header. Rewriting is typically needed when the server hosting the HTTP application is not aware that it is reachable through a reverse proxy. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`user_labels` required	List with user labels in the format key:value that are assigned to this app. When logging in, only users that match one of these labels will have access to this app.
`printer_driver_name`	Determines which printer driver is used when using ' 'the redirected printer.
`color_depth`	Defines the color depth of the streamed application.
`reverse_proxy_ssl_server_name`	If enabled, we will use Server Name Indication (SNI) when contacting the destination server over HTTPS. Only relevant when protocol is "HTTP" and the destination url starts with "https://".
`reverse_proxy_sso_enabled`	If enabled, an HTTP header set by "reverse_proxy_sso_type" field will be passed to the server hosting the HTTP application, enabling SSO for web applications supporting Basic Auth/Remote User. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_type`	Type of reverse proxy sso to use. BASIC_AUTH adds Authentication header while REMOTE_USER adds REMOTE_USER header. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_username_type`	Format of username that is set in the HTTP header for authentication during SSO. Only relevant when protocol is "HTTP".
`context_labels` required	List with context policies in the format key:value that are assigned to this app. Only users that have a context that matches all of these labels will have access to this app.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps update -p id=... -p allow_session_merge=... -p ask_for_credentials=... -p autostart_labels=... -p command=... -p concurrent_usage=... -p categories=... -p description=... -p domain=... -p icon=... -p labels=... -p file_types=... -p name=... -p notifications_enabled=... -p protocol=... -p working_folder=... -p show_in_applications=... -p server_labels=... -p start_in_foreground=... -p supports_unicode_kbd=... -p source_host_header=... -p custom_destination_host_header=... -p enable_max_size=... -p enable_min_size=... -p max_width=... -p max_height=... -p min_height=... -p min_width=... -p use_default_destination_host_header=... -p rewrite=... -p user_labels=... -p printer_driver_name=... -p color_depth=... -p reverse_proxy_ssl_server_name=... -p reverse_proxy_sso_enabled=... -p reverse_proxy_sso_type=... -p reverse_proxy_sso_username_type=... -p context_labels=... -p ordering=... -p domain=... -p domain_name=... -p name=... -p start_in_foreground=... -p category=... -p file_type=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "update"]
params = {
    "id": ...,
    "allow_session_merge": ...,
    "ask_for_credentials": ...,
    "autostart_labels": ...,
    "command": ...,
    "concurrent_usage": ...,
    "categories": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
    "labels": ...,
    "file_types": ...,
    "name": ...,
    "notifications_enabled": ...,
    "protocol": ...,
    "working_folder": ...,
    "show_in_applications": ...,
    "server_labels": ...,
    "start_in_foreground": ...,
    "supports_unicode_kbd": ...,
    "source_host_header": ...,
    "custom_destination_host_header": ...,
    "enable_max_size": ...,
    "enable_min_size": ...,
    "max_width": ...,
    "max_height": ...,
    "min_height": ...,
    "min_width": ...,
    "use_default_destination_host_header": ...,
    "rewrite": ...,
    "user_labels": ...,
    "printer_driver_name": ...,
    "color_depth": ...,
    "reverse_proxy_ssl_server_name": ...,
    "reverse_proxy_sso_enabled": ...,
    "reverse_proxy_sso_type": ...,
    "reverse_proxy_sso_username_type": ...,
    "context_labels": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "name": ...,
    "start_in_foreground": ...,
    "category": ...,
    "file_type": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    allow_session_merge='...';
    ask_for_credentials='...';
    autostart_labels='...';
    command='...';
    concurrent_usage='...';
    categories='...';
    description='...';
    domain='...';
    icon='...';
    labels='...';
    file_types='...';
    name='...';
    notifications_enabled='...';
    protocol='...';
    working_folder='...';
    show_in_applications='...';
    server_labels='...';
    start_in_foreground='...';
    supports_unicode_kbd='...';
    source_host_header='...';
    custom_destination_host_header='...';
    enable_max_size='...';
    enable_min_size='...';
    max_width='...';
    max_height='...';
    min_height='...';
    min_width='...';
    use_default_destination_host_header='...';
    rewrite='...';
    user_labels='...';
    printer_driver_name='...';
    color_depth='...';
    reverse_proxy_ssl_server_name='...';
    reverse_proxy_sso_enabled='...';
    reverse_proxy_sso_type='...';
    reverse_proxy_sso_username_type='...';
    context_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/apps/{id}/?ordering=...&domain=...&domain_name=...&name=...&start_in_foreground=...&category=...&file_type=...&search=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/apps/{id}/

Update some details of an application. Same rules apply as with update.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`name`	Name to filter on.
`start_in_foreground`	Filter on start_in_foreground
`category`
`file_type`
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`allow_session_merge`	Whether or not the app is allowed to be started (merged) in an existing user application session.
`ask_for_credentials`	A user will have to provide credentials to start to the application.
`autostart_labels`	List with autostart labels in the format key:value that are assigned to this app. When logging in, users that match one of these labels and have access to this app will start this app automatically. Recorded applications will not be started automatically.
`command`	- For protocol "RDP": the command used to start the application (when empty, a full desktop session is started). - For protocol "REMOTE-APP": the alias of the RemoteApp (required). - For protocol "HTTP": the URL to the web application (required); when source_host_header is set, changing this value triggers a limited apply changes on the proxy service.
`concurrent_usage`	Whether or not a user is allowed to open multiple instances of this application simultaneously. Cannot be disabled when protocol is "HTTP".
`categories`	List of names of categories this app belongs to.
`description`	Description of the application (not shown to the end-user).
`domain`	Domain this application belongs to.
`icon`	The URI of the app-icon.
`labels`	List with labels in the format key:value that are assigned to this app. These can be used for organizational purposes or to activate certain features such as smartcard support (by adding the "smartcard:" label) or recording ("record:" label).
`file_types`	List of file extensions (e.g. ["doc", "docx"]).
`name`	Name of the application.
`notifications_enabled`	Enables all application notifications.
`protocol`	Protocol of the application. Possible options are: HTTP, RDP or REMOTE-APP.
`working_folder`	Working folder into which the application needs to be launched. Only relevant when protocol is "RDP"
`show_in_applications`	Whether or not to show this application on the Workspace.
`server_labels`	List with server labels in the format key:value that are assigned to this app. The app will be started on an appserver that also has one of these labels assigned.
`start_in_foreground`	When this application is configured to start automatically at login, "start_in_foreground" will make it run in the foreground. Only one application per domain can be configured to start in foreground. Cannot be enabled when protocol is "HTTP".
`supports_unicode_kbd`	Whether or not the application supports unicode keyboards, which are better in recognizing special characters. Disable this if typing in the application results in odd behavior (like repetition of the first typed character).
`source_host_header`	Setting this field will enable the Workspace to reverse proxy this URL mentioned in the command field. This the hostname shown to the user when opening this HTTP application in their browser (e.g. intranet-pub.mycompany.com). The host header should resolve via DNS to the Workspace, but should be different than the one(s) used to access the Workspace. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`custom_destination_host_header`	When use_default_destination_host_header is disabled, the provided host header is passed to the server hosting the HTTP application. A typical use case is to enter the same value of the source_host_header, which means that the server hosting the HTTP application is aware of the presence of a reverse proxy (which might be a configuration option of the HTTP application). Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`enable_max_size`	Enable maximum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the max_height and max_width fields are required.
`enable_min_size`	Enable minimum resolution for apps with protocol RDP or REMOTE-APP. When this is enabled the min_height and min_width fields are required.
`max_width`	Maximum width for apps with protocol: RDP or REMOTE-APP
`max_height`	Maximum height for apps with protocol: RDP or REMOTE-APP
`min_height`	Minimum height for apps with protocol: RDP or REMOTE-APP
`min_width`	Minimum width for apps with protocol: RDP or REMOTE-APP
`use_default_destination_host_header`	If enabled, the host header passed to the server hosting the HTTP application, will be the host name extracted from the url in the command field. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`rewrite`	Whether to rewrite all URLs in the returned content (HTTP headers, cookies and text/html body) from the HTTP application by replacing the host of the (custom) destination_host_header with the specified source_host_header. Rewriting is typically needed when the server hosting the HTTP application is not aware that it is reachable through a reverse proxy. Triggers a limited apply changes on the proxy service. Only relevant when protocol is "HTTP".
`user_labels`	List with user labels in the format key:value that are assigned to this app. When logging in, only users that match one of these labels will have access to this app.
`printer_driver_name`	Determines which printer driver is used when using ' 'the redirected printer.
`color_depth`	Defines the color depth of the streamed application.
`reverse_proxy_ssl_server_name`	If enabled, we will use Server Name Indication (SNI) when contacting the destination server over HTTPS. Only relevant when protocol is "HTTP" and the destination url starts with "https://".
`reverse_proxy_sso_enabled`	If enabled, an HTTP header set by "reverse_proxy_sso_type" field will be passed to the server hosting the HTTP application, enabling SSO for web applications supporting Basic Auth/Remote User. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_type`	Type of reverse proxy sso to use. BASIC_AUTH adds Authentication header while REMOTE_USER adds REMOTE_USER header. Only relevant when protocol is "HTTP".
`reverse_proxy_sso_username_type`	Format of username that is set in the HTTP header for authentication during SSO. Only relevant when protocol is "HTTP".
`context_labels`	List with context policies in the format key:value that are assigned to this app. Only users that have a context that matches all of these labels will have access to this app.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps partial_update -p id=... -p allow_session_merge=... -p ask_for_credentials=... -p autostart_labels=... -p command=... -p concurrent_usage=... -p categories=... -p description=... -p domain=... -p icon=... -p labels=... -p file_types=... -p name=... -p notifications_enabled=... -p protocol=... -p working_folder=... -p show_in_applications=... -p server_labels=... -p start_in_foreground=... -p supports_unicode_kbd=... -p source_host_header=... -p custom_destination_host_header=... -p enable_max_size=... -p enable_min_size=... -p max_width=... -p max_height=... -p min_height=... -p min_width=... -p use_default_destination_host_header=... -p rewrite=... -p user_labels=... -p printer_driver_name=... -p color_depth=... -p reverse_proxy_ssl_server_name=... -p reverse_proxy_sso_enabled=... -p reverse_proxy_sso_type=... -p reverse_proxy_sso_username_type=... -p context_labels=... -p ordering=... -p domain=... -p domain_name=... -p name=... -p start_in_foreground=... -p category=... -p file_type=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "partial_update"]
params = {
    "id": ...,
    "allow_session_merge": ...,
    "ask_for_credentials": ...,
    "autostart_labels": ...,
    "command": ...,
    "concurrent_usage": ...,
    "categories": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
    "labels": ...,
    "file_types": ...,
    "name": ...,
    "notifications_enabled": ...,
    "protocol": ...,
    "working_folder": ...,
    "show_in_applications": ...,
    "server_labels": ...,
    "start_in_foreground": ...,
    "supports_unicode_kbd": ...,
    "source_host_header": ...,
    "custom_destination_host_header": ...,
    "enable_max_size": ...,
    "enable_min_size": ...,
    "max_width": ...,
    "max_height": ...,
    "min_height": ...,
    "min_width": ...,
    "use_default_destination_host_header": ...,
    "rewrite": ...,
    "user_labels": ...,
    "printer_driver_name": ...,
    "color_depth": ...,
    "reverse_proxy_ssl_server_name": ...,
    "reverse_proxy_sso_enabled": ...,
    "reverse_proxy_sso_type": ...,
    "reverse_proxy_sso_username_type": ...,
    "context_labels": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "name": ...,
    "start_in_foreground": ...,
    "category": ...,
    "file_type": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    allow_session_merge='...';
    ask_for_credentials='...';
    autostart_labels='...';
    command='...';
    concurrent_usage='...';
    categories='...';
    description='...';
    domain='...';
    icon='...';
    labels='...';
    file_types='...';
    name='...';
    notifications_enabled='...';
    protocol='...';
    working_folder='...';
    show_in_applications='...';
    server_labels='...';
    start_in_foreground='...';
    supports_unicode_kbd='...';
    source_host_header='...';
    custom_destination_host_header='...';
    enable_max_size='...';
    enable_min_size='...';
    max_width='...';
    max_height='...';
    min_height='...';
    min_width='...';
    use_default_destination_host_header='...';
    rewrite='...';
    user_labels='...';
    printer_driver_name='...';
    color_depth='...';
    reverse_proxy_ssl_server_name='...';
    reverse_proxy_sso_enabled='...';
    reverse_proxy_sso_type='...';
    reverse_proxy_sso_username_type='...';
    context_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/apps/{id}/?ordering=...&domain=...&domain_name=...&name=...&start_in_foreground=...&category=...&file_type=...&search=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/apps/{id}/

Delete an application.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`name`	Name to filter on.
`start_in_foreground`	Filter on start_in_foreground
`category`
`file_type`
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action apps delete -p id=... -p ordering=... -p domain=... -p domain_name=... -p name=... -p start_in_foreground=... -p category=... -p file_type=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["apps", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "name": ...,
    "start_in_foreground": ...,
    "category": ...,
    "file_type": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/apps/{id}/?ordering=...&domain=...&domain_name=...&name=...&start_in_foreground=...&category=...&file_type=...&search=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

auth-providers

list

GET /api/v2/auth-providers/

List authentication providers.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action auth-providers list -p limit=... -p offset=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["auth-providers", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/auth-providers/?limit=...&offset=...&domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/auth-providers/{id}/

Get details for an authentication provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action auth-providers read -p id=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["auth-providers", "read"]
params = {
    "id": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/auth-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/auth-providers/{id}/

Update details for an authentication provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config` required	Configuration for this authentication provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action auth-providers update -p id=... -p config=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["auth-providers", "update"]
params = {
    "id": ...,
    "config": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/auth-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/auth-providers/{id}/

Update details for an authentication provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config`	Configuration for this authentication provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action auth-providers partial_update -p id=... -p config=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["auth-providers", "partial_update"]
params = {
    "id": ...,
    "config": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/auth-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

bookmarks

list

GET /api/v2/bookmarks/

List bookmarks, which can be filtered with the parameter "user"

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks list -p limit=... -p offset=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/?limit=...&offset=...&user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/bookmarks/

Create a new bookmark.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`dirent` required	The URI of the file or folder where the bookmark points to

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks create -p dirent=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "create"]
params = {
    "dirent": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    dirent='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

move_down

POST /api/v2/bookmarks/move-down/

Move target bookmark index down by one.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`bookmark` required	Bookmark to move.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks move_down -p bookmark=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "move_down"]
params = {
    "bookmark": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    bookmark='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/move-down/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

move_to

POST /api/v2/bookmarks/move-to/

Move target bookmark index to given index.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`bookmark` required	Bookmark to move.
`index` required	Index to move the bookmark to.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks move_to -p bookmark=... -p index=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "move_to"]
params = {
    "bookmark": ...,
    "index": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    bookmark='...';
    index='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/move-to/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

move_up

POST /api/v2/bookmarks/move-up/

Move target bookmark index up by one.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`bookmark` required	Bookmark to move.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks move_up -p bookmark=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "move_up"]
params = {
    "bookmark": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    bookmark='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/move-up/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/bookmarks/{id}/

Get details of a bookmark.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this bookmark.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks read -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "read"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/{id}/?user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/bookmarks/{id}/

Delete a bookmark.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this bookmark.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action bookmarks delete -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["bookmarks", "delete"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/bookmarks/{id}/?user=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

branding

list

GET /api/v2/branding/

List branding configurations.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding list -p limit=... -p offset=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding/?limit=...&offset=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

generate_pre_auth_url

POST /api/v2/branding/generate-pre-auth-url/

Returns pre_auth_url for domain (via host headers) if configured for that domain. e.g. /api/v2/branding/generate-pre-auth-url

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding generate_pre_auth_url

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding", "generate_pre_auth_url"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding/generate-pre-auth-url/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/branding/{id}/

Get branding configuration details.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding read -p id=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding", "read"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/branding/{id}/

Update branding configuration.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`background_type`	Background types (PLAIN-COLOR or POLYGON)
`custom_desktop_background`	Branding image URI of the custom desktop background (max. 500 KiB).
`custom_logo`	Branding image URI of the custom wide logo (max. 100 KiB). The wide logo is used in the expanded sidebar.
`custom_tablet_background`	Branding image URI of the custom tablet background (max. 150 KiB).
`login_footer`	Login footer.
`primary_color` required	A hex color value in string format starting with a pound sign. Eg. #FFFFFF.
`secondary_color` required	A hex color value in string format starting with a pound sign. Eg. #FFFFFF.
`use_custom_favicon`	Flag indicating whether to use the custom favicon or not.
`use_custom_login_background`	Flag indicating whether to use the custom login backgroundor not.
`use_custom_logo`	Flag indicating whether to use the custom logo or not.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding update -p id=... -p background_type=... -p custom_desktop_background=... -p custom_logo=... -p custom_tablet_background=... -p login_footer=... -p primary_color=... -p secondary_color=... -p use_custom_favicon=... -p use_custom_login_background=... -p use_custom_logo=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding", "update"]
params = {
    "id": ...,
    "background_type": ...,
    "custom_desktop_background": ...,
    "custom_logo": ...,
    "custom_tablet_background": ...,
    "login_footer": ...,
    "primary_color": ...,
    "secondary_color": ...,
    "use_custom_favicon": ...,
    "use_custom_login_background": ...,
    "use_custom_logo": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    background_type='...';
    custom_desktop_background='...';
    custom_logo='...';
    custom_tablet_background='...';
    login_footer='...';
    primary_color='...';
    secondary_color='...';
    use_custom_favicon='...';
    use_custom_login_background='...';
    use_custom_logo='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/branding/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/branding/{id}/

Partially update branding.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`background_type`	Background types (PLAIN-COLOR or POLYGON)
`custom_desktop_background`	Branding image URI of the custom desktop background (max. 500 KiB).
`custom_logo`	Branding image URI of the custom wide logo (max. 100 KiB). The wide logo is used in the expanded sidebar.
`custom_tablet_background`	Branding image URI of the custom tablet background (max. 150 KiB).
`login_footer`	Login footer.
`primary_color`	A hex color value in string format starting with a pound sign. Eg. #FFFFFF.
`secondary_color`	A hex color value in string format starting with a pound sign. Eg. #FFFFFF.
`use_custom_favicon`	Flag indicating whether to use the custom favicon or not.
`use_custom_login_background`	Flag indicating whether to use the custom login backgroundor not.
`use_custom_logo`	Flag indicating whether to use the custom logo or not.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding partial_update -p id=... -p background_type=... -p custom_desktop_background=... -p custom_logo=... -p custom_tablet_background=... -p login_footer=... -p primary_color=... -p secondary_color=... -p use_custom_favicon=... -p use_custom_login_background=... -p use_custom_logo=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding", "partial_update"]
params = {
    "id": ...,
    "background_type": ...,
    "custom_desktop_background": ...,
    "custom_logo": ...,
    "custom_tablet_background": ...,
    "login_footer": ...,
    "primary_color": ...,
    "secondary_color": ...,
    "use_custom_favicon": ...,
    "use_custom_login_background": ...,
    "use_custom_logo": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    background_type='...';
    custom_desktop_background='...';
    custom_logo='...';
    custom_tablet_background='...';
    login_footer='...';
    primary_color='...';
    secondary_color='...';
    use_custom_favicon='...';
    use_custom_login_background='...';
    use_custom_logo='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/branding/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

branding-images

list

GET /api/v2/branding-images/

List branding images.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images list -p limit=... -p offset=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/?limit=...&offset=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image_create

POST /api/v2/branding-images/create/

Create a new branding image from a single source image. Most common image formats are supported, like PNG, JPEG and GIF. The uploaded image should be maximum 500KiB. The request body should be a 'multipart/form-data' encoded object (not JSON).

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain` required	Domain this image belongs to.
`file` required	Provide the file in the body of the request.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images image_create -p domain=... -p file=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "image_create"]
params = {
    "domain": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    file='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/create/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/branding-images/{id}/

Get branding image details.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding image.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images read -p id=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "read"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/branding-images/{id}/

Delete branding image.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding image.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images delete -p id=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "delete"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image_update

POST /api/v2/branding-images/{id}/update/

Updates an existing branding image from a single source image. Most common image formats are supported, like PNG, JPEG and GIF. The uploaded image should be maximum 500KiB. The request body should be a 'multipart/form-data' encoded object (not JSON).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding image.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required	Provide the file in the body of the request.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images image_update -p id=... -p file=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "image_update"]
params = {
    "id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/{id}/update/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image > read

GET /api/v2/branding-images/{id}/image/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this branding image.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action branding-images image read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["branding-images", "image &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/branding-images/{id}/image/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

configuration

list

GET /api/v2/configuration/

List global configurations for your Workspace. Currently there will always be only one configuration.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

check_license

POST /api/v2/configuration/check-license/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`snmp_password`	Password for SNMP. Must be between 8 and 32 characters long. Required if SNMP is enabled. Triggers a limited apply changes on the SNMP service.
`hsts_enabled`	Informs the browsers that the Workspace should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. Can only be enabled if ssl_mode is EXTERNAL or ENFORCED and hsts_max_age is set.
`dbadmin_whitelisted_subnets_enabled`	Whether or not subnet whitelisting is enabled for the local admin account.
`upgrade_message_dismissed`	Whether or not to stop showing an upgrade message.
`hsts_max_age`	The time, in seconds, that the browser should remember that the Workspace is only accessible using HTTPS.
`license`	License file as supplied by your Partner.
`dns_ip` required	A comma separated list of IPv4 addresses of DNS servers to be used for all external DNS resolving by this Workspace. Triggers a limited apply changes on the DNS service.
`system_message_enabled`	Whether or not to show the message in system_message.
`ssl_mode`	Mode of the internal SSL offloader. The choices are OPTIONAL, ENFORCED and EXTERNAL. OPTIONAL means you can access the Workspace through both HTTP and HTTPS, but the specific security measurements for HTTPS (e.g. Cookie Secure Flag) won't be applied. This setting can be used with both the internal and an external SSL offloader. ENFORCED means that all HTTP traffic to the Workspace will be redirected to HTTPS, which will be handled by the internal SSL offloader. This enables specific security measurements for HTTPS (e.g. Cookie Secure Flag). EXTERNAL means that the Workspace accepts non-SSL traffic, but specific security measurements for HTTPS (e.g. Cookie Secure Flag) will be enforced. With EXTERNAL you need an external SSL offloader to access the Workspace. Triggers a limited apply changes on the proxy service.
`hsts_preload`	When enabled, the Workspace URL can be submitted to the HSTS preload list. To be accepted to the list other requirements also need to be met.
`sftp_password`	Password to use for SFTP access to the environment backups on the appliances. Must have a minimum length of 8 characters. Triggers a limited apply changes on the SFTP user.
`hsts_include_subdomains`	Determines if the HSTS header is also active on all of the website's subdomains.
`proxy_url`	The URL of the HTTP proxy to be used, formatted as http(s)://username:password@fqdn_or_ip:port. Username and password are optional. Mandatory if the HTTP proxy is enabled. Note that upgrades, anonymous data collection and some MFA providers require outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`backup_encryption_password`	Password to use to encrypt the environment backups. While this password is not set, backups will not be encrypted. Encrypted backups have the '.enc' extension and will require this same password to be able to restore the backup.
`log_level_application_gateway`	Application gateway log level.
`snmp_enabled`	Whether or not SNMP v3 is enabled for this Workspace. If enabled, snmp_password is required to be filled in. Triggers a limited apply changes on the SNMP service.
`backup_time`	Time in UTC when the daily environment backup will start.
`ntp_server` required	A comma separated list of FQDNs or IPv4 addresses of NTP servers, used by this Workspace to synchronize its internal clock. If NTP is provided by DHCP, this setting will be ignored. Triggers a limited apply changes on the NTP service.
`repo_url`	URL of the repository server used to keep this Workspace up to date. Triggers a limited apply changes on the APT sources.
`vault_backup_enabled`	Whether or not to enable backups of the Vault service. There can be a short service interruption for SSO starting at the daily backup_time if this is enabled. If Vault is not included in the backup, SSO will fall back to pre-authentication when restoring from this backup.This option has no effect if no seal provider has been selected.
`system_message`	Message that is shown to logged-in users if system_message_enabled is True.
`app_session_failover`	Whether or not to failover application sessions when a node goes down
`seal_provider`
`trusted_ca`	Global level trusted Certificate Authorities
`license_enabled`
`default_domain`	Domain that is used by default when no other domain has been selected.
`anonymous_reporting_enabled`	Whether or not anonymized data is collected on this Workspace. If set to null, the System Settings will ask the administrator to make a choice next time he opens the System Settings. No data will be collected as long as this setting is set to null or false.
`proxy_enabled`	Whether or not an HTTP proxy is used for all outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`dbadmin_whitelisted_subnets`	List of IPv4 subnets from which clients are allowed to login with the local admin account.
`feature_flags` required
`reverse_proxy_subnets`	List of IPv4 subnets that are considered to be reverse proxies by the Workspace.
`basic_sso_enabled`	Whether or not Basic SSO integration is enabled (for Pulse Connect Secure). Triggers a limited apply changes on the proxy service.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration check_license -p snmp_password=... -p hsts_enabled=... -p dbadmin_whitelisted_subnets_enabled=... -p upgrade_message_dismissed=... -p hsts_max_age=... -p license=... -p dns_ip=... -p system_message_enabled=... -p ssl_mode=... -p hsts_preload=... -p sftp_password=... -p hsts_include_subdomains=... -p proxy_url=... -p backup_encryption_password=... -p log_level_application_gateway=... -p snmp_enabled=... -p backup_time=... -p ntp_server=... -p repo_url=... -p vault_backup_enabled=... -p system_message=... -p app_session_failover=... -p seal_provider=... -p trusted_ca=... -p license_enabled=... -p default_domain=... -p anonymous_reporting_enabled=... -p proxy_enabled=... -p dbadmin_whitelisted_subnets=... -p feature_flags=... -p reverse_proxy_subnets=... -p basic_sso_enabled=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "check_license"]
params = {
    "snmp_password": ...,
    "hsts_enabled": ...,
    "dbadmin_whitelisted_subnets_enabled": ...,
    "upgrade_message_dismissed": ...,
    "hsts_max_age": ...,
    "license": ...,
    "dns_ip": ...,
    "system_message_enabled": ...,
    "ssl_mode": ...,
    "hsts_preload": ...,
    "sftp_password": ...,
    "hsts_include_subdomains": ...,
    "proxy_url": ...,
    "backup_encryption_password": ...,
    "log_level_application_gateway": ...,
    "snmp_enabled": ...,
    "backup_time": ...,
    "ntp_server": ...,
    "repo_url": ...,
    "vault_backup_enabled": ...,
    "system_message": ...,
    "app_session_failover": ...,
    "seal_provider": ...,
    "trusted_ca": ...,
    "license_enabled": ...,
    "default_domain": ...,
    "anonymous_reporting_enabled": ...,
    "proxy_enabled": ...,
    "dbadmin_whitelisted_subnets": ...,
    "feature_flags": ...,
    "reverse_proxy_subnets": ...,
    "basic_sso_enabled": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    snmp_password='...';
    hsts_enabled='...';
    dbadmin_whitelisted_subnets_enabled='...';
    upgrade_message_dismissed='...';
    hsts_max_age='...';
    license='...';
    dns_ip='...';
    system_message_enabled='...';
    ssl_mode='...';
    hsts_preload='...';
    sftp_password='...';
    hsts_include_subdomains='...';
    proxy_url='...';
    backup_encryption_password='...';
    log_level_application_gateway='...';
    snmp_enabled='...';
    backup_time='...';
    ntp_server='...';
    repo_url='...';
    vault_backup_enabled='...';
    system_message='...';
    app_session_failover='...';
    seal_provider='...';
    trusted_ca='...';
    license_enabled='...';
    default_domain='...';
    anonymous_reporting_enabled='...';
    proxy_enabled='...';
    dbadmin_whitelisted_subnets='...';
    feature_flags='...';
    reverse_proxy_subnets='...';
    basic_sso_enabled='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/configuration/check-license/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

client_ip

POST /api/v2/configuration/client-ip/

Internal API call so the gateway can determine if it should use the value of the X-Forwarded-For header or the actual remote address connecting to the Workspace.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`remote_address` required
`forwarded_address`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration client_ip -p remote_address=... -p forwarded_address=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "client_ip"]
params = {
    "remote_address": ...,
    "forwarded_address": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    remote_address='...';
    forwarded_address='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/configuration/client-ip/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

decode_license

POST /api/v2/configuration/decode-license/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`license` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration decode_license -p license=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "decode_license"]
params = {
    "license": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    license='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/configuration/decode-license/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

disable_intervention_password

POST /api/v2/configuration/disable-intervention-password/

Disables the intervention password so it is not required anymore for interventions by the Support Team. The support team still needs to use their SSH keypair to login, and to have network access on the SSH port.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration disable_intervention_password

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "disable_intervention_password"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration/disable-intervention-password/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

generate_intervention_password

POST /api/v2/configuration/generate-intervention-password/

Generate a new intervention password. This will replace any previous intervention passwords. Please don't lose the generated intervention code! Without the code, you cannot get any remote support from the Support Team anymore. It is recommended to only set an intervention code when you have opened the SSH port on your firewall and to disable the intervention code once the SSH port has been closed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration generate_intervention_password

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "generate_intervention_password"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration/generate-intervention-password/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/configuration/{id}/

Get global configuration details for your Workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this configuration.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/configuration/{id}/

Change global configuration for your Workspace. Changes to some of these fields will trigger a limited apply changes automatically. This is indicated in the per-field documentation. During this apply changes the SMC interface is unavailable. You can follow the progress of this apply changes using the Update API.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this configuration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`snmp_password`	Password for SNMP. Must be between 8 and 32 characters long. Required if SNMP is enabled. Triggers a limited apply changes on the SNMP service.
`hsts_enabled`	Informs the browsers that the Workspace should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. Can only be enabled if ssl_mode is EXTERNAL or ENFORCED and hsts_max_age is set.
`dbadmin_whitelisted_subnets_enabled`	Whether or not subnet whitelisting is enabled for the local admin account.
`upgrade_message_dismissed`	Whether or not to stop showing an upgrade message.
`hsts_max_age`	The time, in seconds, that the browser should remember that the Workspace is only accessible using HTTPS.
`license`	License file as supplied by your Partner.
`dns_ip` required	A comma separated list of IPv4 addresses of DNS servers to be used for all external DNS resolving by this Workspace. Triggers a limited apply changes on the DNS service.
`system_message_enabled`	Whether or not to show the message in system_message.
`ssl_mode`	Mode of the internal SSL offloader. The choices are OPTIONAL, ENFORCED and EXTERNAL. OPTIONAL means you can access the Workspace through both HTTP and HTTPS, but the specific security measurements for HTTPS (e.g. Cookie Secure Flag) won't be applied. This setting can be used with both the internal and an external SSL offloader. ENFORCED means that all HTTP traffic to the Workspace will be redirected to HTTPS, which will be handled by the internal SSL offloader. This enables specific security measurements for HTTPS (e.g. Cookie Secure Flag). EXTERNAL means that the Workspace accepts non-SSL traffic, but specific security measurements for HTTPS (e.g. Cookie Secure Flag) will be enforced. With EXTERNAL you need an external SSL offloader to access the Workspace. Triggers a limited apply changes on the proxy service.
`hsts_preload`	When enabled, the Workspace URL can be submitted to the HSTS preload list. To be accepted to the list other requirements also need to be met.
`sftp_password`	Password to use for SFTP access to the environment backups on the appliances. Must have a minimum length of 8 characters. Triggers a limited apply changes on the SFTP user.
`hsts_include_subdomains`	Determines if the HSTS header is also active on all of the website's subdomains.
`proxy_url`	The URL of the HTTP proxy to be used, formatted as http(s)://username:password@fqdn_or_ip:port. Username and password are optional. Mandatory if the HTTP proxy is enabled. Note that upgrades, anonymous data collection and some MFA providers require outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`backup_encryption_password`	Password to use to encrypt the environment backups. While this password is not set, backups will not be encrypted. Encrypted backups have the '.enc' extension and will require this same password to be able to restore the backup.
`log_level_application_gateway`	Application gateway log level.
`snmp_enabled`	Whether or not SNMP v3 is enabled for this Workspace. If enabled, snmp_password is required to be filled in. Triggers a limited apply changes on the SNMP service.
`backup_time`	Time in UTC when the daily environment backup will start.
`ntp_server` required	A comma separated list of FQDNs or IPv4 addresses of NTP servers, used by this Workspace to synchronize its internal clock. If NTP is provided by DHCP, this setting will be ignored. Triggers a limited apply changes on the NTP service.
`repo_url`	URL of the repository server used to keep this Workspace up to date. Triggers a limited apply changes on the APT sources.
`vault_backup_enabled`	Whether or not to enable backups of the Vault service. There can be a short service interruption for SSO starting at the daily backup_time if this is enabled. If Vault is not included in the backup, SSO will fall back to pre-authentication when restoring from this backup.This option has no effect if no seal provider has been selected.
`system_message`	Message that is shown to logged-in users if system_message_enabled is True.
`app_session_failover`	Whether or not to failover application sessions when a node goes down
`seal_provider`
`trusted_ca`	Global level trusted Certificate Authorities
`license_enabled`
`default_domain`	Domain that is used by default when no other domain has been selected.
`anonymous_reporting_enabled`	Whether or not anonymized data is collected on this Workspace. If set to null, the System Settings will ask the administrator to make a choice next time he opens the System Settings. No data will be collected as long as this setting is set to null or false.
`proxy_enabled`	Whether or not an HTTP proxy is used for all outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`dbadmin_whitelisted_subnets`	List of IPv4 subnets from which clients are allowed to login with the local admin account.
`feature_flags` required
`reverse_proxy_subnets`	List of IPv4 subnets that are considered to be reverse proxies by the Workspace.
`basic_sso_enabled`	Whether or not Basic SSO integration is enabled (for Pulse Connect Secure). Triggers a limited apply changes on the proxy service.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration update -p id=... -p snmp_password=... -p hsts_enabled=... -p dbadmin_whitelisted_subnets_enabled=... -p upgrade_message_dismissed=... -p hsts_max_age=... -p license=... -p dns_ip=... -p system_message_enabled=... -p ssl_mode=... -p hsts_preload=... -p sftp_password=... -p hsts_include_subdomains=... -p proxy_url=... -p backup_encryption_password=... -p log_level_application_gateway=... -p snmp_enabled=... -p backup_time=... -p ntp_server=... -p repo_url=... -p vault_backup_enabled=... -p system_message=... -p app_session_failover=... -p seal_provider=... -p trusted_ca=... -p license_enabled=... -p default_domain=... -p anonymous_reporting_enabled=... -p proxy_enabled=... -p dbadmin_whitelisted_subnets=... -p feature_flags=... -p reverse_proxy_subnets=... -p basic_sso_enabled=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "update"]
params = {
    "id": ...,
    "snmp_password": ...,
    "hsts_enabled": ...,
    "dbadmin_whitelisted_subnets_enabled": ...,
    "upgrade_message_dismissed": ...,
    "hsts_max_age": ...,
    "license": ...,
    "dns_ip": ...,
    "system_message_enabled": ...,
    "ssl_mode": ...,
    "hsts_preload": ...,
    "sftp_password": ...,
    "hsts_include_subdomains": ...,
    "proxy_url": ...,
    "backup_encryption_password": ...,
    "log_level_application_gateway": ...,
    "snmp_enabled": ...,
    "backup_time": ...,
    "ntp_server": ...,
    "repo_url": ...,
    "vault_backup_enabled": ...,
    "system_message": ...,
    "app_session_failover": ...,
    "seal_provider": ...,
    "trusted_ca": ...,
    "license_enabled": ...,
    "default_domain": ...,
    "anonymous_reporting_enabled": ...,
    "proxy_enabled": ...,
    "dbadmin_whitelisted_subnets": ...,
    "feature_flags": ...,
    "reverse_proxy_subnets": ...,
    "basic_sso_enabled": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    snmp_password='...';
    hsts_enabled='...';
    dbadmin_whitelisted_subnets_enabled='...';
    upgrade_message_dismissed='...';
    hsts_max_age='...';
    license='...';
    dns_ip='...';
    system_message_enabled='...';
    ssl_mode='...';
    hsts_preload='...';
    sftp_password='...';
    hsts_include_subdomains='...';
    proxy_url='...';
    backup_encryption_password='...';
    log_level_application_gateway='...';
    snmp_enabled='...';
    backup_time='...';
    ntp_server='...';
    repo_url='...';
    vault_backup_enabled='...';
    system_message='...';
    app_session_failover='...';
    seal_provider='...';
    trusted_ca='...';
    license_enabled='...';
    default_domain='...';
    anonymous_reporting_enabled='...';
    proxy_enabled='...';
    dbadmin_whitelisted_subnets='...';
    feature_flags='...';
    reverse_proxy_subnets='...';
    basic_sso_enabled='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/configuration/{id}/'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/configuration/{id}/

Change some fields of the global configuration for your Workspace. Changes to some of these fields will trigger a limited apply changes automatically. This is indicated in the per-field documentation. During this apply changes the SMC interface is unavailable. You can follow the progress of this apply changes using the Update API.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this configuration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`snmp_password`	Password for SNMP. Must be between 8 and 32 characters long. Required if SNMP is enabled. Triggers a limited apply changes on the SNMP service.
`hsts_enabled`	Informs the browsers that the Workspace should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS. Can only be enabled if ssl_mode is EXTERNAL or ENFORCED and hsts_max_age is set.
`dbadmin_whitelisted_subnets_enabled`	Whether or not subnet whitelisting is enabled for the local admin account.
`upgrade_message_dismissed`	Whether or not to stop showing an upgrade message.
`hsts_max_age`	The time, in seconds, that the browser should remember that the Workspace is only accessible using HTTPS.
`license`	License file as supplied by your Partner.
`dns_ip`	A comma separated list of IPv4 addresses of DNS servers to be used for all external DNS resolving by this Workspace. Triggers a limited apply changes on the DNS service.
`system_message_enabled`	Whether or not to show the message in system_message.
`ssl_mode`	Mode of the internal SSL offloader. The choices are OPTIONAL, ENFORCED and EXTERNAL. OPTIONAL means you can access the Workspace through both HTTP and HTTPS, but the specific security measurements for HTTPS (e.g. Cookie Secure Flag) won't be applied. This setting can be used with both the internal and an external SSL offloader. ENFORCED means that all HTTP traffic to the Workspace will be redirected to HTTPS, which will be handled by the internal SSL offloader. This enables specific security measurements for HTTPS (e.g. Cookie Secure Flag). EXTERNAL means that the Workspace accepts non-SSL traffic, but specific security measurements for HTTPS (e.g. Cookie Secure Flag) will be enforced. With EXTERNAL you need an external SSL offloader to access the Workspace. Triggers a limited apply changes on the proxy service.
`hsts_preload`	When enabled, the Workspace URL can be submitted to the HSTS preload list. To be accepted to the list other requirements also need to be met.
`sftp_password`	Password to use for SFTP access to the environment backups on the appliances. Must have a minimum length of 8 characters. Triggers a limited apply changes on the SFTP user.
`hsts_include_subdomains`	Determines if the HSTS header is also active on all of the website's subdomains.
`proxy_url`	The URL of the HTTP proxy to be used, formatted as http(s)://username:password@fqdn_or_ip:port. Username and password are optional. Mandatory if the HTTP proxy is enabled. Note that upgrades, anonymous data collection and some MFA providers require outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`backup_encryption_password`	Password to use to encrypt the environment backups. While this password is not set, backups will not be encrypted. Encrypted backups have the '.enc' extension and will require this same password to be able to restore the backup.
`log_level_application_gateway`	Application gateway log level.
`snmp_enabled`	Whether or not SNMP v3 is enabled for this Workspace. If enabled, snmp_password is required to be filled in. Triggers a limited apply changes on the SNMP service.
`backup_time`	Time in UTC when the daily environment backup will start.
`ntp_server`	A comma separated list of FQDNs or IPv4 addresses of NTP servers, used by this Workspace to synchronize its internal clock. If NTP is provided by DHCP, this setting will be ignored. Triggers a limited apply changes on the NTP service.
`repo_url`	URL of the repository server used to keep this Workspace up to date. Triggers a limited apply changes on the APT sources.
`vault_backup_enabled`	Whether or not to enable backups of the Vault service. There can be a short service interruption for SSO starting at the daily backup_time if this is enabled. If Vault is not included in the backup, SSO will fall back to pre-authentication when restoring from this backup.This option has no effect if no seal provider has been selected.
`system_message`	Message that is shown to logged-in users if system_message_enabled is True.
`app_session_failover`	Whether or not to failover application sessions when a node goes down
`seal_provider`
`trusted_ca`	Global level trusted Certificate Authorities
`license_enabled`
`default_domain`	Domain that is used by default when no other domain has been selected.
`anonymous_reporting_enabled`	Whether or not anonymized data is collected on this Workspace. If set to null, the System Settings will ask the administrator to make a choice next time he opens the System Settings. No data will be collected as long as this setting is set to null or false.
`proxy_enabled`	Whether or not an HTTP proxy is used for all outgoing HTTP requests. Triggers a limited apply changes on the HTTP proxy service.
`dbadmin_whitelisted_subnets`	List of IPv4 subnets from which clients are allowed to login with the local admin account.
`feature_flags`
`reverse_proxy_subnets`	List of IPv4 subnets that are considered to be reverse proxies by the Workspace.
`basic_sso_enabled`	Whether or not Basic SSO integration is enabled (for Pulse Connect Secure). Triggers a limited apply changes on the proxy service.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration partial_update -p id=... -p snmp_password=... -p hsts_enabled=... -p dbadmin_whitelisted_subnets_enabled=... -p upgrade_message_dismissed=... -p hsts_max_age=... -p license=... -p dns_ip=... -p system_message_enabled=... -p ssl_mode=... -p hsts_preload=... -p sftp_password=... -p hsts_include_subdomains=... -p proxy_url=... -p backup_encryption_password=... -p log_level_application_gateway=... -p snmp_enabled=... -p backup_time=... -p ntp_server=... -p repo_url=... -p vault_backup_enabled=... -p system_message=... -p app_session_failover=... -p seal_provider=... -p trusted_ca=... -p license_enabled=... -p default_domain=... -p anonymous_reporting_enabled=... -p proxy_enabled=... -p dbadmin_whitelisted_subnets=... -p feature_flags=... -p reverse_proxy_subnets=... -p basic_sso_enabled=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "partial_update"]
params = {
    "id": ...,
    "snmp_password": ...,
    "hsts_enabled": ...,
    "dbadmin_whitelisted_subnets_enabled": ...,
    "upgrade_message_dismissed": ...,
    "hsts_max_age": ...,
    "license": ...,
    "dns_ip": ...,
    "system_message_enabled": ...,
    "ssl_mode": ...,
    "hsts_preload": ...,
    "sftp_password": ...,
    "hsts_include_subdomains": ...,
    "proxy_url": ...,
    "backup_encryption_password": ...,
    "log_level_application_gateway": ...,
    "snmp_enabled": ...,
    "backup_time": ...,
    "ntp_server": ...,
    "repo_url": ...,
    "vault_backup_enabled": ...,
    "system_message": ...,
    "app_session_failover": ...,
    "seal_provider": ...,
    "trusted_ca": ...,
    "license_enabled": ...,
    "default_domain": ...,
    "anonymous_reporting_enabled": ...,
    "proxy_enabled": ...,
    "dbadmin_whitelisted_subnets": ...,
    "feature_flags": ...,
    "reverse_proxy_subnets": ...,
    "basic_sso_enabled": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    snmp_password='...';
    hsts_enabled='...';
    dbadmin_whitelisted_subnets_enabled='...';
    upgrade_message_dismissed='...';
    hsts_max_age='...';
    license='...';
    dns_ip='...';
    system_message_enabled='...';
    ssl_mode='...';
    hsts_preload='...';
    sftp_password='...';
    hsts_include_subdomains='...';
    proxy_url='...';
    backup_encryption_password='...';
    log_level_application_gateway='...';
    snmp_enabled='...';
    backup_time='...';
    ntp_server='...';
    repo_url='...';
    vault_backup_enabled='...';
    system_message='...';
    app_session_failover='...';
    seal_provider='...';
    trusted_ca='...';
    license_enabled='...';
    default_domain='...';
    anonymous_reporting_enabled='...';
    proxy_enabled='...';
    dbadmin_whitelisted_subnets='...';
    feature_flags='...';
    reverse_proxy_subnets='...';
    basic_sso_enabled='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/configuration/{id}/'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

system-message > read

GET /api/v2/configuration/system-message/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration system-message read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration", "system-message &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration/system-message/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

configuration-info

list

GET /api/v2/configuration-info/

Public read-only view of a subset of the configuration. Currently this is only used to be able to show the licensed customer on the login page.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration-info list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration-info", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration-info/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/configuration-info/{id}/

Public read-only view of a subset of the configuration. Currently this is only used to be able to show the licensed customer on the login page.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this configuration.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action configuration-info read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["configuration-info", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/configuration-info/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

contacts

list

GET /api/v2/contacts/

List of contact informations. For informational purposes only.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action contacts list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["contacts", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/contacts/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/contacts/{id}/

Get information of a contact. For informational purposes only.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this contact.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action contacts read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["contacts", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/contacts/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/contacts/{id}/

Update information of a contact. For informational purposes only.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this contact.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`address_line_1` required
`address_line_2` required
`city`	City or place name.
`country`	Country.
`location`	State or province.
`name`	Name.
`phone_number`	International phone number. Must start with "+", followed by digits.
`postal_code`	Postal code.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action contacts update -p id=... -p address_line_1=... -p address_line_2=... -p city=... -p country=... -p location=... -p name=... -p phone_number=... -p postal_code=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["contacts", "update"]
params = {
    "id": ...,
    "address_line_1": ...,
    "address_line_2": ...,
    "city": ...,
    "country": ...,
    "location": ...,
    "name": ...,
    "phone_number": ...,
    "postal_code": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    address_line_1='...';
    address_line_2='...';
    city='...';
    country='...';
    location='...';
    name='...';
    phone_number='...';
    postal_code='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/contacts/{id}/'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/contacts/{id}/

Update information of a contact. For informational purposes only.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this contact.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`address_line_1`
`address_line_2`
`city`	City or place name.
`country`	Country.
`location`	State or province.
`name`	Name.
`phone_number`	International phone number. Must start with "+", followed by digits.
`postal_code`	Postal code.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action contacts partial_update -p id=... -p address_line_1=... -p address_line_2=... -p city=... -p country=... -p location=... -p name=... -p phone_number=... -p postal_code=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["contacts", "partial_update"]
params = {
    "id": ...,
    "address_line_1": ...,
    "address_line_2": ...,
    "city": ...,
    "country": ...,
    "location": ...,
    "name": ...,
    "phone_number": ...,
    "postal_code": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    address_line_1='...';
    address_line_2='...';
    city='...';
    country='...';
    location='...';
    name='...';
    phone_number='...';
    postal_code='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/contacts/{id}/'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

domains

list

GET /api/v2/domains/

List domains.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains list -p limit=... -p offset=... -p ordering=... -p name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/?limit=...&offset=...&ordering=...&name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/domains/

Create a new domain.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`admin_user_labels`	List with labels in the format key:value that are used todefine which users have admin credentials.
`admin_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`app_session_upload_enabled`	Whether or not application session are recorded. The recordings are uploaded to the remote server specified by app_session_upload_url.
`app_session_upload_url`	URL of the fileserver to upload application session recordings to. Both WebDAV and SMB/CIFS fileservers are supported. For WebDAV, the URL structure is: http(s)://username:password@fqdn_or_ip/path/to/destination. For SMB/CIFS, the URL structure is smb://domain\username:password@fqdn_or_ip/share_name/path/to/destination. Recordings that cannot be uploaded will be removed after seven days.
`app_session_upload_use_domain_fqdn`	If True, the domain FQDN will be used in the username when contacting the SMB/CIFS fileserver. If False, the domain netbios will be used instead.
`app_session_keepalive_timeout`	Maximum time in minutes that disconnected application sessions are kept alive on the backend. Must be at least one 1 minute and at most 24 hours. Requires a manual apply changes using the Update API.
`base_dn` required	Used to bind to the Domain Controller or LDAP Server. E.g.: dc=domain,dc=local
`bind_name`	Username used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from the DC/LDAP server when SSO is enabled.
`bind_password`	Password used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from DC/LDAP server when SSO is enabled.
`create_bind_name`	Advanced setting to configure the function for "Create Bind Name".
`default_keyboard_layout`	Default keyboard layout for new users from this domain.
`default_locale`	This language is used as fall-back when the browser of the user does not support any of the languages.
`default_tours_enabled`	Enable/disable guided tours for all new users of this domain. Users can still manually enable/disable guided tours from their user profile.
`default_polygon_enabled`	Enable/disable polygon for all new users of this domain. Users can still manually enable/disable polygon from their user profile.
`default_profile_update_required`	When set a profile update is required at next sign in for all new users of this domain.
`dns_servers`	Comma separated list of IP addresses of the DNS server(s) used to resolve hostnames connected to this domain. Is typically equal to the IP(s) of the Domain Controller(s). E.g.: 172.1.0.1,172.1.0.2
`external_audit_enabled`	Enable to sent audit logs to external audit system
`external_audit_url`	The external audit URL. This is used to sent audit logs the external audit system.
`external_audit_basic_auth_enabled`	When enabled an authorization header will be added to requests made to the external_audit_url
`external_audit_username`	Username used when Basic Auth is enabled for external audit
`external_audit_password`	Password used when Basic Auth is enabled for external audit
`find_groups`	Advanced setting to configure the function for "Find Groups".
`fqdn` required	Used to sign in with e-mail address like user name. And for direct tcp SMB authentication. E.g. domain.local
`is_admin`	When set to true, admin users of this domain are allowed to configure all domains, global settings and have access to the Dashboard.
`ldap_ssl_enabled`	Is required to allow users to change their password via the Workspace. Requires SSL certificate on Domain Controller or LDAP Server.
`local_clipboard_push_max_size`	Maximum size in MB of data that can be pushed to the local clipboard, per clipboard data type. Must be minimum 5 and maximum 50 MB. This setting only applies to the async clipboard implementation.
`max_licensed`	The maximum number of users from this domain that can be signed in to the Workspace at the same time (concurrent users license), or the maximum number of users a domain may have (named users license).Only used when max_licensed_enabled is set to true.
`max_licensed_enabled`	Whether to limit the number of users from this domain that are signed in at the same time (concurrent users license) or the maximum number of users a domain may have (named users license).
`name` required	Domain name used in the Workspace. Multiple names can refer to the same NetBIOS name.
`netbios` required	NetBIOS name of the domain on the Domain Controller or LDAP Server.
`recorded_user_labels`	List with labels in the format key:value that are used todefine which sessions must be recorded.
`server` required	One or more (comma-separated) IPv4 addresses or FQDN's of the Domain Controller or LDAP Server. E.g. ad01.domain.local
`sign_in_user_labels`	List with labels in the format key:value that are used towhitelist users to sign in when whitelisting is enabled.
`sign_in_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`twofactor`	URI to a twofactor-provider. Set to none if no twofactor-provider is configured.
`twofactor_trusted_browser_enabled`	If enabled, users will be allowed to mark a browser as "trusted", so an MFA token is not required for the next 30 days.
`twofactor_whitelisted_subnets`	List of IPv4 subnets that do not have to perform MFA in order to sign in to the Workspace using this domain.
`twofactor_whitelisted_labels`	List with labels in the format key:value that are used toexempt users from doing MFA login.
`auth_provider`	URI to a auth-provider. Set to none if no auth-provider is configured.
`workspace_url`	The Workspace base URL. This is used to construct the redirect URL for the Authentication Provider.
`default_host_header`
`privacy_policy_acceptance_required`	If enabled (default), each user will have to accept the Privacy Policy the first time they sign in. Disabling means that this domain is not GDPR (European General Data Protection Regulation) compliant.
`apitoken_whitelisted_subnets_enabled`	If enabled, api calls using token authentication can only be done from the whitelisted subnets.
`apitoken_whitelisted_subnets`	List of IPv4 subnets that can perform api calls using token authentication when enabled.
`change_password_failed_msg_enabled`	If enabled, a message set by the admin will also be added to the api response
`change_password_failed_msg`	Set a custom password to show to user when they failed to change their password.
`sso_enabled`	Enable to for SSO with external IDP
`sso_ca_certificate`	Certificate Authority certificate for SSO
`sso_ca_private_key`
`sso_ca_crl_distribution_point`	CRL distribution point URL for SSO
`sso_ca_aia_issuers`	AIA CA issuers URL for SSO
`sso_trusted_roots`	Trusted roots for kerberos authentication for SSO.
`sso_ca_cert_pkcs_12_file`	PKCS12 file containing ca certificate and ca private key.Overwrites sso_ca_certificate/sso_ca_private_key if these are also supplied
`sso_ca_cert_pkcs_12_pwd`	Password protecting the ca cert/key PKCS12 file.
`sso_trusted_roots_pkcs_12_file`	PKCS12 file containing trusted roots. Overwrites sso_trusted_roots if it was also supplied
`sso_trusted_roots_pkcs_12_pwd`	Password protecting the trusted roots PKCS12 file.
`use_legacy_clipboard_implementation`	Force all applications to use the legacy clipboard implementation.
`use_legacy_keyboard_implementation`	Force all applications to use the legacy keyboard implementation.
`async_clipboard_timeout`	Timeout (in seconds) to wait for responses from the client or the application server in the new async clipboard implementation. Users will need to log out and back in to apply a new timeout to their application sessions.
`auto_sign_out_enabled`	Automatically sign out users inactive for a pre-defined amount of time.
`auto_sign_out_timeout`	Timeout (in seconds) to wait before signing out an inactive user.
`auto_sign_out_labels`	List with labels in the format key:value that are used to define for which users the auto sign out setting applies.
`trusted_ca`	Domain level trusted Certificate Authorities
`ssl_verification_external_audit`	Enable SSL verification for External Audit Logging.
`ssl_verification_reverse_proxy`	Enable SSL verification for Reverse Proxied Web Applications.
`ssl_verification_webdav`	Enable SSL verification for WebDAV.
`ssl_verification_pre_auth`	Enable SSL verification for Pre-auth/SSO metadata.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains create -p admin_user_labels=... -p admin_context_labels=... -p app_session_upload_enabled=... -p app_session_upload_url=... -p app_session_upload_use_domain_fqdn=... -p app_session_keepalive_timeout=... -p base_dn=... -p bind_name=... -p bind_password=... -p create_bind_name=... -p default_keyboard_layout=... -p default_locale=... -p default_tours_enabled=... -p default_polygon_enabled=... -p default_profile_update_required=... -p dns_servers=... -p external_audit_enabled=... -p external_audit_url=... -p external_audit_basic_auth_enabled=... -p external_audit_username=... -p external_audit_password=... -p find_groups=... -p fqdn=... -p is_admin=... -p ldap_ssl_enabled=... -p local_clipboard_push_max_size=... -p max_licensed=... -p max_licensed_enabled=... -p name=... -p netbios=... -p recorded_user_labels=... -p server=... -p sign_in_user_labels=... -p sign_in_context_labels=... -p twofactor=... -p twofactor_trusted_browser_enabled=... -p twofactor_whitelisted_subnets=... -p twofactor_whitelisted_labels=... -p auth_provider=... -p workspace_url=... -p default_host_header=... -p privacy_policy_acceptance_required=... -p apitoken_whitelisted_subnets_enabled=... -p apitoken_whitelisted_subnets=... -p change_password_failed_msg_enabled=... -p change_password_failed_msg=... -p sso_enabled=... -p sso_ca_certificate=... -p sso_ca_private_key=... -p sso_ca_crl_distribution_point=... -p sso_ca_aia_issuers=... -p sso_trusted_roots=... -p sso_ca_cert_pkcs_12_file=... -p sso_ca_cert_pkcs_12_pwd=... -p sso_trusted_roots_pkcs_12_file=... -p sso_trusted_roots_pkcs_12_pwd=... -p use_legacy_clipboard_implementation=... -p use_legacy_keyboard_implementation=... -p async_clipboard_timeout=... -p auto_sign_out_enabled=... -p auto_sign_out_timeout=... -p auto_sign_out_labels=... -p trusted_ca=... -p ssl_verification_external_audit=... -p ssl_verification_reverse_proxy=... -p ssl_verification_webdav=... -p ssl_verification_pre_auth=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "create"]
params = {
    "admin_user_labels": ...,
    "admin_context_labels": ...,
    "app_session_upload_enabled": ...,
    "app_session_upload_url": ...,
    "app_session_upload_use_domain_fqdn": ...,
    "app_session_keepalive_timeout": ...,
    "base_dn": ...,
    "bind_name": ...,
    "bind_password": ...,
    "create_bind_name": ...,
    "default_keyboard_layout": ...,
    "default_locale": ...,
    "default_tours_enabled": ...,
    "default_polygon_enabled": ...,
    "default_profile_update_required": ...,
    "dns_servers": ...,
    "external_audit_enabled": ...,
    "external_audit_url": ...,
    "external_audit_basic_auth_enabled": ...,
    "external_audit_username": ...,
    "external_audit_password": ...,
    "find_groups": ...,
    "fqdn": ...,
    "is_admin": ...,
    "ldap_ssl_enabled": ...,
    "local_clipboard_push_max_size": ...,
    "max_licensed": ...,
    "max_licensed_enabled": ...,
    "name": ...,
    "netbios": ...,
    "recorded_user_labels": ...,
    "server": ...,
    "sign_in_user_labels": ...,
    "sign_in_context_labels": ...,
    "twofactor": ...,
    "twofactor_trusted_browser_enabled": ...,
    "twofactor_whitelisted_subnets": ...,
    "twofactor_whitelisted_labels": ...,
    "auth_provider": ...,
    "workspace_url": ...,
    "default_host_header": ...,
    "privacy_policy_acceptance_required": ...,
    "apitoken_whitelisted_subnets_enabled": ...,
    "apitoken_whitelisted_subnets": ...,
    "change_password_failed_msg_enabled": ...,
    "change_password_failed_msg": ...,
    "sso_enabled": ...,
    "sso_ca_certificate": ...,
    "sso_ca_private_key": ...,
    "sso_ca_crl_distribution_point": ...,
    "sso_ca_aia_issuers": ...,
    "sso_trusted_roots": ...,
    "sso_ca_cert_pkcs_12_file": ...,
    "sso_ca_cert_pkcs_12_pwd": ...,
    "sso_trusted_roots_pkcs_12_file": ...,
    "sso_trusted_roots_pkcs_12_pwd": ...,
    "use_legacy_clipboard_implementation": ...,
    "use_legacy_keyboard_implementation": ...,
    "async_clipboard_timeout": ...,
    "auto_sign_out_enabled": ...,
    "auto_sign_out_timeout": ...,
    "auto_sign_out_labels": ...,
    "trusted_ca": ...,
    "ssl_verification_external_audit": ...,
    "ssl_verification_reverse_proxy": ...,
    "ssl_verification_webdav": ...,
    "ssl_verification_pre_auth": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    admin_user_labels='...';
    admin_context_labels='...';
    app_session_upload_enabled='...';
    app_session_upload_url='...';
    app_session_upload_use_domain_fqdn='...';
    app_session_keepalive_timeout='...';
    base_dn='...';
    bind_name='...';
    bind_password='...';
    create_bind_name='...';
    default_keyboard_layout='...';
    default_locale='...';
    default_tours_enabled='...';
    default_polygon_enabled='...';
    default_profile_update_required='...';
    dns_servers='...';
    external_audit_enabled='...';
    external_audit_url='...';
    external_audit_basic_auth_enabled='...';
    external_audit_username='...';
    external_audit_password='...';
    find_groups='...';
    fqdn='...';
    is_admin='...';
    ldap_ssl_enabled='...';
    local_clipboard_push_max_size='...';
    max_licensed='...';
    max_licensed_enabled='...';
    name='...';
    netbios='...';
    recorded_user_labels='...';
    server='...';
    sign_in_user_labels='...';
    sign_in_context_labels='...';
    twofactor='...';
    twofactor_trusted_browser_enabled='...';
    twofactor_whitelisted_subnets='...';
    twofactor_whitelisted_labels='...';
    auth_provider='...';
    workspace_url='...';
    default_host_header='...';
    privacy_policy_acceptance_required='...';
    apitoken_whitelisted_subnets_enabled='...';
    apitoken_whitelisted_subnets='...';
    change_password_failed_msg_enabled='...';
    change_password_failed_msg='...';
    sso_enabled='...';
    sso_ca_certificate='...';
    sso_ca_private_key='...';
    sso_ca_crl_distribution_point='...';
    sso_ca_aia_issuers='...';
    sso_trusted_roots='...';
    sso_ca_cert_pkcs_12_file='...';
    sso_ca_cert_pkcs_12_pwd='...';
    sso_trusted_roots_pkcs_12_file='...';
    sso_trusted_roots_pkcs_12_pwd='...';
    use_legacy_clipboard_implementation='...';
    use_legacy_keyboard_implementation='...';
    async_clipboard_timeout='...';
    auto_sign_out_enabled='...';
    auto_sign_out_timeout='...';
    auto_sign_out_labels='...';
    trusted_ca='...';
    ssl_verification_external_audit='...';
    ssl_verification_reverse_proxy='...';
    ssl_verification_webdav='...';
    ssl_verification_pre_auth='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/domains/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/domains/{id}/

Get details for a domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains read -p id=... -p ordering=... -p name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/?ordering=...&name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/domains/{id}/

Update details for a domain. The name cannot be changed on an existing domain. Only global administrators can configure all fields; domain administrators can only configure a subset of fields (cf. the returned fields when reading a domain).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`name`	Domain name to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`admin_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`admin_user_labels`	List with labels in the format key:value that are used todefine which users have admin credentials.
`apitoken_whitelisted_subnets`	List of IPv4 subnets that can perform api calls using token authentication when enabled.
`apitoken_whitelisted_subnets_enabled`	If enabled, api calls using token authentication can only be done from the whitelisted subnets.
`app_session_keepalive_timeout`	Maximum time in minutes that disconnected application sessions are kept alive on the backend. Must be at least one 1 minute and at most 24 hours. Requires a manual apply changes using the Update API.
`app_session_upload_enabled`	Whether or not application session are recorded. The recordings are uploaded to the remote server specified by app_session_upload_url.
`app_session_upload_url`	URL of the fileserver to upload application session recordings to. Both WebDAV and SMB/CIFS fileservers are supported. For WebDAV, the URL structure is: http(s)://username:password@fqdn_or_ip/path/to/destination. For SMB/CIFS, the URL structure is smb://domain\username:password@fqdn_or_ip/share_name/path/to/destination. Recordings that cannot be uploaded will be removed after seven days.
`app_session_upload_use_domain_fqdn`	If True, the domain FQDN will be used in the username when contacting the SMB/CIFS fileserver. If False, the domain netbios will be used instead.
`async_clipboard_timeout`	Timeout (in seconds) to wait for responses from the client or the application server in the new async clipboard implementation. Users will need to log out and back in to apply a new timeout to their application sessions.
`auth_provider`	URI to a auth-provider. Set to none if no auth-provider is configured.
`auto_sign_out_enabled`	Automatically sign out users inactive for a pre-defined amount of time.
`auto_sign_out_labels`	List with labels in the format key:value that are used to define for which users the auto sign out setting applies.
`auto_sign_out_timeout`	Timeout (in seconds) to wait before signing out an inactive user.
`base_dn` required	Used to bind to the Domain Controller or LDAP Server. E.g.: dc=domain,dc=local
`bind_name`	Username used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from the DC/LDAP server when SSO is enabled.
`bind_password`	Password used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from DC/LDAP server when SSO is enabled.
`change_password_failed_msg`	Set a custom password to show to user when they failed to change their password.
`change_password_failed_msg_enabled`	If enabled, a message set by the admin will also be added to the api response
`create_bind_name`	Advanced setting to configure the function for "Create Bind Name".
`default_host_header`
`default_keyboard_layout`	Default keyboard layout for new users from this domain.
`default_locale`	This language is used as fall-back when the browser of the user does not support any of the languages.
`default_polygon_enabled`	Enable/disable polygon for all new users of this domain. Users can still manually enable/disable polygon from their user profile.
`default_profile_update_required`	When set a profile update is required at next sign in for all new users of this domain.
`default_tours_enabled`	Enable/disable guided tours for all new users of this domain. Users can still manually enable/disable guided tours from their user profile.
`dns_servers`	Comma separated list of IP addresses of the DNS server(s) used to resolve hostnames connected to this domain. Is typically equal to the IP(s) of the Domain Controller(s). E.g.: 172.1.0.1,172.1.0.2
`external_audit_basic_auth_enabled`	When enabled an authorization header will be added to requests made to the external_audit_url
`external_audit_enabled`	Enable to sent audit logs to external audit system
`external_audit_password`	Password used when Basic Auth is enabled for external audit
`external_audit_url`	The external audit URL. This is used to sent audit logs the external audit system.
`external_audit_username`	Username used when Basic Auth is enabled for external audit
`find_groups`	Advanced setting to configure the function for "Find Groups".
`fqdn` required	Used to sign in with e-mail address like user name. And for direct tcp SMB authentication. E.g. domain.local
`is_admin`	When set to true, admin users of this domain are allowed to configure all domains, global settings and have access to the Dashboard.
`ldap_ssl_enabled`	Is required to allow users to change their password via the Workspace. Requires SSL certificate on Domain Controller or LDAP Server.
`local_clipboard_push_max_size`	Maximum size in MB of data that can be pushed to the local clipboard, per clipboard data type. Must be minimum 5 and maximum 50 MB. This setting only applies to the async clipboard implementation.
`max_licensed`	The maximum number of users from this domain that can be signed in to the Workspace at the same time (concurrent users license), or the maximum number of users a domain may have (named users license).Only used when max_licensed_enabled is set to true.
`max_licensed_enabled`	Whether to limit the number of users from this domain that are signed in at the same time (concurrent users license) or the maximum number of users a domain may have (named users license).
`netbios` required	NetBIOS name of the domain on the Domain Controller or LDAP Server.
`privacy_policy_acceptance_required`	If enabled (default), each user will have to accept the Privacy Policy the first time they sign in. Disabling means that this domain is not GDPR (European General Data Protection Regulation) compliant.
`recorded_user_labels`	List with labels in the format key:value that are used todefine which sessions must be recorded.
`server` required	One or more (comma-separated) IPv4 addresses or FQDN's of the Domain Controller or LDAP Server. E.g. ad01.domain.local
`sign_in_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`sign_in_user_labels`	List with labels in the format key:value that are used towhitelist users to sign in when whitelisting is enabled.
`ssl_verification_external_audit`	Enable SSL verification for External Audit Logging.
`ssl_verification_pre_auth`	Enable SSL verification for Pre-auth/SSO metadata.
`ssl_verification_reverse_proxy`	Enable SSL verification for Reverse Proxied Web Applications.
`ssl_verification_webdav`	Enable SSL verification for WebDAV.
`sso_ca_aia_issuers`	AIA CA issuers URL for SSO
`sso_ca_cert_pkcs_12_file`	PKCS12 file containing ca certificate and ca private key.Overwrites sso_ca_certificate/sso_ca_private_key if these are also supplied
`sso_ca_cert_pkcs_12_pwd`	Password protecting the ca cert/key PKCS12 file.
`sso_ca_certificate`	Certificate Authority certificate for SSO
`sso_ca_crl_distribution_point`	CRL distribution point URL for SSO
`sso_ca_private_key`
`sso_enabled`	Enable to for SSO with external IDP
`sso_trusted_roots`	Trusted roots for kerberos authentication for SSO.
`sso_trusted_roots_pkcs_12_file`	PKCS12 file containing trusted roots. Overwrites sso_trusted_roots if it was also supplied
`sso_trusted_roots_pkcs_12_pwd`	Password protecting the trusted roots PKCS12 file.
`trusted_ca`	Domain level trusted Certificate Authorities
`twofactor`	URI to a twofactor-provider.
`twofactor_trusted_browser_enabled`	If enabled, users will be allowed to mark a browser as "trusted", so an MFA token is not required for the next 30 days.
`twofactor_whitelisted_labels`	List with labels in the format key:value that are used toexempt users from doing MFA login.
`twofactor_whitelisted_subnets`	List of IPv4 subnets that do not have to perform MFA in order to sign in to the Workspace using this domain.
`use_legacy_clipboard_implementation`	Force all applications to use the legacy clipboard implementation.
`use_legacy_keyboard_implementation`	Force all applications to use the legacy keyboard implementation.
`workspace_url`	The Workspace base URL. This is used to construct the redirect URL for the Authentication Provider.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains update -p id=... -p admin_context_labels=... -p admin_user_labels=... -p apitoken_whitelisted_subnets=... -p apitoken_whitelisted_subnets_enabled=... -p app_session_keepalive_timeout=... -p app_session_upload_enabled=... -p app_session_upload_url=... -p app_session_upload_use_domain_fqdn=... -p async_clipboard_timeout=... -p auth_provider=... -p auto_sign_out_enabled=... -p auto_sign_out_labels=... -p auto_sign_out_timeout=... -p base_dn=... -p bind_name=... -p bind_password=... -p change_password_failed_msg=... -p change_password_failed_msg_enabled=... -p create_bind_name=... -p default_host_header=... -p default_keyboard_layout=... -p default_locale=... -p default_polygon_enabled=... -p default_profile_update_required=... -p default_tours_enabled=... -p dns_servers=... -p external_audit_basic_auth_enabled=... -p external_audit_enabled=... -p external_audit_password=... -p external_audit_url=... -p external_audit_username=... -p find_groups=... -p fqdn=... -p is_admin=... -p ldap_ssl_enabled=... -p local_clipboard_push_max_size=... -p max_licensed=... -p max_licensed_enabled=... -p netbios=... -p privacy_policy_acceptance_required=... -p recorded_user_labels=... -p server=... -p sign_in_context_labels=... -p sign_in_user_labels=... -p ssl_verification_external_audit=... -p ssl_verification_pre_auth=... -p ssl_verification_reverse_proxy=... -p ssl_verification_webdav=... -p sso_ca_aia_issuers=... -p sso_ca_cert_pkcs_12_file=... -p sso_ca_cert_pkcs_12_pwd=... -p sso_ca_certificate=... -p sso_ca_crl_distribution_point=... -p sso_ca_private_key=... -p sso_enabled=... -p sso_trusted_roots=... -p sso_trusted_roots_pkcs_12_file=... -p sso_trusted_roots_pkcs_12_pwd=... -p trusted_ca=... -p twofactor=... -p twofactor_trusted_browser_enabled=... -p twofactor_whitelisted_labels=... -p twofactor_whitelisted_subnets=... -p use_legacy_clipboard_implementation=... -p use_legacy_keyboard_implementation=... -p workspace_url=... -p ordering=... -p name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "update"]
params = {
    "id": ...,
    "admin_context_labels": ...,
    "admin_user_labels": ...,
    "apitoken_whitelisted_subnets": ...,
    "apitoken_whitelisted_subnets_enabled": ...,
    "app_session_keepalive_timeout": ...,
    "app_session_upload_enabled": ...,
    "app_session_upload_url": ...,
    "app_session_upload_use_domain_fqdn": ...,
    "async_clipboard_timeout": ...,
    "auth_provider": ...,
    "auto_sign_out_enabled": ...,
    "auto_sign_out_labels": ...,
    "auto_sign_out_timeout": ...,
    "base_dn": ...,
    "bind_name": ...,
    "bind_password": ...,
    "change_password_failed_msg": ...,
    "change_password_failed_msg_enabled": ...,
    "create_bind_name": ...,
    "default_host_header": ...,
    "default_keyboard_layout": ...,
    "default_locale": ...,
    "default_polygon_enabled": ...,
    "default_profile_update_required": ...,
    "default_tours_enabled": ...,
    "dns_servers": ...,
    "external_audit_basic_auth_enabled": ...,
    "external_audit_enabled": ...,
    "external_audit_password": ...,
    "external_audit_url": ...,
    "external_audit_username": ...,
    "find_groups": ...,
    "fqdn": ...,
    "is_admin": ...,
    "ldap_ssl_enabled": ...,
    "local_clipboard_push_max_size": ...,
    "max_licensed": ...,
    "max_licensed_enabled": ...,
    "netbios": ...,
    "privacy_policy_acceptance_required": ...,
    "recorded_user_labels": ...,
    "server": ...,
    "sign_in_context_labels": ...,
    "sign_in_user_labels": ...,
    "ssl_verification_external_audit": ...,
    "ssl_verification_pre_auth": ...,
    "ssl_verification_reverse_proxy": ...,
    "ssl_verification_webdav": ...,
    "sso_ca_aia_issuers": ...,
    "sso_ca_cert_pkcs_12_file": ...,
    "sso_ca_cert_pkcs_12_pwd": ...,
    "sso_ca_certificate": ...,
    "sso_ca_crl_distribution_point": ...,
    "sso_ca_private_key": ...,
    "sso_enabled": ...,
    "sso_trusted_roots": ...,
    "sso_trusted_roots_pkcs_12_file": ...,
    "sso_trusted_roots_pkcs_12_pwd": ...,
    "trusted_ca": ...,
    "twofactor": ...,
    "twofactor_trusted_browser_enabled": ...,
    "twofactor_whitelisted_labels": ...,
    "twofactor_whitelisted_subnets": ...,
    "use_legacy_clipboard_implementation": ...,
    "use_legacy_keyboard_implementation": ...,
    "workspace_url": ...,
    "ordering": ...,
    "name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    admin_context_labels='...';
    admin_user_labels='...';
    apitoken_whitelisted_subnets='...';
    apitoken_whitelisted_subnets_enabled='...';
    app_session_keepalive_timeout='...';
    app_session_upload_enabled='...';
    app_session_upload_url='...';
    app_session_upload_use_domain_fqdn='...';
    async_clipboard_timeout='...';
    auth_provider='...';
    auto_sign_out_enabled='...';
    auto_sign_out_labels='...';
    auto_sign_out_timeout='...';
    base_dn='...';
    bind_name='...';
    bind_password='...';
    change_password_failed_msg='...';
    change_password_failed_msg_enabled='...';
    create_bind_name='...';
    default_host_header='...';
    default_keyboard_layout='...';
    default_locale='...';
    default_polygon_enabled='...';
    default_profile_update_required='...';
    default_tours_enabled='...';
    dns_servers='...';
    external_audit_basic_auth_enabled='...';
    external_audit_enabled='...';
    external_audit_password='...';
    external_audit_url='...';
    external_audit_username='...';
    find_groups='...';
    fqdn='...';
    is_admin='...';
    ldap_ssl_enabled='...';
    local_clipboard_push_max_size='...';
    max_licensed='...';
    max_licensed_enabled='...';
    netbios='...';
    privacy_policy_acceptance_required='...';
    recorded_user_labels='...';
    server='...';
    sign_in_context_labels='...';
    sign_in_user_labels='...';
    ssl_verification_external_audit='...';
    ssl_verification_pre_auth='...';
    ssl_verification_reverse_proxy='...';
    ssl_verification_webdav='...';
    sso_ca_aia_issuers='...';
    sso_ca_cert_pkcs_12_file='...';
    sso_ca_cert_pkcs_12_pwd='...';
    sso_ca_certificate='...';
    sso_ca_crl_distribution_point='...';
    sso_ca_private_key='...';
    sso_enabled='...';
    sso_trusted_roots='...';
    sso_trusted_roots_pkcs_12_file='...';
    sso_trusted_roots_pkcs_12_pwd='...';
    trusted_ca='...';
    twofactor='...';
    twofactor_trusted_browser_enabled='...';
    twofactor_whitelisted_labels='...';
    twofactor_whitelisted_subnets='...';
    use_legacy_clipboard_implementation='...';
    use_legacy_keyboard_implementation='...';
    workspace_url='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/?ordering=...&name=...&search=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/domains/{id}/

Update some details of domain. Note that the name cannot be changed on an existing domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`name`	Domain name to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`admin_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`admin_user_labels`	List with labels in the format key:value that are used todefine which users have admin credentials.
`apitoken_whitelisted_subnets`	List of IPv4 subnets that can perform api calls using token authentication when enabled.
`apitoken_whitelisted_subnets_enabled`	If enabled, api calls using token authentication can only be done from the whitelisted subnets.
`app_session_keepalive_timeout`	Maximum time in minutes that disconnected application sessions are kept alive on the backend. Must be at least one 1 minute and at most 24 hours. Requires a manual apply changes using the Update API.
`app_session_upload_enabled`	Whether or not application session are recorded. The recordings are uploaded to the remote server specified by app_session_upload_url.
`app_session_upload_url`	URL of the fileserver to upload application session recordings to. Both WebDAV and SMB/CIFS fileservers are supported. For WebDAV, the URL structure is: http(s)://username:password@fqdn_or_ip/path/to/destination. For SMB/CIFS, the URL structure is smb://domain\username:password@fqdn_or_ip/share_name/path/to/destination. Recordings that cannot be uploaded will be removed after seven days.
`app_session_upload_use_domain_fqdn`	If True, the domain FQDN will be used in the username when contacting the SMB/CIFS fileserver. If False, the domain netbios will be used instead.
`async_clipboard_timeout`	Timeout (in seconds) to wait for responses from the client or the application server in the new async clipboard implementation. Users will need to log out and back in to apply a new timeout to their application sessions.
`auth_provider`	URI to a auth-provider. Set to none if no auth-provider is configured.
`auto_sign_out_enabled`	Automatically sign out users inactive for a pre-defined amount of time.
`auto_sign_out_labels`	List with labels in the format key:value that are used to define for which users the auto sign out setting applies.
`auto_sign_out_timeout`	Timeout (in seconds) to wait before signing out an inactive user.
`base_dn`	Used to bind to the Domain Controller or LDAP Server. E.g.: dc=domain,dc=local
`bind_name`	Username used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from the DC/LDAP server when SSO is enabled.
`bind_password`	Password used for import of labels (groups and users) and application servers. It is also used to fetch a user's objectSid attribute from DC/LDAP server when SSO is enabled.
`change_password_failed_msg`	Set a custom password to show to user when they failed to change their password.
`change_password_failed_msg_enabled`	If enabled, a message set by the admin will also be added to the api response
`create_bind_name`	Advanced setting to configure the function for "Create Bind Name".
`default_host_header`
`default_keyboard_layout`	Default keyboard layout for new users from this domain.
`default_locale`	This language is used as fall-back when the browser of the user does not support any of the languages.
`default_polygon_enabled`	Enable/disable polygon for all new users of this domain. Users can still manually enable/disable polygon from their user profile.
`default_profile_update_required`	When set a profile update is required at next sign in for all new users of this domain.
`default_tours_enabled`	Enable/disable guided tours for all new users of this domain. Users can still manually enable/disable guided tours from their user profile.
`dns_servers`	Comma separated list of IP addresses of the DNS server(s) used to resolve hostnames connected to this domain. Is typically equal to the IP(s) of the Domain Controller(s). E.g.: 172.1.0.1,172.1.0.2
`external_audit_basic_auth_enabled`	When enabled an authorization header will be added to requests made to the external_audit_url
`external_audit_enabled`	Enable to sent audit logs to external audit system
`external_audit_password`	Password used when Basic Auth is enabled for external audit
`external_audit_url`	The external audit URL. This is used to sent audit logs the external audit system.
`external_audit_username`	Username used when Basic Auth is enabled for external audit
`find_groups`	Advanced setting to configure the function for "Find Groups".
`fqdn`	Used to sign in with e-mail address like user name. And for direct tcp SMB authentication. E.g. domain.local
`is_admin`	When set to true, admin users of this domain are allowed to configure all domains, global settings and have access to the Dashboard.
`ldap_ssl_enabled`	Is required to allow users to change their password via the Workspace. Requires SSL certificate on Domain Controller or LDAP Server.
`local_clipboard_push_max_size`	Maximum size in MB of data that can be pushed to the local clipboard, per clipboard data type. Must be minimum 5 and maximum 50 MB. This setting only applies to the async clipboard implementation.
`max_licensed`	The maximum number of users from this domain that can be signed in to the Workspace at the same time (concurrent users license), or the maximum number of users a domain may have (named users license).Only used when max_licensed_enabled is set to true.
`max_licensed_enabled`	Whether to limit the number of users from this domain that are signed in at the same time (concurrent users license) or the maximum number of users a domain may have (named users license).
`netbios`	NetBIOS name of the domain on the Domain Controller or LDAP Server.
`privacy_policy_acceptance_required`	If enabled (default), each user will have to accept the Privacy Policy the first time they sign in. Disabling means that this domain is not GDPR (European General Data Protection Regulation) compliant.
`recorded_user_labels`	List with labels in the format key:value that are used todefine which sessions must be recorded.
`server`	One or more (comma-separated) IPv4 addresses or FQDN's of the Domain Controller or LDAP Server. E.g. ad01.domain.local
`sign_in_context_labels`	List with labels in the format key:value. These can be used for context awareness.
`sign_in_user_labels`	List with labels in the format key:value that are used towhitelist users to sign in when whitelisting is enabled.
`ssl_verification_external_audit`	Enable SSL verification for External Audit Logging.
`ssl_verification_pre_auth`	Enable SSL verification for Pre-auth/SSO metadata.
`ssl_verification_reverse_proxy`	Enable SSL verification for Reverse Proxied Web Applications.
`ssl_verification_webdav`	Enable SSL verification for WebDAV.
`sso_ca_aia_issuers`	AIA CA issuers URL for SSO
`sso_ca_cert_pkcs_12_file`	PKCS12 file containing ca certificate and ca private key.Overwrites sso_ca_certificate/sso_ca_private_key if these are also supplied
`sso_ca_cert_pkcs_12_pwd`	Password protecting the ca cert/key PKCS12 file.
`sso_ca_certificate`	Certificate Authority certificate for SSO
`sso_ca_crl_distribution_point`	CRL distribution point URL for SSO
`sso_ca_private_key`
`sso_enabled`	Enable to for SSO with external IDP
`sso_trusted_roots`	Trusted roots for kerberos authentication for SSO.
`sso_trusted_roots_pkcs_12_file`	PKCS12 file containing trusted roots. Overwrites sso_trusted_roots if it was also supplied
`sso_trusted_roots_pkcs_12_pwd`	Password protecting the trusted roots PKCS12 file.
`trusted_ca`	Domain level trusted Certificate Authorities
`twofactor`	URI to a twofactor-provider.
`twofactor_trusted_browser_enabled`	If enabled, users will be allowed to mark a browser as "trusted", so an MFA token is not required for the next 30 days.
`twofactor_whitelisted_labels`	List with labels in the format key:value that are used toexempt users from doing MFA login.
`twofactor_whitelisted_subnets`	List of IPv4 subnets that do not have to perform MFA in order to sign in to the Workspace using this domain.
`use_legacy_clipboard_implementation`	Force all applications to use the legacy clipboard implementation.
`use_legacy_keyboard_implementation`	Force all applications to use the legacy keyboard implementation.
`workspace_url`	The Workspace base URL. This is used to construct the redirect URL for the Authentication Provider.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains partial_update -p id=... -p admin_context_labels=... -p admin_user_labels=... -p apitoken_whitelisted_subnets=... -p apitoken_whitelisted_subnets_enabled=... -p app_session_keepalive_timeout=... -p app_session_upload_enabled=... -p app_session_upload_url=... -p app_session_upload_use_domain_fqdn=... -p async_clipboard_timeout=... -p auth_provider=... -p auto_sign_out_enabled=... -p auto_sign_out_labels=... -p auto_sign_out_timeout=... -p base_dn=... -p bind_name=... -p bind_password=... -p change_password_failed_msg=... -p change_password_failed_msg_enabled=... -p create_bind_name=... -p default_host_header=... -p default_keyboard_layout=... -p default_locale=... -p default_polygon_enabled=... -p default_profile_update_required=... -p default_tours_enabled=... -p dns_servers=... -p external_audit_basic_auth_enabled=... -p external_audit_enabled=... -p external_audit_password=... -p external_audit_url=... -p external_audit_username=... -p find_groups=... -p fqdn=... -p is_admin=... -p ldap_ssl_enabled=... -p local_clipboard_push_max_size=... -p max_licensed=... -p max_licensed_enabled=... -p netbios=... -p privacy_policy_acceptance_required=... -p recorded_user_labels=... -p server=... -p sign_in_context_labels=... -p sign_in_user_labels=... -p ssl_verification_external_audit=... -p ssl_verification_pre_auth=... -p ssl_verification_reverse_proxy=... -p ssl_verification_webdav=... -p sso_ca_aia_issuers=... -p sso_ca_cert_pkcs_12_file=... -p sso_ca_cert_pkcs_12_pwd=... -p sso_ca_certificate=... -p sso_ca_crl_distribution_point=... -p sso_ca_private_key=... -p sso_enabled=... -p sso_trusted_roots=... -p sso_trusted_roots_pkcs_12_file=... -p sso_trusted_roots_pkcs_12_pwd=... -p trusted_ca=... -p twofactor=... -p twofactor_trusted_browser_enabled=... -p twofactor_whitelisted_labels=... -p twofactor_whitelisted_subnets=... -p use_legacy_clipboard_implementation=... -p use_legacy_keyboard_implementation=... -p workspace_url=... -p ordering=... -p name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "partial_update"]
params = {
    "id": ...,
    "admin_context_labels": ...,
    "admin_user_labels": ...,
    "apitoken_whitelisted_subnets": ...,
    "apitoken_whitelisted_subnets_enabled": ...,
    "app_session_keepalive_timeout": ...,
    "app_session_upload_enabled": ...,
    "app_session_upload_url": ...,
    "app_session_upload_use_domain_fqdn": ...,
    "async_clipboard_timeout": ...,
    "auth_provider": ...,
    "auto_sign_out_enabled": ...,
    "auto_sign_out_labels": ...,
    "auto_sign_out_timeout": ...,
    "base_dn": ...,
    "bind_name": ...,
    "bind_password": ...,
    "change_password_failed_msg": ...,
    "change_password_failed_msg_enabled": ...,
    "create_bind_name": ...,
    "default_host_header": ...,
    "default_keyboard_layout": ...,
    "default_locale": ...,
    "default_polygon_enabled": ...,
    "default_profile_update_required": ...,
    "default_tours_enabled": ...,
    "dns_servers": ...,
    "external_audit_basic_auth_enabled": ...,
    "external_audit_enabled": ...,
    "external_audit_password": ...,
    "external_audit_url": ...,
    "external_audit_username": ...,
    "find_groups": ...,
    "fqdn": ...,
    "is_admin": ...,
    "ldap_ssl_enabled": ...,
    "local_clipboard_push_max_size": ...,
    "max_licensed": ...,
    "max_licensed_enabled": ...,
    "netbios": ...,
    "privacy_policy_acceptance_required": ...,
    "recorded_user_labels": ...,
    "server": ...,
    "sign_in_context_labels": ...,
    "sign_in_user_labels": ...,
    "ssl_verification_external_audit": ...,
    "ssl_verification_pre_auth": ...,
    "ssl_verification_reverse_proxy": ...,
    "ssl_verification_webdav": ...,
    "sso_ca_aia_issuers": ...,
    "sso_ca_cert_pkcs_12_file": ...,
    "sso_ca_cert_pkcs_12_pwd": ...,
    "sso_ca_certificate": ...,
    "sso_ca_crl_distribution_point": ...,
    "sso_ca_private_key": ...,
    "sso_enabled": ...,
    "sso_trusted_roots": ...,
    "sso_trusted_roots_pkcs_12_file": ...,
    "sso_trusted_roots_pkcs_12_pwd": ...,
    "trusted_ca": ...,
    "twofactor": ...,
    "twofactor_trusted_browser_enabled": ...,
    "twofactor_whitelisted_labels": ...,
    "twofactor_whitelisted_subnets": ...,
    "use_legacy_clipboard_implementation": ...,
    "use_legacy_keyboard_implementation": ...,
    "workspace_url": ...,
    "ordering": ...,
    "name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    admin_context_labels='...';
    admin_user_labels='...';
    apitoken_whitelisted_subnets='...';
    apitoken_whitelisted_subnets_enabled='...';
    app_session_keepalive_timeout='...';
    app_session_upload_enabled='...';
    app_session_upload_url='...';
    app_session_upload_use_domain_fqdn='...';
    async_clipboard_timeout='...';
    auth_provider='...';
    auto_sign_out_enabled='...';
    auto_sign_out_labels='...';
    auto_sign_out_timeout='...';
    base_dn='...';
    bind_name='...';
    bind_password='...';
    change_password_failed_msg='...';
    change_password_failed_msg_enabled='...';
    create_bind_name='...';
    default_host_header='...';
    default_keyboard_layout='...';
    default_locale='...';
    default_polygon_enabled='...';
    default_profile_update_required='...';
    default_tours_enabled='...';
    dns_servers='...';
    external_audit_basic_auth_enabled='...';
    external_audit_enabled='...';
    external_audit_password='...';
    external_audit_url='...';
    external_audit_username='...';
    find_groups='...';
    fqdn='...';
    is_admin='...';
    ldap_ssl_enabled='...';
    local_clipboard_push_max_size='...';
    max_licensed='...';
    max_licensed_enabled='...';
    netbios='...';
    privacy_policy_acceptance_required='...';
    recorded_user_labels='...';
    server='...';
    sign_in_context_labels='...';
    sign_in_user_labels='...';
    ssl_verification_external_audit='...';
    ssl_verification_pre_auth='...';
    ssl_verification_reverse_proxy='...';
    ssl_verification_webdav='...';
    sso_ca_aia_issuers='...';
    sso_ca_cert_pkcs_12_file='...';
    sso_ca_cert_pkcs_12_pwd='...';
    sso_ca_certificate='...';
    sso_ca_crl_distribution_point='...';
    sso_ca_private_key='...';
    sso_enabled='...';
    sso_trusted_roots='...';
    sso_trusted_roots_pkcs_12_file='...';
    sso_trusted_roots_pkcs_12_pwd='...';
    trusted_ca='...';
    twofactor='...';
    twofactor_trusted_browser_enabled='...';
    twofactor_whitelisted_labels='...';
    twofactor_whitelisted_subnets='...';
    use_legacy_clipboard_implementation='...';
    use_legacy_keyboard_implementation='...';
    workspace_url='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/?ordering=...&name=...&search=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/domains/{id}/

Delete a domain. This will also delete all information attached to this domain, such as applications, drives, users, and domain specific configuration. Deleting a domain that is currently the default domain is only possible by first setting another domain as the default domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`name`	Domain name to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains delete -p id=... -p ordering=... -p name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/?ordering=...&name=...&search=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

query_ldap_appservers

GET /api/v2/domains/{id}/query-ldap-appservers/

Do an LDAP query to the LDAP-server for servers defined in the domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains query_ldap_appservers -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "query_ldap_appservers"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/query-ldap-appservers/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

query_ldap_groups

GET /api/v2/domains/{id}/query-ldap-groups/

Do an LDAP query to the LDAP-server for groups defined in the domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains query_ldap_groups -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "query_ldap_groups"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/query-ldap-groups/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

query_ldap_users

GET /api/v2/domains/{id}/query-ldap-users/

Do an LDAP query to the LDAP-server for users defined in the domain.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action domains query_ldap_users -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["domains", "query_ldap_users"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/domains/{id}/query-ldap-users/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

drives

list

GET /api/v2/drives/

List drives, which can be filtered with parameters "domain" (by ID) or "domain_name".

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	Return only files for filtered user, also for admins
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p user=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&user=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/drives/

Create a new drive.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives create -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "create"]
params = {
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

backends

GET /api/v2/drives/backends/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives backends

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "backends"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/backends/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/drives/{id}/

Get details of a drive. A drive corresponds to a shared resource on a file server and is shown in the left column of the Files tab in the Workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	Return only files for filtered user, also for admins
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives read -p id=... -p ordering=... -p domain=... -p domain_name=... -p user=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/?ordering=...&domain=...&domain_name=...&user=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/drives/{id}/

Update details of a drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	Return only files for filtered user, also for admins
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives update -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=... -p ordering=... -p domain=... -p domain_name=... -p user=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "update"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/?ordering=...&domain=...&domain_name=...&user=...&search=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/drives/{id}/

Update some details of a drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	Return only files for filtered user, also for admins
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend`	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels`	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config`	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description`	Free text description of the drive.
`domain`	URI to the domain this drive belongs to.
`name`	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url`	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels`	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels`	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives partial_update -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=... -p ordering=... -p domain=... -p domain_name=... -p user=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "partial_update"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/?ordering=...&domain=...&domain_name=...&user=...&search=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/drives/{id}/

Delete a drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	Return only files for filtered user, also for admins
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives delete -p id=... -p ordering=... -p domain=... -p domain_name=... -p user=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/?ordering=...&domain=...&domain_name=...&user=...&search=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

copy

POST /api/v2/drives/{id}/copy/

Copy files and folders from this drive to the same or another drive. * source_paths: List of paths of the files and/or folders to copy. Paths are absolute w.r.t. to root of the drive. * destination_drive: URI of the destination drive. If omitted, the current drive is used. * destination_path: Path to the folder to copy the files and/or folders to. The path is absolute w.r.t. to root of the (destination) drive. Use "/" to copy to the root.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives copy -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "copy"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/copy/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

download

GET /api/v2/drives/{id}/download/

Download one or multiple file(s) and/or folder(s) on the given path(s). * path: Absolute path (w.r.t. the root of the drive) to download. Use "/" ("%2F") to download a complete drive. Supply multiple path arguments to download multiple combined. generate-preview: Generate a preview for the file on the given path within a drive. This will return a link which can be polled and where when completed a url will be provided on which the generated preview will be available. * path: Absolute path (w.r.t. the root of the drive) to generate a preview for. get-preview: Show the preview of the file on the given path within a drive. If the file requires a conversion (any non video/audio/image files), it first needs to be generated using generate-preview. * path: Absolute path (w.r.t. the root of the drive) to preview. * server_id: The server where the preview was generated, if a conversion was required. * guid: The guid provided by generate-preview, if a conversion is required.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives download -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "download"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/download/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

generate_preview

POST /api/v2/drives/{id}/generate-preview/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives generate_preview -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "generate_preview"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/generate-preview/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

move

POST /api/v2/drives/{id}/move/

Move files and folders from this drive to the same or another drive. Also to be used for renaming files and folders. * source_paths: List of paths of the files and/or folders to move/rename. Paths are absolute w.r.t. to root of the drive. When renaming, only one path can be provided. * destination_drive: URI of the destination drive. If omitted, the current drive is used. * destination_path: Path to the folder to move the files and/or folders to. The path is absolute w.r.t. to root of the (destination) drive. Use "/" to move to the root. To rename, the destination path ends with the new file/folder name.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives move -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "move"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/move/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

upload

GET /api/v2/drives/{id}/upload/

Get a link to upload a file to the given path (must be a folder) within a drive. When using the upload link you will also need to append &size=<bytes> * path: Absolute path (w.r.t. the root of the drive) to upload to. Use "/" ("%2F") to upload to the root of the drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives upload -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "upload"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/upload/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

dirents > read

GET /api/v2/drives/{id}/dirents/

List the files and folders (dirent = directory entries) of a given path within a drive. * path: Absolute path (w.r.t. the root of the drive) to list. Use "/" ("%2F") to list the root of the drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives dirents read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "dirents &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/dirents/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

dirents > create

POST /api/v2/drives/{id}/dirents/

List the files and folders (dirent = directory entries) of a given path within a drive. * path: Absolute path (w.r.t. the root of the drive) to list. Use "/" ("%2F") to list the root of the drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backend` required	The protocol used for accessing the drives. Can be "CIFS" (a.k.a. SMB or Samba), "WEBDAV" or "ONEDRIVE".
`context_labels` required	List with context policies in the format key:value that are assigned to this drive. These can be used for context awareness.
`config` required	Configuration for this element, depending of the selected backend. See /drives/backends/ for the configurable fields. Only the value of each configuration item can be changed, and only when it is not read-only.
`description` required	Free text description of the drive.
`domain` required	URI to the domain this drive belongs to.
`name` required	Name of the drive as it will be displayed in the Workspace, in the left-pane of the Files tab.
`unc`	UNC that will be used by the application server to access the drives. This UNC path is needed when using "Open with" as action on the Files tab in the Workspace. Note that this path can be parameterized with <username> and <domain>. Example: \\FILESERVER\Home\<username>\Documents
`url` required	URL of the file server that will be used by the API to communicate with the file server. Note that this path can be parameterized with <username> and <domain>. The URL format is backend specific: please refer to /drives/backends/ for examples.
`use_domain`	For WEBDAV only: during authentication against the file server, it may be required to pass the domain name. Set to true if this the file server is configured that way.
`labels` required	List with labels in the format key:value that are assigned to this drive. These can be used for organizational purposes.
`user_labels` required	List with user labels in the format key:value that are assigned to this drive. When logging in, only users that match one of these labels will have access to this drive.
`smb_max_protocol`	Maximum SMB protocol version to use.
`authentication_role`
`require_smb_signing`	Require SMB signing to be enabled, so the SMB messages are always signed.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives dirents create -p id=... -p backend=... -p context_labels=... -p config=... -p description=... -p domain=... -p name=... -p unc=... -p url=... -p use_domain=... -p labels=... -p user_labels=... -p smb_max_protocol=... -p authentication_role=... -p require_smb_signing=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "dirents &gt; create"]
params = {
    "id": ...,
    "backend": ...,
    "context_labels": ...,
    "config": ...,
    "description": ...,
    "domain": ...,
    "name": ...,
    "unc": ...,
    "url": ...,
    "use_domain": ...,
    "labels": ...,
    "user_labels": ...,
    "smb_max_protocol": ...,
    "authentication_role": ...,
    "require_smb_signing": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backend='...';
    context_labels='...';
    config='...';
    description='...';
    domain='...';
    name='...';
    unc='...';
    url='...';
    use_domain='...';
    labels='...';
    user_labels='...';
    smb_max_protocol='...';
    authentication_role='...';
    require_smb_signing='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/dirents/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

dirents > delete

DELETE /api/v2/drives/{id}/dirents/

List the files and folders (dirent = directory entries) of a given path within a drive. * path: Absolute path (w.r.t. the root of the drive) to list. Use "/" ("%2F") to list the root of the drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives dirents delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "dirents &gt; delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/dirents/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

get-preview > read

GET /api/v2/drives/{id}/get-preview/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this drive.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action drives get-preview read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["drives", "get-preview &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/drives/{id}/get-preview/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

favicons

list

GET /api/v2/favicons/

List the available square logos. The square logo is used in the collapsed sidebar and as the favicon. Each square logo can be a generated polygon based on your primary branding color, or generated from an uploaded image.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action favicons list -p limit=... -p offset=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["favicons", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/favicons/?limit=...&offset=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

generate

POST /api/v2/favicons/generate/

Generate square logos for different dimensions and formats based on a single source image. Most common image formats are supported, like PNG (recommended size: 512 px), ICO, SVG and JPG. The uploaded image should be maximum 2MiB and should be square. The request body should be a 'multipart/form-data' encoded object (not JSON). Additionally, you need to specify the id of the domain you want to generate this favicon for as a query parameter, e.g. /api/v2/favicons/generate/?domain={domain_id} if the domain uri is /api/v2/domains/{domain_id}/.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required	Provide the file in the body of the request.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action favicons generate -p file=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["favicons", "generate"]
params = {
    "file": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/favicons/generate/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/favicons/{id}/

Get the details of a square logo. The square logo is used in the collapsed sidebar and as the favicon. A square logo can be a generated polygon based on your primary branding color, or generated from an uploaded image.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this favicon.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action favicons read -p id=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["favicons", "read"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/favicons/{id}/?domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

image > read

GET /api/v2/favicons/image/

Get the actual image of the square logo, where the dimension, extension and state are defined through the query string. See the "image" field of a square logo object for examples. The square logo is used in the collapsed sidebar and as the favicon.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action favicons image read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["favicons", "image &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/favicons/image/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

features

list

GET /api/v2/features/

A list of all features - labels are provided in a list of 'key:value' pairs.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`display_name`	Description to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action features list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p display_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["features", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "display_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/features/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&display_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/features/{id}/

Get a single feature - labels are provided in a list of 'key:value' pairs.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this feature.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`display_name`	Description to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action features read -p id=... -p ordering=... -p domain=... -p domain_name=... -p display_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["features", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "display_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/features/{id}/?ordering=...&domain=...&domain_name=...&display_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/features/{id}/

Update a feature by providing the complete object. Labels is the only field which will actually be updated (provide a list in short form).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this feature.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`display_name`	Description to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`user_labels` required	List with labels in the format key:value that are assigned to this feature. The feature will only be activated for users that match at least one of the labels.
`context_labels` required	List with context policies in the format key:value that are assigned to this feature. Only users that have a context that matches all of these labels will have access to this feature.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action features update -p id=... -p user_labels=... -p context_labels=... -p ordering=... -p domain=... -p domain_name=... -p display_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["features", "update"]
params = {
    "id": ...,
    "user_labels": ...,
    "context_labels": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "display_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    user_labels='...';
    context_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/features/{id}/?ordering=...&domain=...&domain_name=...&display_name=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/features/{id}/

Update a feature by providing only the changes. Only the labels of a feature can be updated by providing a list in short form.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this feature.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`display_name`	Description to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`user_labels`	List with labels in the format key:value that are assigned to this feature. The feature will only be activated for users that match at least one of the labels.
`context_labels`	List with context policies in the format key:value that are assigned to this feature. Only users that have a context that matches all of these labels will have access to this feature.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action features partial_update -p id=... -p user_labels=... -p context_labels=... -p ordering=... -p domain=... -p domain_name=... -p display_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["features", "partial_update"]
params = {
    "id": ...,
    "user_labels": ...,
    "context_labels": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "display_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    user_labels='...';
    context_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/features/{id}/?ordering=...&domain=...&domain_name=...&display_name=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

file-types

list

GET /api/v2/file-types/

List file types, which are used to link applications to files.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`extension`	Extension to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p extension=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "extension": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/file-types/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&extension=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/file-types/

Create a new file type. File types are used to link applications to files.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`extension` required	EG. pdf
`description`	Description of the filetype.
`domain` required	URI of the domain.
`icon`	The URI of the icon.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types create -p extension=... -p description=... -p domain=... -p icon=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "create"]
params = {
    "extension": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    extension='...';
    description='...';
    domain='...';
    icon='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/file-types/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/file-types/{id}/

Get details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`extension`	Extension to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types read -p id=... -p ordering=... -p domain=... -p domain_name=... -p extension=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "extension": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/file-types/{id}/?ordering=...&domain=...&domain_name=...&extension=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/file-types/{id}/

Update details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`extension`	Extension to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`extension` required	EG. pdf
`description`	Description of the filetype.
`domain` required	URI of the domain.
`icon`	The URI of the icon.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types update -p id=... -p extension=... -p description=... -p domain=... -p icon=... -p ordering=... -p domain=... -p domain_name=... -p extension=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "update"]
params = {
    "id": ...,
    "extension": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "extension": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    extension='...';
    description='...';
    domain='...';
    icon='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/file-types/{id}/?ordering=...&domain=...&domain_name=...&extension=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/file-types/{id}/

Update some details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`extension`	Extension to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`extension`	EG. pdf
`description`	Description of the filetype.
`domain`	URI of the domain.
`icon`	The URI of the icon.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types partial_update -p id=... -p extension=... -p description=... -p domain=... -p icon=... -p ordering=... -p domain=... -p domain_name=... -p extension=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "partial_update"]
params = {
    "id": ...,
    "extension": ...,
    "description": ...,
    "domain": ...,
    "icon": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "extension": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    extension='...';
    description='...';
    domain='...';
    icon='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/file-types/{id}/?ordering=...&domain=...&domain_name=...&extension=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/file-types/{id}/

Delete a file type. File types are used to link applications to files. Deleting a file type will not delete the applications/files linked to it.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`extension`	Extension to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action file-types delete -p id=... -p ordering=... -p domain=... -p domain_name=... -p extension=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["file-types", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "extension": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/file-types/{id}/?ordering=...&domain=...&domain_name=...&extension=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

frontend-logger

create

POST /api/v2/frontend-logger/

API to log frontend client errors. For internal use only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action frontend-logger create

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["frontend-logger", "create"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/frontend-logger/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

get-certificate-content

create

POST /api/v2/get-certificate-content/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action get-certificate-content create

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["get-certificate-content", "create"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/get-certificate-content/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

guided-tours

list

GET /api/v2/guided-tours/

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action guided-tours list -p limit=... -p offset=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["guided-tours", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/guided-tours/?limit=...&offset=...&user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/guided-tours/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this guided tour.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action guided-tours read -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["guided-tours", "read"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/guided-tours/{id}/?user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/guided-tours/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this guided tour.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_enabled`	Whether this individual tour is enabled.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action guided-tours update -p id=... -p is_enabled=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["guided-tours", "update"]
params = {
    "id": ...,
    "is_enabled": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    is_enabled='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/guided-tours/{id}/?user=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/guided-tours/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this guided tour.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_enabled`	Whether this individual tour is enabled.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action guided-tours partial_update -p id=... -p is_enabled=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["guided-tours", "partial_update"]
params = {
    "id": ...,
    "is_enabled": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    is_enabled='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/guided-tours/{id}/?user=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

hostheaders

list

GET /api/v2/hostheaders/

List host headers.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders list -p limit=... -p offset=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/?limit=...&offset=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/hostheaders/

Add a host header to a domain.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain` required
`name` required	Name of host header, matching the value of the HTTP Host header.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders create -p domain=... -p name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "create"]
params = {
    "domain": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    name='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/hostheaders/{id}/

Get details of a host header.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this host header.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders read -p id=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "read"]
params = {
    "id": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/{id}/?domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/hostheaders/{id}/

Change the details of a host header.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this host header.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain` required
`name` required	Name of host header, matching the value of the HTTP Host header.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders update -p id=... -p domain=... -p name=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "update"]
params = {
    "id": ...,
    "domain": ...,
    "name": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    name='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/{id}/?domain_name=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/hostheaders/{id}/

Change some details of a host header.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this host header.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain`
`name`	Name of host header, matching the value of the HTTP Host header.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders partial_update -p id=... -p domain=... -p name=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "partial_update"]
params = {
    "id": ...,
    "domain": ...,
    "name": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    name='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/{id}/?domain_name=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/hostheaders/{id}/

Remove a host header.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this host header.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action hostheaders delete -p id=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["hostheaders", "delete"]
params = {
    "id": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/hostheaders/{id}/?domain_name=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

indexer

create

POST /api/v2/indexer/

Launch a query to the indexer containing the auditing logs.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain`	Domain URI to query information from
`query_name` required	Name of query to execute (anomalies, application_concurrent_sessions, application_named_users, application_sessions, application_usage, application_usage_histogram, browser, file_accesses, os, share_accesses, shared_application_sessions, shared_application_sessions_settings, user_sessions, web_application_sessions)
`query_filter` required	Query filter to run against subset, for example: "*" for all results or "app_key:"da13bd02-2f63-4d39-ab05-eb913642de81"" to get only the results for a specific app
`timestamp_from` required	Timestamp to search from, in ISO 8601 format
`timestamp_to` required	Timestamp to search to, in ISO 8601 format
`size`	The maximum number of results to look up
`advanced`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action indexer create -p domain=... -p query_name=... -p query_filter=... -p timestamp_from=... -p timestamp_to=... -p size=... -p advanced=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["indexer", "create"]
params = {
    "domain": ...,
    "query_name": ...,
    "query_filter": ...,
    "timestamp_from": ...,
    "timestamp_to": ...,
    "size": ...,
    "advanced": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    query_name='...';
    query_filter='...';
    timestamp_from='...';
    timestamp_to='...';
    size='...';
    advanced='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/indexer/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

fields

POST /api/v2/indexer/fields/

Get the list of available fields for an advanced query

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`query_name` required	Name of query to execute (anomalies, application_concurrent_sessions, application_named_users, application_sessions, application_usage, application_usage_histogram, browser, file_accesses, os, share_accesses, shared_application_sessions, shared_application_sessions_settings, user_sessions, web_application_sessions)

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action indexer fields -p query_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["indexer", "fields"]
params = {
    "query_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    query_name='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/indexer/fields/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

indexer-ingest

create

POST /api/v2/indexer-ingest/

Launch a query to the indexer containing the auditing logs.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action indexer-ingest create

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["indexer-ingest", "create"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/indexer-ingest/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

key-combos

list

GET /api/v2/key-combos/

List on-screen keyboard shortcut.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`app`	App id to filter on.
`domain_name`	Domain name of app to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos list -p limit=... -p offset=... -p ordering=... -p app=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "app": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/?limit=...&offset=...&ordering=...&app=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/key-combos/

Add a new on-screen keyboard shortcut to an application.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app` required	The id of the application.
`order` required	The order of this key combination in the list. The key combinations will be sorted by the value of this field. There can be gaps between the values of the order fields, and it can also be negative.
`name` required	Name for this key combination, will be displayed to the user.
`value` required	Key combination to be sent to the app. Must be a number of existing keys joined by "+", for example "ctrl+shift+v".

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos create -p app=... -p order=... -p name=... -p value=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "create"]
params = {
    "app": ...,
    "order": ...,
    "name": ...,
    "value": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app='...';
    order='...';
    name='...';
    value='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/key-combos/{id}/

Get details of an on-screen keyboard shortcut.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this key combo.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`app`	App id to filter on.
`domain_name`	Domain name of app to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos read -p id=... -p ordering=... -p app=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "app": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/{id}/?ordering=...&app=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/key-combos/{id}/

Update details of an on-screen keyboard shortcut.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this key combo.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`app`	App id to filter on.
`domain_name`	Domain name of app to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app` required	The id of the application.
`order` required	The order of this key combination in the list. The key combinations will be sorted by the value of this field. There can be gaps between the values of the order fields, and it can also be negative.
`name` required	Name for this key combination, will be displayed to the user.
`value` required	Key combination to be sent to the app. Must be a number of existing keys joined by "+", for example "ctrl+shift+v".

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos update -p id=... -p app=... -p order=... -p name=... -p value=... -p ordering=... -p app=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "update"]
params = {
    "id": ...,
    "app": ...,
    "order": ...,
    "name": ...,
    "value": ...,
    "ordering": ...,
    "app": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app='...';
    order='...';
    name='...';
    value='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/{id}/?ordering=...&app=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/key-combos/{id}/

Update some details of an on-screen keyboard shortcut.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this key combo.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`app`	App id to filter on.
`domain_name`	Domain name of app to filter on.
`search`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app`	The id of the application.
`order`	The order of this key combination in the list. The key combinations will be sorted by the value of this field. There can be gaps between the values of the order fields, and it can also be negative.
`name`	Name for this key combination, will be displayed to the user.
`value`	Key combination to be sent to the app. Must be a number of existing keys joined by "+", for example "ctrl+shift+v".

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos partial_update -p id=... -p app=... -p order=... -p name=... -p value=... -p ordering=... -p app=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "partial_update"]
params = {
    "id": ...,
    "app": ...,
    "order": ...,
    "name": ...,
    "value": ...,
    "ordering": ...,
    "app": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    app='...';
    order='...';
    name='...';
    value='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/{id}/?ordering=...&app=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/key-combos/{id}/

Remove an on-screen keyboard shortcut.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this key combo.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`app`	App id to filter on.
`domain_name`	Domain name of app to filter on.
`search`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action key-combos delete -p id=... -p ordering=... -p app=... -p domain_name=... -p search=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["key-combos", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "app": ...,
    "domain_name": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/key-combos/{id}/?ordering=...&app=...&domain_name=...&search=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

labels

list

GET /api/v2/labels/

List all labels.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`
`user_labels`
`context_labels`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels list -p limit=... -p offset=... -p ordering=... -p domain=... -p domain_name=... -p search=... -p user_labels=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
    "user_labels": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/labels/?limit=...&offset=...&ordering=...&domain=...&domain_name=...&search=...&user_labels=...&context_labels=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/labels/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain` required
`key` required	The key of the label
`value`	The value that corresponds to the key of the label
`type`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels create -p domain=... -p key=... -p value=... -p type=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "create"]
params = {
    "domain": ...,
    "key": ...,
    "value": ...,
    "type": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    key='...';
    value='...';
    type='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/labels/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/labels/{id}/

Get details of a specific label.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this label.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`
`user_labels`
`context_labels`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels read -p id=... -p ordering=... -p domain=... -p domain_name=... -p search=... -p user_labels=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
    "user_labels": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/labels/{id}/?ordering=...&domain=...&domain_name=...&search=...&user_labels=...&context_labels=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/labels/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this label.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`
`user_labels`
`context_labels`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain` required
`key` required	The key of the label
`value`	The value that corresponds to the key of the label
`type`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels update -p id=... -p domain=... -p key=... -p value=... -p type=... -p ordering=... -p domain=... -p domain_name=... -p search=... -p user_labels=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "update"]
params = {
    "id": ...,
    "domain": ...,
    "key": ...,
    "value": ...,
    "type": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
    "user_labels": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    key='...';
    value='...';
    type='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/labels/{id}/?ordering=...&domain=...&domain_name=...&search=...&user_labels=...&context_labels=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/labels/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this label.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`
`user_labels`
`context_labels`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`domain`
`key`	The key of the label
`value`	The value that corresponds to the key of the label
`type`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels partial_update -p id=... -p domain=... -p key=... -p value=... -p type=... -p ordering=... -p domain=... -p domain_name=... -p search=... -p user_labels=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "partial_update"]
params = {
    "id": ...,
    "domain": ...,
    "key": ...,
    "value": ...,
    "type": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
    "user_labels": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    domain='...';
    key='...';
    value='...';
    type='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/labels/{id}/?ordering=...&domain=...&domain_name=...&search=...&user_labels=...&context_labels=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/labels/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this label.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`search`
`user_labels`
`context_labels`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action labels delete -p id=... -p ordering=... -p domain=... -p domain_name=... -p search=... -p user_labels=... -p context_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["labels", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "domain": ...,
    "domain_name": ...,
    "search": ...,
    "user_labels": ...,
    "context_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/labels/{id}/?ordering=...&domain=...&domain_name=...&search=...&user_labels=...&context_labels=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

resource-changes

list

GET /api/v2/resource-changes/

List resource changes.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`action`	Action to filter on.
`domain_name`	Case insensitive domain name filter.
`resource_id`	Case insensitive resource id filter.
`resource_type`	Case insensitive resource type filter.
`timestamp`
`timestamp_to`	Date time filter (format: YYYY-MM-DD HH:MM). Can be combined with timestamp_from.
`username`	Case insenstive username filter.
`authentication`	Case insenstive authentication filter.
`date`	Date filter (format:YYYY-MM-DD).
`timestamp_from`	Date time filter (format: YYYY-MM-DD HH:MM). Can be combined with timestamp_to.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action resource-changes list -p limit=... -p offset=... -p ordering=... -p action=... -p domain_name=... -p resource_id=... -p resource_type=... -p timestamp=... -p timestamp_to=... -p username=... -p authentication=... -p date=... -p timestamp_from=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["resource-changes", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "action": ...,
    "domain_name": ...,
    "resource_id": ...,
    "resource_type": ...,
    "timestamp": ...,
    "timestamp_to": ...,
    "username": ...,
    "authentication": ...,
    "date": ...,
    "timestamp_from": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/resource-changes/?limit=...&offset=...&ordering=...&action=...&domain_name=...&resource_id=...&resource_type=...&timestamp=...&timestamp_to=...&username=...&authentication=...&date=...&timestamp_from=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/resource-changes/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this resource change.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`action`	Action to filter on.
`domain_name`	Case insensitive domain name filter.
`resource_id`	Case insensitive resource id filter.
`resource_type`	Case insensitive resource type filter.
`timestamp`
`timestamp_to`	Date time filter (format: YYYY-MM-DD HH:MM). Can be combined with timestamp_from.
`username`	Case insenstive username filter.
`authentication`	Case insenstive authentication filter.
`date`	Date filter (format:YYYY-MM-DD).
`timestamp_from`	Date time filter (format: YYYY-MM-DD HH:MM). Can be combined with timestamp_to.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action resource-changes read -p id=... -p ordering=... -p action=... -p domain_name=... -p resource_id=... -p resource_type=... -p timestamp=... -p timestamp_to=... -p username=... -p authentication=... -p date=... -p timestamp_from=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["resource-changes", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "action": ...,
    "domain_name": ...,
    "resource_id": ...,
    "resource_type": ...,
    "timestamp": ...,
    "timestamp_to": ...,
    "username": ...,
    "authentication": ...,
    "date": ...,
    "timestamp_from": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/resource-changes/{id}/?ordering=...&action=...&domain_name=...&resource_id=...&resource_type=...&timestamp=...&timestamp_to=...&username=...&authentication=...&date=...&timestamp_from=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

resources

list

GET /api/v2/resources/

Internal API to get the number of cpu cores and amount of memory on this appliance. This is used to check if the requirements are met during service management changes.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action resources list

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["resources", "list"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/resources/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

seal-providers

list

GET /api/v2/seal-providers/

List seal providers.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`key`	Key to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action seal-providers list -p limit=... -p offset=... -p key=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["seal-providers", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/seal-providers/?limit=...&offset=...&key=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/seal-providers/{id}/

Get details for a seal provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this seal provider.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`key`	Key to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action seal-providers read -p id=... -p key=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["seal-providers", "read"]
params = {
    "id": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/seal-providers/{id}/?key=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/seal-providers/{id}/

Update details for a seal provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this seal provider.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`key`	Key to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config` required	Configuration for this authentication provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action seal-providers update -p id=... -p config=... -p key=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["seal-providers", "update"]
params = {
    "id": ...,
    "config": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/seal-providers/{id}/?key=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/seal-providers/{id}/

Update details for a seal provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this seal provider.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`key`	Key to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config`	Configuration for this authentication provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action seal-providers partial_update -p id=... -p config=... -p key=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["seal-providers", "partial_update"]
params = {
    "id": ...,
    "config": ...,
    "key": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/seal-providers/{id}/?key=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

sessions

list

GET /api/v2/sessions/

List of sessions. A session corresponds with a login on the Workspace. Super admin can see all sessions, domain admin all sessions connected to his domain, a user only his own session.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/sessions/

Create a session to login.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Username of the user. For authentication (POST): both the username and the UPN can be used. When reading (GET), the non-UPN username is returned, prefixed with the NetBIOS domain name.
`privacy_policy_accepted`	True when user accepts the Privacy Policy.
`domain`	The applicable domain. When not providing this field when authenticating (POST), the default domain is used.
`fingerprint`	A unique value identifying a single browser/device combination. Is automatically set by the client.
`is_trusted`	Mark the current browser as "trusted", no MFA token will be required for 30 days.
`new_password`	Change the LDAP password of the user to this new password. To change it (POST), the fields "twofactor" (if applicable and when not being signed in) and "password" should be provided.
`password`	Current LDAP password of the user needed for authentication (POST).
`twofactor`	When MFA (multi-factor authentication) is required during authentication (POST), you need to provide a JSON object with following fields (depending of the type of MFA): method (e.g. phone, push) and otp (token). The available methods are provided in the response of an authentication attempt without twofactor field.
`login_without_admin_rights`
`force_mfa_login`
`logout_other_sessions`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions create -p username=... -p privacy_policy_accepted=... -p domain=... -p fingerprint=... -p is_trusted=... -p new_password=... -p password=... -p twofactor=... -p login_without_admin_rights=... -p force_mfa_login=... -p logout_other_sessions=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "create"]
params = {
    "username": ...,
    "privacy_policy_accepted": ...,
    "domain": ...,
    "fingerprint": ...,
    "is_trusted": ...,
    "new_password": ...,
    "password": ...,
    "twofactor": ...,
    "login_without_admin_rights": ...,
    "force_mfa_login": ...,
    "logout_other_sessions": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    username='...';
    privacy_policy_accepted='...';
    domain='...';
    fingerprint='...';
    is_trusted='...';
    new_password='...';
    password='...';
    twofactor='...';
    login_without_admin_rights='...';
    force_mfa_login='...';
    logout_other_sessions='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/sessions/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

disable_token

POST /api/v2/sessions/disable-token/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`password` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions disable_token -p password=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "disable_token"]
params = {
    "password": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    password='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/sessions/disable-token/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

generate_token

POST /api/v2/sessions/generate-token/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`password` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions generate_token -p password=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "generate_token"]
params = {
    "password": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    password='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/sessions/generate-token/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

heartbeat

POST /api/v2/sessions/heartbeat/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`last_activity` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions heartbeat -p last_activity=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "heartbeat"]
params = {
    "last_activity": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    last_activity='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/sessions/heartbeat/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/sessions/{id}/

Get details of a session. A session corresponds with a login on the Workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/sessions/{id}/

Delete a session to logout.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/{id}/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

current > read

GET /api/v2/sessions/current/

Get or delete the current session.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions current read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "current &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/current/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

current > delete

DELETE /api/v2/sessions/current/

Get or delete the current session.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions current delete

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "current &gt; delete"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/current/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

current-light > read

GET /api/v2/sessions/current-light/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action sessions current-light read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["sessions", "current-light &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/sessions/current-light/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

list

GET /api/v2/shares/

List all shares, which can be filtered with the parameter "user" (by ID).

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`access_rights`	Access rights to filter on.
`user`	User id to filter on.
`is_expired`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares list -p limit=... -p offset=... -p access_rights=... -p user=... -p is_expired=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "access_rights": ...,
    "user": ...,
    "is_expired": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/shares/?limit=...&offset=...&access_rights=...&user=...&is_expired=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/shares/

Create a new share. During the creation, the content of the file or folder will be fetched from the file server and stored on the Workspace as long as it does not expire. When the original file or folder is modified,the share won't be updated automatically.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	Free text description of the share.
`expires` required	ISO time stamp when the share expires.
`mode`	Can be PREVIEW (which results in a PDF) or DOWNLOAD (to share the original files and/or folders). Note that folders and multi-file shares can only be set to DOWNLOAD and will result in a ZIP file.
`name`	Name of the share. Typically, the file name is used for this.
`drive` required
`paths` required	Paths to the original files and/or folders (relative to the root of the drive).
`password`	Optional password required to access share.
`access_rights`	Can be DOMAIN (accessible to users in the same domain), EXTERNAL (accessible to everyone, even not logged-in users) or USERS (accessible to specific users or groups, as specified by the access_labels field.
`access_labels`	List with labels in the format key:value that are assigned to this share. The key must be one of username or group to specify respectively usernames and group names that are allowed to access this share when access_rights is set to USERS.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares create -p description=... -p expires=... -p mode=... -p name=... -p drive=... -p paths=... -p password=... -p access_rights=... -p access_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "create"]
params = {
    "description": ...,
    "expires": ...,
    "mode": ...,
    "name": ...,
    "drive": ...,
    "paths": ...,
    "password": ...,
    "access_rights": ...,
    "access_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    expires='...';
    mode='...';
    name='...';
    drive='...';
    paths='...';
    password='...';
    access_rights='...';
    access_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/shares/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/shares/{id}/

Get details of a share, which is a shared file of folder within a drive.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this share.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`access_rights`	Access rights to filter on.
`user`	User id to filter on.
`is_expired`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares read -p id=... -p access_rights=... -p user=... -p is_expired=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "read"]
params = {
    "id": ...,
    "access_rights": ...,
    "user": ...,
    "is_expired": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/shares/{id}/?access_rights=...&user=...&is_expired=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/shares/{id}/

Update the detail of a share.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this share.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`access_rights`	Access rights to filter on.
`user`	User id to filter on.
`is_expired`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	Free text description of the share.
`expires` required	ISO time stamp when the share expires.
`mode`	Can be PREVIEW (which results in a PDF) or DOWNLOAD (to share the original files and/or folders). Note that folders and multi-file shares can only be set to DOWNLOAD and will result in a ZIP file.
`name`	Name of the share. Typically, the file name is used for this.
`drive` required
`paths` required	Paths to the original files and/or folders (relative to the root of the drive).
`password`	Optional password required to access share.
`access_rights`	Can be DOMAIN (accessible to users in the same domain), EXTERNAL (accessible to everyone, even not logged-in users) or USERS (accessible to specific users or groups, as specified by the access_labels field.
`access_labels`	List with labels in the format key:value that are assigned to this share. The key must be one of username or group to specify respectively usernames and group names that are allowed to access this share when access_rights is set to USERS.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares update -p id=... -p description=... -p expires=... -p mode=... -p name=... -p drive=... -p paths=... -p password=... -p access_rights=... -p access_labels=... -p access_rights=... -p user=... -p is_expired=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "update"]
params = {
    "id": ...,
    "description": ...,
    "expires": ...,
    "mode": ...,
    "name": ...,
    "drive": ...,
    "paths": ...,
    "password": ...,
    "access_rights": ...,
    "access_labels": ...,
    "access_rights": ...,
    "user": ...,
    "is_expired": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    expires='...';
    mode='...';
    name='...';
    drive='...';
    paths='...';
    password='...';
    access_rights='...';
    access_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/shares/{id}/?access_rights=...&user=...&is_expired=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/shares/{id}/

Update some details of a share.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this share.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`access_rights`	Access rights to filter on.
`user`	User id to filter on.
`is_expired`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	Free text description of the share.
`expires`	ISO time stamp when the share expires.
`mode`	Can be PREVIEW (which results in a PDF) or DOWNLOAD (to share the original files and/or folders). Note that folders and multi-file shares can only be set to DOWNLOAD and will result in a ZIP file.
`name`	Name of the share. Typically, the file name is used for this.
`drive`
`paths`	Paths to the original files and/or folders (relative to the root of the drive).
`password`	Optional password required to access share.
`access_rights`	Can be DOMAIN (accessible to users in the same domain), EXTERNAL (accessible to everyone, even not logged-in users) or USERS (accessible to specific users or groups, as specified by the access_labels field.
`access_labels`	List with labels in the format key:value that are assigned to this share. The key must be one of username or group to specify respectively usernames and group names that are allowed to access this share when access_rights is set to USERS.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares partial_update -p id=... -p description=... -p expires=... -p mode=... -p name=... -p drive=... -p paths=... -p password=... -p access_rights=... -p access_labels=... -p access_rights=... -p user=... -p is_expired=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "partial_update"]
params = {
    "id": ...,
    "description": ...,
    "expires": ...,
    "mode": ...,
    "name": ...,
    "drive": ...,
    "paths": ...,
    "password": ...,
    "access_rights": ...,
    "access_labels": ...,
    "access_rights": ...,
    "user": ...,
    "is_expired": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    expires='...';
    mode='...';
    name='...';
    drive='...';
    paths='...';
    password='...';
    access_rights='...';
    access_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/shares/{id}/?access_rights=...&user=...&is_expired=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/shares/{id}/

Delete a share. The original file or folder will be untouched.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this share.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`access_rights`	Access rights to filter on.
`user`	User id to filter on.
`is_expired`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares delete -p id=... -p access_rights=... -p user=... -p is_expired=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "delete"]
params = {
    "id": ...,
    "access_rights": ...,
    "user": ...,
    "is_expired": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/shares/{id}/?access_rights=...&user=...&is_expired=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update_share

POST /api/v2/shares/{id}/update_share/

Fetch the content of the file or folder again from the file server.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this share.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`description`	Free text description of the share.
`expires` required	ISO time stamp when the share expires.
`mode`	Can be PREVIEW (which results in a PDF) or DOWNLOAD (to share the original files and/or folders). Note that folders and multi-file shares can only be set to DOWNLOAD and will result in a ZIP file.
`name`	Name of the share. Typically, the file name is used for this.
`drive` required
`paths` required	Paths to the original files and/or folders (relative to the root of the drive).
`password`	Optional password required to access share.
`access_rights`	Can be DOMAIN (accessible to users in the same domain), EXTERNAL (accessible to everyone, even not logged-in users) or USERS (accessible to specific users or groups, as specified by the access_labels field.
`access_labels`	List with labels in the format key:value that are assigned to this share. The key must be one of username or group to specify respectively usernames and group names that are allowed to access this share when access_rights is set to USERS.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares update_share -p id=... -p description=... -p expires=... -p mode=... -p name=... -p drive=... -p paths=... -p password=... -p access_rights=... -p access_labels=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "update_share"]
params = {
    "id": ...,
    "description": ...,
    "expires": ...,
    "mode": ...,
    "name": ...,
    "drive": ...,
    "paths": ...,
    "password": ...,
    "access_rights": ...,
    "access_labels": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    description='...';
    expires='...';
    mode='...';
    name='...';
    drive='...';
    paths='...';
    password='...';
    access_rights='...';
    access_labels='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/shares/{id}/update_share/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

shared-with-me > read

GET /api/v2/shares/shared-with-me/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action shares shared-with-me read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["shares", "shared-with-me &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/shares/shared-with-me/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

ssl-offloader-certificates

list

GET /api/v2/ssl-offloader-certificates/

List certificates.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action ssl-offloader-certificates list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["ssl-offloader-certificates", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/ssl-offloader-certificates/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/ssl-offloader-certificates/

Create a new certificate either by generating one automatically using Let's Encrypt (is_automatic=true) or using a manually specified certificate chain and private key (is_automatic=false). Triggers a limited apply changes on the proxy service.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`certificate`	SSL certificate chain in PEM format. Should include any intermediate certificates in the chain. Only allowed when is_automatic is false.
`pkcs_12_password`	Password protecting the PKCS12 file.
`pkcs_12_file`	PKCS12 file containing certificate and private key.
`private_key`	RSA private key in PEM format. Only allowed when is_automatic is false.
`subject_names`	List of FQDNs, used to generate a new certificate when creating a certificate (only allowed when is_automatic is true), or to view the subject names the certificate applies to when viewing the certificate.
`is_automatic` required	Whether or not this is an automatically generated certificate. If set to true, a new certificate will be generated based on subject_names, using Let's Encrypt. By using it, you are accepting their terms and conditions (https://letsencrypt.org). Your appliance needs permanent network access to and from their servers. If set to false, certificate and private_key will be used.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action ssl-offloader-certificates create -p certificate=... -p pkcs_12_password=... -p pkcs_12_file=... -p private_key=... -p subject_names=... -p is_automatic=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["ssl-offloader-certificates", "create"]
params = {
    "certificate": ...,
    "pkcs_12_password": ...,
    "pkcs_12_file": ...,
    "private_key": ...,
    "subject_names": ...,
    "is_automatic": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    certificate='...';
    pkcs_12_password='...';
    pkcs_12_file='...';
    private_key='...';
    subject_names='...';
    is_automatic='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/ssl-offloader-certificates/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/ssl-offloader-certificates/{id}/

Get details of a certificate.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this certificate.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action ssl-offloader-certificates read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["ssl-offloader-certificates", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/ssl-offloader-certificates/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/ssl-offloader-certificates/{id}/

Remove a certificate. Triggers a limited apply changes on the proxy service.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this certificate.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action ssl-offloader-certificates delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["ssl-offloader-certificates", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/ssl-offloader-certificates/{id}/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

status

list

GET /api/v2/status/

Lists appliance, service and process status and an aggregated status of the Workspace.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action status list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["status", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/status/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

tasks

read

GET /api/v2/tasks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this task.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action tasks read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["tasks", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/tasks/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

twofactor-providers

list

GET /api/v2/twofactor-providers/

List MFA (multi-factor authentication) providers.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action twofactor-providers list -p limit=... -p offset=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["twofactor-providers", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/twofactor-providers/?limit=...&offset=...&domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/twofactor-providers/{id}/

Get details for an MFA (multi-factor authentication) provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action twofactor-providers read -p id=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["twofactor-providers", "read"]
params = {
    "id": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/twofactor-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/twofactor-providers/{id}/

Update details for an MFA (multi-factor authentication) provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config` required	Configuration for this MFA provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action twofactor-providers update -p id=... -p config=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["twofactor-providers", "update"]
params = {
    "id": ...,
    "config": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/twofactor-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/twofactor-providers/{id}/

Update details for an MFA (multi-factor authentication) provider.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain_name`	Domain name to filter on.
`key`	Key to filter on.
`domain`	Domain id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config`	Configuration for this MFA provider. Only the value of each configuration item can be changed, and only when it is not read-only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action twofactor-providers partial_update -p id=... -p config=... -p domain_name=... -p key=... -p domain=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["twofactor-providers", "partial_update"]
params = {
    "id": ...,
    "config": ...,
    "domain_name": ...,
    "key": ...,
    "domain": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/twofactor-providers/{id}/?domain_name=...&key=...&domain=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update-outputs

list

GET /api/v2/update-outputs/

List the output logs of an update (install, upgrade, apply changes).

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`update`	Update id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action update-outputs list -p limit=... -p offset=... -p update=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["update-outputs", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "update": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/update-outputs/?limit=...&offset=...&update=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/update-outputs/{id}/

Get the output log of an update (install, upgrade, apply changes).

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this output.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`update`	Update id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action update-outputs read -p id=... -p update=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["update-outputs", "read"]
params = {
    "id": ...,
    "update": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/update-outputs/{id}/?update=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

updates

list

GET /api/v2/updates/

List updates (install, update, apply changes). Add the filter '?unfinished=1' to only get updates that did not finish yet or that failed without a successful retry.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/updates/

Apply all changes (when no version or the current version is supplied), or upgrade to a different version.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`version` required
`eula_accepted`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates create -p version=... -p eula_accepted=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "create"]
params = {
    "version": ...,
    "eula_accepted": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    version='...';
    eula_accepted='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/updates/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

install

POST /api/v2/updates/install/

Install.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`config` required	Configuration for the installation. See our documentation portal for more information.
`version_number`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates install -p config=... -p version_number=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "install"]
params = {
    "config": ...,
    "version_number": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    config='...';
    version_number='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/updates/install/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

retry

POST /api/v2/updates/retry/

Retry the last failed update.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates retry

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "retry"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/retry/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/updates/{id}/

Get details of an update.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this update.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/{id}/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/updates/{id}/

Only used in the installer. When the installation fails, the update is deleted in order to reset the installer to its initial state.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this update.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates delete -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/{id}/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

install-upload-backup > create

POST /api/v2/updates/install-upload-backup/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`backup` required
`password`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates install-upload-backup create -p backup=... -p password=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "install-upload-backup &gt; create"]
params = {
    "backup": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    backup='...';
    password='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/updates/install-upload-backup/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

install-upload-backup > delete

DELETE /api/v2/updates/install-upload-backup/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates install-upload-backup delete

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "install-upload-backup &gt; delete"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/install-upload-backup/'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

needed > read

GET /api/v2/updates/needed/

Indicates if a full apply changes is necessary.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action updates needed read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["updates", "needed &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/updates/needed/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

user-apps

list

GET /api/v2/user-apps/

List user applications. List applications linked to users. At each login, the applications for a user are defined based on the user labels (groups, OUs, username etc.).

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	User id to filter on.
`favorite`	Favorite state to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-apps list -p limit=... -p offset=... -p domain=... -p domain_name=... -p user=... -p favorite=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-apps", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "favorite": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-apps/?limit=...&offset=...&domain=...&domain_name=...&user=...&favorite=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/user-apps/{id}/

Get details for a user application.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	User id to filter on.
`favorite`	Favorite state to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-apps read -p id=... -p domain=... -p domain_name=... -p user=... -p favorite=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-apps", "read"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "favorite": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-apps/{id}/?domain=...&domain_name=...&user=...&favorite=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/user-apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	User id to filter on.
`favorite`	Favorite state to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`favorite`	Whether or not this application is marked as favorite.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-apps update -p id=... -p favorite=... -p domain=... -p domain_name=... -p user=... -p favorite=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-apps", "update"]
params = {
    "id": ...,
    "favorite": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "favorite": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    favorite='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-apps/{id}/?domain=...&domain_name=...&user=...&favorite=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/user-apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user app.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`user`	User id to filter on.
`favorite`	Favorite state to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`favorite`	Whether or not this application is marked as favorite.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-apps partial_update -p id=... -p favorite=... -p domain=... -p domain_name=... -p user=... -p favorite=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-apps", "partial_update"]
params = {
    "id": ...,
    "favorite": ...,
    "domain": ...,
    "domain_name": ...,
    "user": ...,
    "favorite": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    favorite='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-apps/{id}/?domain=...&domain_name=...&user=...&favorite=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

user-count

list

GET /api/v2/user-count/

Get the name (unique) user count per month. Each entry's date is the first day of the month.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`date`	Filter for a given date in YYYY-MM-DD format.
`date__gte`	Filter for dates later or equal than the given date in YYYY-MM-DD format. Can be combined with date__lte.
`date__lte`	Filter for dates sooner or equal than the given date in YYYY-MM-DD format. Can be combined with date__gte.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-count list -p limit=... -p offset=... -p date=... -p date__gte=... -p date__lte=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-count", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "date": ...,
    "date__gte": ...,
    "date__lte": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-count/?limit=...&offset=...&date=...&date__gte=...&date__lte=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

user-file-types

list

GET /api/v2/user-file-types/

List file types, which are used to link applications to files.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types list -p limit=... -p offset=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/?limit=...&offset=...&user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

create

POST /api/v2/user-file-types/

Create a new file type. File types are used to link applications to files.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file_type` required
`default_app` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types create -p file_type=... -p default_app=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "create"]
params = {
    "file_type": ...,
    "default_app": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file_type='...';
    default_app='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/user-file-types/{id}/

Get details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types read -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "read"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/{id}/?user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/user-file-types/{id}/

Update details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file_type` required
`default_app` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types update -p id=... -p file_type=... -p default_app=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "update"]
params = {
    "id": ...,
    "file_type": ...,
    "default_app": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file_type='...';
    default_app='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/{id}/?user=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/user-file-types/{id}/

Update some details of a file type. File types are used to link applications to files.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file_type`
`default_app`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types partial_update -p id=... -p file_type=... -p default_app=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "partial_update"]
params = {
    "id": ...,
    "file_type": ...,
    "default_app": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    file_type='...';
    default_app='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/{id}/?user=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/user-file-types/{id}/

Delete a file type. File types are used to link applications to files. Deleting a file type will not delete the applications/files linked to it.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user file type.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-file-types delete -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-file-types", "delete"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-file-types/{id}/?user=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

user-profiles

list

GET /api/v2/user-profiles/

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-profiles list -p limit=... -p offset=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-profiles", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-profiles/?limit=...&offset=...&user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/user-profiles/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user profile.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-profiles read -p id=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-profiles", "read"]
params = {
    "id": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-profiles/{id}/?user=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/user-profiles/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user profile.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`default_polygon_enabled`
`keyboard_layout` required	The Windows keyboard layout code of the keyboard layout to use in streamed applications.
`locale` required	The two letter ISO language code of the language to use in the Workspace.
`tours_enabled` required	Whether or not guided tours are enabled for this user. When reenabling tours here, all tours will be reset and shown again.
`update_required`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-profiles update -p id=... -p default_polygon_enabled=... -p keyboard_layout=... -p locale=... -p tours_enabled=... -p update_required=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-profiles", "update"]
params = {
    "id": ...,
    "default_polygon_enabled": ...,
    "keyboard_layout": ...,
    "locale": ...,
    "tours_enabled": ...,
    "update_required": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    default_polygon_enabled='...';
    keyboard_layout='...';
    locale='...';
    tours_enabled='...';
    update_required='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-profiles/{id}/?user=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/user-profiles/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user profile.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`user`	User id to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`default_polygon_enabled`
`keyboard_layout`	The Windows keyboard layout code of the keyboard layout to use in streamed applications.
`locale`	The two letter ISO language code of the language to use in the Workspace.
`tours_enabled`	Whether or not guided tours are enabled for this user. When reenabling tours here, all tours will be reset and shown again.
`update_required`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-profiles partial_update -p id=... -p default_polygon_enabled=... -p keyboard_layout=... -p locale=... -p tours_enabled=... -p update_required=... -p user=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-profiles", "partial_update"]
params = {
    "id": ...,
    "default_polygon_enabled": ...,
    "keyboard_layout": ...,
    "locale": ...,
    "tours_enabled": ...,
    "update_required": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    default_polygon_enabled='...';
    keyboard_layout='...';
    locale='...';
    tours_enabled='...';
    update_required='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-profiles/{id}/?user=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

revoke_privacy_policy

POST /api/v2/user-profiles/{id}/revoke-privacy-policy/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user profile.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-profiles revoke_privacy_policy -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-profiles", "revoke_privacy_policy"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-profiles/{id}/revoke-privacy-policy/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

user-sessions

list

GET /api/v2/user-sessions/

List of active sessions. A session corresponds with a login on the Workspace. Super admin can see all sessions, domain admin all sessions connected to his domain.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`status`	Filter on the status, which can be ACTIVE, DISCONNECTED or CLOSED.
`start`	Filter the sessions started after the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`end`	Filter the sessions ended before the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-sessions list -p limit=... -p offset=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-sessions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-sessions/?limit=...&offset=...&status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/user-sessions/{public_session_id}/

Get time and location details of a session. A session corresponds with a login on the Workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`public_session_id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`status`	Filter on the status, which can be ACTIVE, DISCONNECTED or CLOSED.
`start`	Filter the sessions started after the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`end`	Filter the sessions ended before the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-sessions read -p public_session_id=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-sessions", "read"]
params = {
    "public_session_id": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/user-sessions/{public_session_id}/?status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

update

PUT /api/v2/user-sessions/{public_session_id}/

Update the status of a session. A session corresponds with a login on the workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`public_session_id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`status`	Filter on the status, which can be ACTIVE, DISCONNECTED or CLOSED.
`start`	Filter the sessions started after the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`end`	Filter the sessions ended before the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`status` required	An active session can be set to CLOSED.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-sessions update -p public_session_id=... -p status=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-sessions", "update"]
params = {
    "public_session_id": ...,
    "status": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    status='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-sessions/{public_session_id}/?status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'put' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

partial_update

PATCH /api/v2/user-sessions/{public_session_id}/

Update the status of a session. A session corresponds with a login on the Workspace.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`public_session_id` required

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`status`	Filter on the status, which can be ACTIVE, DISCONNECTED or CLOSED.
`start`	Filter the sessions started after the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`end`	Filter the sessions ended before the given time in ISO 8601 notation, e.g. 2017-12-20T23:56:12
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`status`	An active session can be set to CLOSED.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action user-sessions partial_update -p public_session_id=... -p status=... -p status=... -p start=... -p end=... -p domain=... -p domain_name=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["user-sessions", "partial_update"]
params = {
    "public_session_id": ...,
    "status": ...,
    "status": ...,
    "start": ...,
    "end": ...,
    "domain": ...,
    "domain_name": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    status='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/user-sessions/{public_session_id}/?status=...&start=...&end=...&domain=...&domain_name=...'
$response = Invoke-RestMethod -Method 'patch' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

users

list

GET /api/v2/users/

List users. LDAP/AD users are only added when they sign-in for the first time.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`username`	Username to filter on.
`search`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users list -p limit=... -p offset=... -p domain=... -p domain_name=... -p username=... -p search=... -p ordering=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "domain": ...,
    "domain_name": ...,
    "username": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/users/?limit=...&offset=...&domain=...&domain_name=...&username=...&search=...&ordering=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

query

POST /api/v2/users/query/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`query` required

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users query -p query=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "query"]
params = {
    "query": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    query='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/users/query/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/users/{id}/

Get details of a user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`username`	Username to filter on.
`search`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users read -p id=... -p domain=... -p domain_name=... -p username=... -p search=... -p ordering=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "read"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
    "username": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/users/{id}/?domain=...&domain_name=...&username=...&search=...&ordering=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

delete

DELETE /api/v2/users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`domain`	Domain id to filter on.
`domain_name`	Domain name to filter on.
`username`	Username to filter on.
`search`
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users delete -p id=... -p domain=... -p domain_name=... -p username=... -p search=... -p ordering=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "delete"]
params = {
    "id": ...,
    "domain": ...,
    "domain_name": ...,
    "username": ...,
    "search": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/users/{id}/?domain=...&domain_name=...&username=...&search=...&ordering=...'
$response = Invoke-RestMethod -Method 'delete' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

otp_reset

POST /api/v2/users/{id}/otp-reset/

Reset the builtin OTP token and counter of the user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`date_joined`
`email`
`is_active`	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
`is_superuser`	Designates that this user has all permissions without explicitly assigning them.
`last_login`
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users otp_reset -p id=... -p date_joined=... -p email=... -p is_active=... -p is_superuser=... -p last_login=... -p username=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "otp_reset"]
params = {
    "id": ...,
    "date_joined": ...,
    "email": ...,
    "is_active": ...,
    "is_superuser": ...,
    "last_login": ...,
    "username": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    date_joined='...';
    email='...';
    is_active='...';
    is_superuser='...';
    last_login='...';
    username='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/users/{id}/otp-reset/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

get-rdp-gateway > read

GET /api/v2/users/{id}/get-rdp-gateway/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users get-rdp-gateway read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "get-rdp-gateway &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/users/{id}/get-rdp-gateway/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

recent-files > read

GET /api/v2/users/{id}/recent-files/

Returns the files recently opened from the Files page.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this user.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action users recent-files read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["users", "recent-files &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/users/{id}/recent-files/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

validators

list

GET /api/v2/validators/

Lists the available validator methods.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators list -p limit=... -p offset=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/validators/?limit=...&offset=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

database

POST /api/v2/validators/database/

Validate database connection string, connectivity, availibility & permissions.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`database_protocol` required	Database protocol: mssql or postgresql.
`database_username` required	Database connection username.
`database_password` required	Database connection password.
`database_name` required	Database name.
`database_host` required	Database hostname or IP.
`database_instance`	Optional. Database instance name. Only for Microsoft SQL Server.
`database_port`	Optional. Database port number. Not used when used with a named instance name.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators database -p database_protocol=... -p database_username=... -p database_password=... -p database_name=... -p database_host=... -p database_instance=... -p database_port=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "database"]
params = {
    "database_protocol": ...,
    "database_username": ...,
    "database_password": ...,
    "database_name": ...,
    "database_host": ...,
    "database_instance": ...,
    "database_port": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    database_protocol='...';
    database_username='...';
    database_password='...';
    database_name='...';
    database_host='...';
    database_instance='...';
    database_port='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/validators/database/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

dns

POST /api/v2/validators/dns/

Validate dns resolving.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`servers` required	JSON list of IP addresses of DNS servers

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators dns -p servers=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "dns"]
params = {
    "servers": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    servers='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/validators/dns/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

hostname

POST /api/v2/validators/hostname/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`hostname` required	Hostname of the appliance

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators hostname -p hostname=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "hostname"]
params = {
    "hostname": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    hostname='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/validators/hostname/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

minimum_requirements

POST /api/v2/validators/minimum-requirements/

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators minimum_requirements

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "minimum_requirements"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/validators/minimum-requirements/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

ntp_server

POST /api/v2/validators/ntp-server/

Validate ntp availibility.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`servers` required	JSON list of IP addresses or FQDNs of NTP servers

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators ntp_server -p servers=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "ntp_server"]
params = {
    "servers": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    servers='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/validators/ntp-server/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

repo_server

POST /api/v2/validators/repo-server/

Validate connectivity to a repo server.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`repo_server` required	URL to the repo server.
`http_proxy`	URL to the HTTP proxy server (if any), in the format http(s)://(username:password@)server:port

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action validators repo_server -p repo_server=... -p http_proxy=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["validators", "repo_server"]
params = {
    "repo_server": ...,
    "http_proxy": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$params = @{
    repo_server='...';
    http_proxy='...'
} | ConvertTo-JSON
$url = 'https://demo-psw.parallels.com/api/v2/validators/repo-server/'
$response = Invoke-RestMethod -Method 'post' $url -Body $params `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

versions

list

GET /api/v2/versions/

Lists all known versions. If the repo server can be reached version details are updated.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`number`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions list -p limit=... -p offset=... -p number=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "number": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/?limit=...&offset=...&number=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

read

GET /api/v2/versions/{id}/

Get the details of a version.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this version.

Query Parameters

The following parameters can be included as part of a URL query string. Filters can be combined to further narrow the results.

Parameter	Description
`number`

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions read -p id=... -p number=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "read"]
params = {
    "id": ...,
    "number": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/{id}/?number=...'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

download

POST /api/v2/versions/{id}/download/

Download the packages for this version so upgrading to this version is faster. This does not result in any service interruption, but you cannot upgrade or download other versions while a version is being downloaded.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this version.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions download -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "download"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/{id}/download/'
$response = Invoke-RestMethod -Method 'post' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

license_terms

GET /api/v2/versions/{id}/license-terms/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this version.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions license_terms -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "license_terms"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/{id}/license-terms/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

allowed-upgrade-versions > read

GET /api/v2/versions/{id}/allowed-upgrade-versions/

For a given version, lists all details to which an upgrade is possible.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this version.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions allowed-upgrade-versions read -p id=...

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "allowed-upgrade-versions &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/{id}/allowed-upgrade-versions/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response

current > read

GET /api/v2/versions/current/

Gets details of the currently installed version.

# Load the schema document
$ coreapi get https://demo-psw.parallels.com/api/v2/docs/

# Interact with the API endpoint
$ coreapi action versions current read

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://demo-psw.parallels.com/api/v2/docs/")

# Interact with the API endpoint
action = ["versions", "current &gt; read"]
result = client.action(schema, action)

# Interact with the API endpoint
$url = 'https://demo-psw.parallels.com/api/v2/versions/current/'
$response = Invoke-RestMethod -Method 'get' $url `
    -WebSession $session -ContentType 'application/json'
# Return value is in $response