NetBird Full API Reference + Read-Only MCP Prototype
PUT/api/accounts/{accountId}

Replace account configuration

Replaces account configuration values for a specific account. Use settings to provide account settings and optionally include onboarding to set onboarding state; read-only settings cannot be changed. The updated account response includes its identifier, settings, domain, and onboarding information.

1 parameter · 2 body fields
accountIdstringrequired
The unique identifier of the account whose configuration you want to replace.

Optional account update payload. If you provide a body, it must include settings.

onboardingobjectoptional
Onboarding state, including whether the signup form and onboarding flow are pending.
settingsobjectrequired
Account settings, including update behavior, DNS, dashboard features, authentication, group propagation, and peer configuration. The settings object requires `peer_login_expiration_enabled`, `peer_login_expiration`, `peer_inactivity_expiration_enabled`, `peer_inactivity_expiration`, `regular_users_view_blocked`, `peer_expose_enabled`, and `peer_expose_groups`; read-only settings cannot be changed.

5 status codes
200Returns the updated account object, including its identifier, settings, domain, domain category, creation details, and onboarding state.
created_atstringrequired
Account creation date (UTC)
created_bystringrequired
Account creator
domainstringrequired
Account domain
domain_categorystringrequired
Account domain category
idstringrequired
Account ID
onboardingobjectrequired
settingsobjectrequired
400Returned when the request is invalid.
401Returned when the request does not include valid authentication.
403Returned when access to update the account is forbidden.
500Returned when the server encounters an internal error.

Error handling

A 400 is returned when the request is invalid, a 401 when authentication is missing or invalid, a 403 when access is denied, and a 500 when the server encounters an internal error. The accountId path parameter must identify the account to update. If you provide a request body, it must include settings; its peer_login_expiration_enabled, peer_login_expiration, peer_inactivity_expiration_enabled, peer_inactivity_expiration, regular_users_view_blocked, peer_expose_enabled, and peer_expose_groups fields are required, and read-only settings cannot be changed.