GuideAPI Reference
API Reference
Portal

Update Instance Configuration

post
https://endpoint.example.com/admin/config

Update server configuration

Body Params

You can submit the entire configuration body, or only the specific keys that you wish to update.

number

Server Log Level (0=Debug, 1=Info, 2=Warning, 3=Error)

boolean

Enable to log all incoming HTTP requests

boolean

Enable AES-based encryption on all sensitive data on the server, which includes all images, transactions, documents and api keys. Enabling this option will minimize risk of data leaks if the server is compromised, at the cost of performance overhead.

number

Time before temporary files generated while processing requests will be deleted, including output images (seconds)

number

Time before saved transactions will be deleted (seconds). Set 0 to never delete any transactions.

number

Time before saved audit log will be deleted (seconds). Set 0 to never delete any audit log.

number

Time before saved server log will be deleted (days). Set 0 to never delete any server logs.

string

Linux style cron syntax indicating how often the housekeeping script should be run, to clear all the expired data and temporary files. If left blank, the housekeeping script will only run during startup.

integer

Sets the maximum number of concurrent processes can be run.

integer

Sets the maximum number of process queues that the queue service creates before throwing an exception.

number

Number of seconds before user/admin gets logged out of portal for inactivity.

number

Operaiton Mode (0=Single 1=Cluster)

number

The channel that the software should fetch update from: 0=Stable, 1=Beta, 2=Alpha

engines
object
ocr
object

Supports multiple OCR engines to recognize text on extracted data fields. If more than one engines are enabled, engine that returns highest confidence score will be used as result.

gpu
object

GPU can accelerate inference speed

credentials
object

Cloud credentials must be provided if any of the cloud OCR services or engines are enabled. Crendentials must be supplied in array format, if more than one crendential is supplied for a random crendential will be used for each API request.

server
object
database
object

A remote database should be specified when running in clustermode, if no database is specified, all data will be stored locally within the instance.

Responses

Updated about 2 years ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago