NetBird Full API Reference + Read-Only MCP Prototype
POST/api/posture-checks

Create a posture check

Creates a posture check configuration. Supply name and description, and include any check configurations you want to apply; individual check types have their own required fields.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

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

1 status code
200Returns the created posture check object, including its generated `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

Error handling

name and description are required. If you provide certificate_check, it must include ca_certificates; geo_location_check and peer_network_range_check each require their respective values and an action, while process_check requires processes.