Skip to main content
Version: 5.0

Configuration JSON

On this page, you will find information about configuration formatting. All configurations must be stored and updated in JSON format. A JSON configuration contains required fields, as well as a field that serves as the configuration identifier. If a configuration includes required fields, they must be present when saving, even if arbitrary fields are otherwise allowed. If the identifier field differs from _id, it will automatically be duplicated in the configuration. In this case, the configuration will be saved with a specific ID and the specified identifier field set to the value of that ID. When performing an update request, the value of this field must match the {config_id} parameter. The table below outlines in which index the configuration is stored, whether arbitrary fields not listed in required or optional ones are allowed, and whether tags are associated with the configurations.

Configuration Characteristics Table

NameIndexIdentifier FieldRequired FieldsOptional FieldsArbitrary Fields AllowedWith Tags
lookups.sm_sme_lookupsnameidx, fieldscondition, sourcetype, limit, wildcards, case_sensitive, cidrmatch-+
db.sm_sme_dbconnection_nameconnection_string, driver_class, driver_file-++
db_queries.sm_sme_db_queriesnamequery--+
dashboards.sm_dashboards_idyaml-++
scripts.sm_sme_scripts_idargumentsCount, script, description, typealias--
tags.sm_sme_tags_id--+-
search_favorites.sm_search_favorite_idquery, historyQueryId, user---
search_histories.sm_search_history_idquery, timestamp, user---
search_anywhere_sources.sm_sme_search_anywhere_sources_idsource_typeserver, port, user, path_to_trust_store, trust_store_password, password, connection_string, connection_url-+
persons.sm_persons_id--+-

Additional Features

The fields, wildcards, case_sensitive, and cidrmatch fields in lookups are passed as arrays of strings. The type field in scripts can only be one of the following values: internal, external, or system. If a configuration contains a password field, it will be stored and displayed in encrypted form.