AdvancedSettings

Get advanced settings

Returns advanced settings.

get/advanced_settings

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Response

Successful response

settingsobject required

Advanced configuration settings. For optional fields, only includes values explicitly set by the user. May include additional custom parameters not listed here.

settings.server_originstring

Management Console address.

settings.file_query_timeoutnumber

File query timeout in seconds. Specifies how long the File query functionality waits before timing out.

settings.history_ttlnumber

Job run time to live in milliseconds. Determines how long finished Job runs are stored. Default is 14 days. Set to 0 to retain runs indefinitely.

settings.jobs_ttlnumber

Job time to live in milliseconds. Specifies how long Jobs are stored. Set to 0 to retain jobs indefinitely.

settings.identify_agent_by_nameboolean

Identify agent by name. If true, agents will be identified by their names instead of peer_id device IDs.

settings.ata_token_lifetimenumber

Agent-to-agent token lifetime in seconds. Defines how long the encryption token between agents remains valid.

settings.ata_token_overlapnumber

Agent-to-agent token overlap period in seconds. Specifies how long both the current and new tokens remain valid during a rollover.

settings.trusted_castring

Trusted Certificate Authorities. List of trusted certificate authorities in PEM format for external connections such as SMTP, LDAP, webhooks. Separate multiple certificates with a newline character.

settings.user_session_idle_timeoutnumber

User session idle timeout (in minutes). Session expires after this duration of inactivity.

settings.ui_sleep_timeoutnumber

UI sleep timeout in milliseconds. Defines how long the UI remains idle before unloading.

settings.send_mail_timeoutnumber

Send email timeout in milliseconds. Defines how long the system waits for an email to be sent before timing out.

settings.send_webhook_timeoutnumber

Webhook send timeout in milliseconds. Defines how long the system waits for a webhook to be sent before timing out.

settings.search_historyboolean

Table search history. If enabled, preserves search queries, sorting, filtering and page size for UI tables.

settings.default_logger_levelstring

Default log level. Defines the minimum severity level of logs to retain. Note: Setting a level lower than error may impact performance on larger setups.

updated_atnumber required

Updated at (seconds)

updated_bystring required

Name of the user who updated advanced settings the last time

Changes

No recorded changes to this operation across all 1 revision of this API.