NetBird Full API Reference + Read-Only MCP Prototype
GET/api/agent-network/settings

Retrieve Agent Network settings

Returns the per-account Agent Network gateway settings (endpoint, proxy address, collection toggles). Before the account is bootstrapped via POST, the response carries the default values with an empty endpoint and proxy address.

4 status codes
200Agent Network settings for the account
access_log_retention_daysintegeroptional
Days to retain full access-log rows; older rows are swept. 0 or less means keep indefinitely. Usage records are retained independently.
created_atstringoptional
Timestamp when the settings row was created. Absent until the account is bootstrapped.
dedicatedbooleanrequired
Whether the account's gateway is served by a proxy dedicated to it (endpoint equals proxy_address).
enable_log_collectionbooleanrequired
Whether per-request access-log entries are collected for this account's agent-network traffic.
enable_prompt_collectionbooleanrequired
Master switch for request/response prompt capture. Capture runs only when this is on AND a policy guardrail also enables it.
endpointstringrequired
Bare hostname agents call for this account. Empty until the account is bootstrapped.
proxy_addressstringrequired
Declared cluster address of the proxy serving this account's gateway. Equal to `endpoint` when a dedicated proxy serves the account; otherwise the endpoint's immediate parent (a shared cluster the endpoint hangs one label beneath). Empty until the account is bootstrapped.
redact_piibooleanrequired
Whether captured prompts have PII redacted. Effective redaction is the OR of this and any policy guardrail's redact setting.
updated_atstringoptional
Timestamp when the settings row was last updated. Absent until the account is bootstrapped.
401Requires authentication
403Forbidden
500Internal Server Error

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error.