Update agent configuration
PUT/api/v2/agent/configs
Updates the general configuration settings of the agent.
Request
- application/json
Body
required
Enable automatic delivery trigger
Base delay in seconds used between consecutive retry attempts.
The actual wait grows exponentially: delay * 2^attempt (e.g. 5s → 10s → 20s).
Env var fallback: DELIVERY_RETRY_DELAY_SECS. Default: 5.
Extra storage buffer in bytes reserved beyond component size before allowing delivery. Overrides the STORAGE_DELIVERY_BUFFER_BYTES env variable. Default is 0 (no buffer).
Timeout in minutes for the Prepare phase (waiting for server to return download URLs). Env var fallback: DELIVERY_TIMEOUT_MINS. Default: 30.
Enable automatic deployment on pull
Deployment wait timeout in seconds for third party installers
Periodic discovery interval in minutes. Env var fallback: DISCOVERY_PERIODIC_INTERVAL. Default: 720 (12 hours).
Minutes after which discovery data is considered stale and the UI should trigger a fresh component discovery. Default: 30.
Number of retry attempts before marking a delivery as failed. Governs file download retries, scheduled job retries, and HTTP client retries. Env var fallback: DELIVERY_RETRY_COUNT (or legacy DOWNLOAD_RETRY_COUNT). Default: 3.
Installation timeout in minutes
Enable log dispatch job
Matomo dimension configuration
Matomo analytics buffer size in MB
Matomo analytics retention policy in hours
Matomo server URL
Matomo site identifier
Enable Matomo buffering
Maximum number of concurrent deliveries in the Prepare/Download/Validation phases. Deliveries beyond this limit are queued (status=Queued) and started FIFO. Env var fallback: MAX_PARALLEL_DELIVERIES. Default: 3.
TCP connection timeout in seconds
When true, a background task periodically re-evaluates the primary server URL
and refreshes the connection status.
YAML: network.connection_refresh_enabled. Env: NETWORK_CONNECTION_REFRESH_ENABLED. Default: false.
Interval in seconds between each connection-status refresh.
Only relevant when network_connection_refresh_enabled is true.
YAML: network.connection_refresh_interval_secs. Env: NETWORK_CONNECTION_REFRESH_INTERVAL_SECS. Default: 60.
Interval in minutes at which the slave checks sysinfo (device metadata) to the master.
Status check polling interval in seconds
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
Enable automatic delivery trigger
Base delay in seconds used between consecutive retry attempts.
The actual wait grows exponentially: delay * 2^attempt (e.g. 5s → 10s → 20s).
Env var fallback: DELIVERY_RETRY_DELAY_SECS. Default: 5.
Extra storage buffer in bytes reserved beyond component size before allowing delivery. Overrides the STORAGE_DELIVERY_BUFFER_BYTES env variable. Default is 0 (no buffer).
Timeout in minutes for the Prepare phase (waiting for server to return download URLs). Env var fallback: DELIVERY_TIMEOUT_MINS. Default: 30.
Enable automatic deployment on pull
Deployment wait timeout in seconds for third party installers
Periodic discovery interval in minutes. Env var fallback: DISCOVERY_PERIODIC_INTERVAL. Default: 720 (12 hours).
Minutes after which discovery data is considered stale and the UI should trigger a fresh component discovery. Default: 30.
Number of retry attempts before marking a delivery as failed. Governs file download retries, scheduled job retries, and HTTP client retries. Env var fallback: DELIVERY_RETRY_COUNT (or legacy DOWNLOAD_RETRY_COUNT). Default: 3.
Installation timeout in minutes
Enable log dispatch job
Matomo dimension configuration
Matomo analytics buffer size in MB
Matomo analytics retention policy in hours
Matomo server URL
Matomo site identifier
Enable Matomo buffering
Maximum number of concurrent deliveries in the Prepare/Download/Validation phases. Deliveries beyond this limit are queued (status=Queued) and started FIFO. Env var fallback: MAX_PARALLEL_DELIVERIES. Default: 3.
TCP connection timeout in seconds
When true, a background task periodically re-evaluates the primary server URL
and refreshes the connection status.
YAML: network.connection_refresh_enabled. Env: NETWORK_CONNECTION_REFRESH_ENABLED. Default: false.
Interval in seconds between each connection-status refresh.
Only relevant when network_connection_refresh_enabled is true.
YAML: network.connection_refresh_interval_secs. Env: NETWORK_CONNECTION_REFRESH_INTERVAL_SECS. Default: 60.
Interval in minutes at which the slave checks sysinfo (device metadata) to the master.
Status check polling interval in seconds
{
"deliveryAutoTrigger": true,
"deliveryRetryDelaySecs": 0,
"deliveryStorageBufferBytes": 0,
"deliveryTimeoutMins": 0,
"deployAutoOnPull": true,
"deployTimeoutSec": 0,
"discoveryPeriodicIntervalMin": 0,
"discoveryStaleAfterMins": 0,
"downloadRetryCount": 0,
"installDoneTimeoutMin": 0,
"logsRunDispatchJob": true,
"matomoDimensionId": "string",
"matomoMaxBufferSizeMb": 0,
"matomoMaxRetentionHours": 0,
"matomoServerUrl": "string",
"matomoSiteId": "string",
"matomoUseBuffer": true,
"maxParallelDeliveries": 0,
"netTcpStreamTimeoutSec": 0,
"networkConnectionRefreshEnabled": true,
"networkConnectionRefreshIntervalSecs": 0,
"orchSysinfoCheckMins": 0,
"queryStatusIntervalSec": 0
}