Sign in
Bundle Web To Print

Get Web to Print settings

Changed on

Retrieve the current Web to Print settings configuration including PDF generation tool settings, PDF Reactor configuration, Gotenberg configuration, and other related options.

get/pimcore-studio/api/bundle/web-to-print/settings

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/web-to-print/settings
  • Auth: none declared

Response

Web to Print settings configuration as JSON

additionalAttributesobject

AdditionalAttributes

generalToolstring required

General PDF generation tool

generalDocumentSaveModestring required

Document save mode

pdfreactorProtocolstring required

PDF Reactor protocol

pdfreactorServerstring required

PDF Reactor server

pdfreactorServerPortstring required

PDF Reactor server port

pdfreactorBaseUrlstring required

PDF Reactor base URL

pdfreactorApiKeystring required

PDF Reactor API key

pdfreactorLicencestring required

PDF Reactor licence

pdfreactorEnableLenientHttpsModeboolean required

Enable lenient HTTPS mode for PDF Reactor

pdfreactorEnableDebugModeboolean required

Enable debug mode for PDF Reactor

gotenbergHostUrlstring required

Gotenberg host URL

gotenbergSettingsstring required

Gotenberg settings

chromiumHostUrlstring required

Chromium host URL

chromiumSettingsstring required

Chromium settings

requirementsstring required

Requirements information

Example response

{
  "generalTool": "pdfreactor",
  "generalDocumentSaveMode": "cleanup",
  "pdfreactorProtocol": "https",
  "pdfreactorServer": "cloud.pdfreactor.com",
  "pdfreactorServerPort": "443",
  "pdfreactorBaseUrl": "https://demo.pimcore.com",
  "chromiumHostUrl": "http://nginx:80",
  "requirements": "Please make sure to install chrome-php/chrome via composer"
}

Changes