Printing | Parallels REST API

Parallels REST API

SupportDocumentation

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

objectOptional

RAS Printing Settings

application/json; api-version=1.0

get

GET /api/PrintingSettings HTTP/1.1
Host: 
Accept: */*

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

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:

Responses

application/json; api-version=1.0

put

PUT /api/PrintingSettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 328

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

No content