REST Settings

The REST settings allows you manage REST API specific settings including connection options, storage directory, number of threads used by processes when making REST API calls to the server.

To view the REST Settings: Go to Preferences Panel > REST Tab

 

Settings

General

Rest Server - Sets the IP address to receive REST calls from on the server. When set to a specific address calls can only be made to the server from that address. If 0.0.0.0 is selected the server will serve REST resources on all available network interfaces.

Authorizer - Specifies who / what is able to access the rest server

Content Provider: Sets the content provider (where the files are stored and managed) for the PAS service

Storage Directory - enter the complete file path to the directory you wish to have all of the REST files stored on the server.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

REST threads - the number of threads (cores) on the server you want to be used by REST processes. The number to the right of the field will display the total number of cores available on the server.

Allow Origin - Setting that lets you access REST services from another domain.  It will set the value of the "Access-Control-Allow-Origin" response header.

HTTP

Enable HTTP - enables HTTP access to a specified port

HTTP Port - port to be used for HTTP access. The default setting is 8090.

Note: The HTTP Port cannot match the HTTPS or RMI (default 1099) port settings

HTTPS

Enable HTTPS - enables HTTPS access to a specified port

HTTPS Port - port to be used for HTTPS access. The default setting is 8091.

Note: The HTTPs Port cannot match the HTTP or RMI (default 1099) port settings

PKCS#12 File - enter the complete file path to the PKCS#12 file (.pfx or .p12) used by HTTPS calls made to the server.

Note: This directory is local to where the server is running not the PAS Manager and so the file path must follow the format set by the OS of the server.

Password - The password to access the keystore file

 

 


Qoppa Software's PDF Automation Server for Windows, Linux, Unix, and macOS

Automate PDF Document Workflows through RESTful Web Services & Folder Watching

Copyright © 2002-Present Qoppa Software. All rights reserved.