Printing | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve information about RAS printing settings.

Query parameters

SiteIdinteger · int32optional

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 · int32optional

Site ID (optional)

Body

Update RAS Universal Printing settings

printerDriversArraystring[] | nullableoptional

Printer Drivers string array.

excludedFontsArraystring[] | nullableoptional

Excluded Fonts string array.

printerNamePatternstring | nullableoptional

Printer Name Pattern. Default pattern: %PRINTERNAME% for %USERNAME% by Parallels Valid pattern variables: %PRINTERNAME% | %USERNAME% | %CLIENTNAME% | %SESSIONID% Other valid pattern: 2X Universal Printer

embedFontsboolean | nullableoptional

Embed Fonts.

replicatePrinterFontboolean | nullableoptional

Replicate Printer Font Settings.

replicatePrinterPatternboolean | nullableoptional

Replicate Printer Name Pattern Settings.

replicatePrinterDriversboolean | nullableoptional

Replicate Printer Drivers Settings.

driverAllowModestring · enumoptional

Printer Driver Allow Mode.

Available options: