Parallels REST API

Get

get

Retrieve information about RAS printing settings.

Query parameters

SiteIdinteger · int32

Site ID for which to retrieve the RAS universal printing settings (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PrintingSettings'

200

401

404

{
  "embedFonts": true,
  "replicatePrinterFont": true,
  "replicatePrinterPattern": true,
  "replicatePrinterDrivers": true,
  "driverAllowMode": [
    "0 = AllowRedirUsingAnyDriver",
    "1 = AllowRedirUsingSpecifiedDriver",
    "2 = DoNotAllowRedirUsingSpecifiedDriver"
  ],
  "printerDriversArray": [
    "text"
  ],
  "excludedFontsArray": [
    "text"
  ],
  "autoInstallFonts": [
    "text"
  ],
  "printerNamePattern": "text"
}

Success

Update

put

Modify printing settings of a Site. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

SiteIdinteger · int32

Site ID (optional)

Body

printerDriversArraystring[] | nullable

<para type="description">Printer Drivers string array.</para>

excludedFontsArraystring[] | nullable

<para type="description">Excluded Fonts string array.</para>

printerNamePatternstring | nullable

<para type="description">Printer Name Pattern.</para> <para type="description">Default pattern: %PRINTERNAME% for %USERNAME% by Parallels</para> <para type="description">Valid pattern variables: %PRINTERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% </para> <para type="description">Other valid pattern: 2X Universal Printer</para>

embedFontsboolean | nullable

<para type="description">Embed Fonts.</para>

replicatePrinterFontboolean | nullable

<para type="description">Replicate Printer Font Settings.</para>

replicatePrinterPatternboolean | nullable

<para type="description">Replicate Printer Name Pattern Settings.</para>

replicatePrinterDriversboolean | nullable

<para type="description">Replicate Printer Drivers Settings.</para>

driverAllowModestring · enum

<para type="synopsis">Printer Driver Allow Mode.</para> <para type="description"></para> <para type="description"></para>

Options: 0 = AllowRedirUsingAnyDriver,1 = AllowRedirUsingSpecifiedDriver,2 = DoNotAllowRedirUsingSpecifiedDriver

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/PrintingSettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "printerDriversArray": [
      "text"
    ],
    "excludedFontsArray": [
      "text"
    ],
    "printerNamePattern": "text",
    "embedFonts": true,
    "replicatePrinterFont": true,
    "replicatePrinterPattern": true,
    "replicatePrinterDrivers": true,
    "driverAllowMode": [
      "0 = AllowRedirUsingAnyDriver",
      "1 = AllowRedirUsingSpecifiedDriver",
      "2 = DoNotAllowRedirUsingSpecifiedDriver"
    ]
  }'

204

401

404

No body

No Content

Get

get

Retrieve information about RAS printing settings font of a site.

Query parameters

SiteIdinteger · int32

Site ID for which to retrieve the RAS printing settings font (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PrintingSettings/AutoInstallFonts'

200

401

404

[
  "text"
]

Success

Add

post

Add a new RAS Printing settings font to a site.

Query parameters

SiteIdinteger · int32

ID of the site to which the font will be added (optional)

Body

fontFilestring · binary

Upload File

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PrintingSettings/AutoInstallFonts' \
  --header 'Content-Type: multipart/form-data' \
  --form 'fontFile=text'

201

401

409

No body

Created

Delete

delete

Delete a RAS Printing settings font from a site.

Query parameters

SiteIdinteger · int32

ID of the site from which the font will be deleted (optional)

Body

fontNamestring | nullablerequired

<para type="description">Auto Install Font Name.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PrintingSettings/AutoInstallFonts' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "fontName": "text"
  }'

204

401

404

No body

No Content

Printing

Auto Install Fonts

Printing

Auto Install Fonts

Get

Update

Get

Add

Delete