Skip to main content

Platform

Platform settings represent general configuration of the platform.

Currently there are following platform settings categories:

Util settings​

NameDescriptionRequired
Utils Service URLURL of the Utils Service, if availableNO
CBOM Repository URLBase URL of the CBOM Repository, without /api, for example http://cbom-repository:8080; required for the CBOM synchronizationNO

CBOM synchronization​

The Utils tab also holds the settings of the CBOM synchronization. Clearing a field returns it to its default value.

NameDescriptionDefault Value
CBOM Sync Overlap (seconds)
cbomSyncOverlapSeconds
How far before the start of the last successful sync run each run lists the CBOM Repository again, from 0 to 86400 seconds60 seconds
CBOM Sync Retries (runs)
cbomSyncSkippedRetryRuns
How many later sync runs retry a document that could not be stored before it is permanently skipped, from 0 to 1000; 0 gives it up at the first failure3 runs
CBOM Sync Catch-up (documents)
cbomSyncMaxIngestDocuments
The number of CBOMs whose assets one sync run adds to the inventory in addition to those of the documents it has just stored, from 0 to 10000. These are CBOMs still waiting for their assets, such as uploaded ones. 0 turns this off, and uploaded CBOMs then stay Pending50 documents
CBOM Sync Skip Retention (days)
cbomSyncSkipRetentionDays
How many days after its last attempt a permanently skipped document stays among the skipped documents, from 1 to 3650; a document still retrying is never removed90 days
warning

Saving the Utils tab returns the values that can be set only through the API, listed below, to their defaults, except cbomSyncAssetIngestEnabled. If you have changed them, set them again through the API afterwards.

note

The utils settings are stored as sent. An Update platform settings request that leaves a value out returns it to its default, and one that leaves out the Utils Service URL or the CBOM Repository URL clears that URL; without the CBOM Repository URL, the CBOM synchronization stops. Only cbomSyncAssetIngestEnabled keeps its stored value when it is left out. Send the whole utils section, as Get platform settings returns it, together with your change.

The following values of the utils settings are set through the API:

API keyDescriptionDefault Value
cbomSyncAssetIngestEnabledTurns asset synchronization on or off; while it is off, sync runs still store new CBOMs but add no assets to the inventorytrue
cbomSyncIngestRetryAfterSecondsHow long a CBOM whose asset synchronization is running or has failed is left alone before it is tried again1800 seconds
cbomSyncAssetBatchSizeHow many cryptographic assets are added to or removed from the inventory in one step100
cbomSyncPageSizeHow many entries the platform reads from the CBOM Repository in one request1000

Certificates Settings​

Certificate settings contains configuration of certificate validation behaviour that is applied to all certificates that does not have assigned any RA Profile or does not override these settings. The following options are available:

NameDescriptionDefault Value
Validation EnabledEnable or disable validation of certificatesenabled
Validation FrequencyValidation frequency of certificates specified in daysEveryday
Expiring ThresholdHow many days before expiration should validation status of certificates change to Expiring30 days

Registration​

The Registration section of the Certificates tab holds the platform defaults for certificate pre-registration:

NameDescriptionDefault Value
Default Issuance Window (days)Default issuance window in days, applied to a challenge-protected pre-registration that omits an explicit expiry7 days
Max Failed AttemptsMaximum failed challenge-verification attempts before the registration authorization locks5