DataElicit Logo

Docs

connector.conf

Configuration reference for Box connector.conf

CONNECTOR.CONF

Specifications

Important

auth configuration must always be present and frequency should always be -1
# Configuration for authentication 
[auth://<specify_name>]
frequency = -1
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box folder metadata
[folder://<specify_name>]
host = <host-name>, Default is current system hostname
repo =  <repository-name>
sourcetype = dataelicit/box:box-folder
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box file metadata
[file://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-file
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box collaboration metadata
[collaboration://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-folder-collaboration
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box file comments
[file_comments://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filecomment
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box file tasks
[file_tasks://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filetask
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box groups information
[groups://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-groups
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Input to fetch Box users information
[users://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-users
frequency = <seconds>
cron = <cron-expression>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# File ingestion input
[filecontent://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filecontent
frequency = <seconds>
cron = <cron-expression>
folder_or_file_id = <file-or-folder-ID>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

[filecontent_csv://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filecontent_csv
frequency = <seconds>
cron = <cron-expression>
folder_or_file_id = <file-or-folder-ID>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

[filecontent_json://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filecontent_json
frequency = <seconds>
cron = <cron-expression>
folder_or_file_id = <file-or-folder-ID>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

[filecontent_xml://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-filecontent_xml
frequency = <seconds>
cron = <cron-expression>
folder_or_file_id = <file-or-folder-ID>
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

# Box Events (admin_logs or admin_logs_streaming)
[events://<specify_name>]
host = <host-name>
repo =  <repository-name>
sourcetype = dataelicit/box:box-events
frequency = <seconds>
cron = <cron-expression>
delay = <seconds>
collect_since_timestamp = YYYY-MM-DDThh:mm:ss
live_monitoring = 0/1
secret = <secret-stanza-name>
global = <global-stanza-name>
disabled = 0/1

Example

[auth://auth]
frequency = -1
secret = box_creds
global = box

[folder://folder]
sourcetype = dataelicit/box:box-folder
frequency = 604800
secret = box_creds
global = box

[file://file]
sourcetype = dataelicit/box:box-file
frequency = 604800
secret = box_creds
global = box

[events://events]
sourcetype = dataelicit/box:box-events
frequency = 300
delay = 30
collect_since_timestamp = 2025-04-08T07:27:42
live_monitoring = 1
secret = box_creds
global = box

Note

Make sure that the stanza name you define in local/connector.conf is not already disabled in default/connector.conf.
✉️Still stuck? How can we help?

Updated on July 6, 2025

← Manualglobal.conf →