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

Retrieve a posture check

Retrieves a posture check by its unique identifier. Use this endpoint to inspect the check's name, description, and configured checks.

1 parameter
postureCheckIdstringrequired
The unique identifier of the posture check to retrieve.

5 status codes
200Returns a posture check object with 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 access 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 access the check, and a 500 when an internal server error occurs. The postureCheckId path parameter identifies the posture check to retrieve.