Skip to main content

Get agent configuration

GET 
/api/v2/agent/configs

Retrieves the general configuration settings of the agent.

Request​

Responses​

Schema

    deliveryAutoTrigger booleannullable

    Enable automatic delivery trigger

    deliveryRetryDelaySecs int32nullable

    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.

    deliveryStorageBufferBytes int64nullable

    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).

    deliveryTimeoutMins int32nullable

    Timeout in minutes for the Prepare phase (waiting for server to return download URLs). Env var fallback: DELIVERY_TIMEOUT_MINS. Default: 30.

    deployAutoOnPull booleannullable

    Enable automatic deployment on pull

    deployTimeoutSec int64nullable

    Deployment wait timeout in seconds for third party installers

    discoveryPeriodicIntervalMin int32nullable

    Periodic discovery interval in minutes. Env var fallback: DISCOVERY_PERIODIC_INTERVAL. Default: 720 (12 hours).

    discoveryStaleAfterMins int32nullable

    Minutes after which discovery data is considered stale and the UI should trigger a fresh component discovery. Default: 30.

    downloadRetryCount int32nullable

    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.

    installDoneTimeoutMin int64nullable

    Installation timeout in minutes

    logsRunDispatchJob booleannullable

    Enable log dispatch job

    matomoDimensionId stringnullable

    Matomo dimension configuration

    matomoMaxBufferSizeMb int32nullable

    Matomo analytics buffer size in MB

    matomoMaxRetentionHours int32nullable

    Matomo analytics retention policy in hours

    matomoServerUrl stringnullable

    Matomo server URL

    matomoSiteId stringnullable

    Matomo site identifier

    matomoUseBuffer booleannullable

    Enable Matomo buffering

    maxParallelDeliveries int32nullable

    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.

    netTcpStreamTimeoutSec int64nullable

    TCP connection timeout in seconds

    networkConnectionRefreshEnabled booleannullable

    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.

    networkConnectionRefreshIntervalSecs int64nullable

    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.

    orchSysinfoCheckMins int32nullable

    Interval in minutes at which the slave checks sysinfo (device metadata) to the master.

    queryStatusIntervalSec int64nullable

    Status check polling interval in seconds

Loading...