Find answers to common questions about Cloudmersive products and services.
Cloudmersive Private Cloud Settings Configuration Variables |
5/7/2025 - Cloudmersive Support |
Customers can configure Cloudmersive Private Cloud using advanced settings variables. Navigate to Boolean settings should have an integer value of Below is a complete reference of customer configurable settings. After settings changes, customers can click on Validate APIValidateApi_EmailValidation_DisplayNameDisplay-name string that appears as the sender when the Email Validation service dispatches test or confirmation e-mails. ValidateApi_EmailValidation_FromAddressThe “From:” address used by the Email Validation service when sending outbound e-mail traffic. Reverse ProxyReverseProxy_OriginTimeoutMsMaximum time (ms) the proxy waits for a response from the upstream origin before aborting. ReverseProxy_OriginFailedRequestRetryCountNumber of retry attempts the proxy makes when the origin returns an error or times out. ReverseProxy_OriginFailedRequestDelayMsDelay (ms) between successive retries to the origin. ReverseProxy_OriginRequestVersionHTTP version the proxy uses when forwarding requests to the origin (e.g., 1.1 or 2.0). ReverseProxy_SkipTransformOnUriSubstringMatchComma-separated substrings; if any appear in the request URI, response/body transforms are skipped. ReverseProxy_EnableCustomRootTrust_UsePEMFormatWhen true, custom root-CA certificates are supplied in PEM format instead of PFX. ReverseProxy_ConnectionTimeoutMsMaximum time (ms) allowed to establish a TCP connection to the origin. ReverseProxy_KeepAliveTimeoutMsIdle keep-alive timeout (ms) for persistent connections back to the client. Storage ProtectionStorageProtect_IncrementalSiteDetectionEnables incremental scanning of SharePoint/OneDrive sites, processing only items that changed since the previous run. StorageProtection_FileChangeDebounceThresholdMsMinimum interval (ms) between consecutive change events on the same file. StorageProtection_WebhookIncludeFileContentsSends file bytes (not just metadata) when invoking webhook callbacks. Virus API — GeneralVirusApi_DetailedResultLoggingRecords full per-file detection details (file name, hash, rule ID) in the diagnostic logs. VirusApi_ExecutionTimeout_SecondsHard wall-clock limit for any single virus-scan request. VirusApi_HashSha1_AllowListSemicolon-delimited list of SHA-1 hashes that should always result in a clean verdict. VirusApi_HashSha1_BlockListSemicolon-delimited SHA-1 hashes that should always be blocked, even if no malware is detected. VirusApi_Vmdk_AllowMultipleDetectionsAllows more than one malware hit inside the same VMDK image to be reported. VirusApi_Vmdk_EnableHashEngineScanEnables the lightweight hash engine for inner files inside virtual-disk (VMDK) containers. VirusApi_BatchJob_ProcessIsolationRuns multi-file batch jobs in isolated worker processes to reduce cross-job interference. VirusApi_AzureStorageProtect_ProcessIsolationSame as above but restricted to Azure Storage-Protect scan jobs. VirusApi_ArchiveMaximumThreadsUpper bound on worker threads used to extract very large archives. VirusApi_Block_BasicScanApiDisables the Basic Scan endpoint in favour of the Advanced Scan endpoint. VirusApi_Force_BasicScanApi_ToUseAdvancedScanApiForwards all Basic Scan requests internally to the Advanced Scan engine. VirusApi_ConcurrencyLimit_AwsS3_StorageProtectLimits parallel S3-based Storage Protect scan workers to avoid API throttling. VirusApi_StorageProtect_NsfwRescanAdvancedForces files flagged as NSFW in a basic scan to be rescanned using the Advanced AI engine. VirusApi_StorageProtect_Nsfw_TimeoutMsExecution timeout for NSFW detection (ms). VirusApi_CloudSeg_LimitBytesMaximum number of bytes that will be transmitted to the Cloud Segmentation service for multi-stage analysis. Virus API — Advanced ScanVirusApi_AdvancedScan_Advanced_TimeoutMinutesOverall timeout (minutes) for the advanced scanner. VirusApi_AdvancedScan_JSON_MaxLengthUpper bound (characters) for JSON results returned by Advanced Scan. VirusApi_AdvancedScan_UnsafeZip_SafeZipEntryThresholdNumber of benign entries below which a ZIP is marked “safe” even if it matches risk heuristics. VirusApi_AdvancedScan_Cloud_CacheLocalCaches cloud-retrieved sub-files on local disk to speed up repeated scans. VirusApi_AdvancedScan_Cloud_VfsMaximumTimeoutMsFails a cloud VFS expansion if it exceeds this time (ms). VirusApi_AdvancedScan_Cloud_VfsMaximumChildFileSizeRejects individual extracted sub-files larger than this size (bytes). VirusApi_AdvancedScan_Cloud_VfsMaximumThreadsCaps VFS extraction threads; helps prevent CPU starvation. VirusApi_AdvancedScan_SubFiles_MultiScanEnables independent scanning of each sub-file within an archive or container. VirusApi_AdvancedScan_SubFiles_MaxCountMaximum number of sub-files that will be individually scanned. Virus API — Feature TogglesVirusApi_Disable_ScanWebsiteApiDisables the ScanWebsite endpoint. VirusApi_Disable_ScanCloudStorageSharepointOnlineApiDisables SharePoint Online scan endpoint. VirusApi_Disable_ScanCloudStorageAzureBlobApiDisables Azure Blob Storage scan endpoint. VirusApi_Disable_ScanCloudStorageGcpStorageApiDisables Google Cloud Storage scan endpoint. VirusApi_Disable_ScanCloudStorageAwsS3ApiDisables Amazon S3 scan endpoint. VirusApi_StorageProtect_NsfwRescanAdvancedForces NSFW-flagged files to be rescanned with the Advanced AI engine. Image APIImageApi_Nsfw_DisableVirusScanSkips virus scanning on images when only NSFW detection is requested. OCR APIOcrApi_ConcurrentAsyncJobLimitCaps parallel asynchronous OCR jobs across the node. Convert APIConvertApi_DefaultDPIDefault resolution (DPI) when rasterising PDFs or images during conversion. Global API Toggles & DiagnosticsAllApi_Disable_AdvancedVirusScanTurns off advanced virus scanning for every API; basic scanning may still run. AllApi_Disable_BasicVirusScanDisables basic scan engine; requests relying on it will return an error unless advanced scan enabled. AllApi_Disable_EnsureHtmlIsSafeSkips sanitisation of raw HTML content. AllApi_Disable_EnsureHtmlUrlIsSafeSkips URL reputation checks when sanitising HTML. AllApi_PrivateCloudRemoteDiagnosticsEnabledAllows Cloudmersive Support to pull anonymised diagnostics from the node. AllApi_PrivateCloudRemoteFullDetailedDiagnosticsEnabledGrants Support access to full (non-anonymised) diagnostics. AllApi_PrivateCloud_LocalDiagnosticLoggingWrites detailed logs locally, regardless of remote-diagnostics settings. AllApi_LocalDiagnosticLoggingMaster switch for local diagnostic log output. AllApi_DiagnosticModeIf true, responses include extra timing and trace headers for debugging. AllApi_Authentication_BasicEnables Basic-Auth authentication across all APIs. AllApi_Authentication_OAuth2_AzureADEnables Azure AD OAuth 2.0 JWT token validation. AllApi_Authentication_OAuth2_AzureAD_TenantIDTenant ID against which tokens must validate. AllApi_Authentication_OAuth2_AzureAD_ClientIDApp-registration (client) ID accepted in the AllApi_Tempstash_EndpointEndpoint for temporary-file storage. AllApi_Disable_StatusPageIPAddressInfoHides the IP section on status pages. ICAP ServerIcapServer_EnableTLSEnables TLS on the ICAP listener. IcapServer_EnableManagedInstanceHostedCertificateUses the platform-managed certificate instead of a custom one. IcapServer_TLSCertificateIDResource ID of a managed certificate. IcapServer_TLSCertificateThumbprintThumbprint (SHA-1 hash) identifying the certificate to load. IcapServer_TLSCertificatePathAbsolute path to a local PFX/PEM certificate file. IcapServer_TLSCertificatePwdPassword for the certificate file (if encrypted). IcapServer_ReceiveTimeoutSecondsSocket receive timeout for ICAP requests. IcapServer_ScanTimeoutMsMaximum per-request scan duration (ms). IcapServer_RequireAllEncapsulatiosnValidRejects requests that contain unknown or malformed encapsulated parts. IcapServer_VerboseLoggingEnables detailed ICAP protocol logging (headers, bodies, previews). IcapServer_PortNumberTCP port on which the ICAP service listens. IcapServer_LogRequestsToFileWrites high-level request/response summaries to disk. IcapServer_LogRawRequestsToFileStores full raw ICAP transactions for troubleshooting. IcapServer_LogRawRequestsToFile_IfBlockedStores raw transactions only when the response is a block/virus verdict. IcapServer_LogRawRequestsToFile_ShowSourceIncludes annotations in raw log showing which content comes from client and from server. IcapServer_ConnectionKeepAliveTimeoutMsIdle timeout (ms) before the server closes persistent connections. IcapServer_ScanChunkedTransferEnables virus scanning API calls using chunked transfer for large files. IcapServer_ServerReadTimeoutMsRead timeout for local disk or cloud object download during scan. IcapServer_KeepAliveForceCloseForces a TCP FIN after every response (no keep-alive). IcapServer_KeepAliveForceClose_ResponseMessageLimitNumber of responses after which the connection is closed even if keep-alive enabled. Endpoint ProxyEndpointProxy_LogRequestsEnables request/response logging in the API endpoint proxy. EndpointProxy_ClientIpWhitelistComma-separated list of CIDR blocks that are permitted to use the proxy. EndpointProxy_EnableTLSEnables TLS termination on the proxy. EndpointProxy_TLSCertificatePathPath to the proxy’s TLS certificate. EndpointProxy_TLSCertificatePwdPassword for the proxy’s certificate file. EndpointProxy_TLSCertificateThumbprintThumbprint of a certificate to load from the local store. Miscellaneous / InstallerPrivateCloudOfflineInstallIf true, suppresses auto-updates and remote diagnostics for completely air-gapped deployments. |