NetBird Full API Reference + Read-Only MCP Prototype
PUT/api/posture-checks/{postureCheckId}

Replace a posture check

Replaces a posture check configuration identified by its unique identifier. Supply the required name and description, along with any check configurations to include in the replacement.

1 parameter · 3 body fields
postureCheckIdstringrequired
The unique identifier of the posture check to replace.

Replacement posture check configuration with a name, description, and optional check configurations.

checksobjectoptional
List of objects that perform the actual checks
descriptionstringrequired
Posture check friendly description
namestringrequired
Posture check name identifier

5 status codes
200Returns the updated posture check object, including its `id`, `name`, `description`, and configured `checks`.
checksobjectrequired
List of objects that perform the actual checks
descriptionstringoptional
Posture check friendly description
idstringrequired
Posture check ID
namestringrequired
Posture check unique name identifier
400Returned when the request is invalid.
401Returned when the request does not include valid authentication.
403Returned when the authenticated user is not permitted to update the posture check.
500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the request does not include valid authentication, a 403 when the authenticated user is not permitted to update the check, and a 500 when an internal server error occurs. name and description are required; included certificate_check, geo_location_check, peer_network_range_check, and process_check configurations must provide their specified required fields.