List posture checks | NetBird Full API Reference + Read-Only MCP Prototype

5 status codes

200Returns an array of posture check objects, each with an `id`, `name`, 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 posture checks.

500Returned when an internal server error occurs.

Error handling

A 400 is returned for an invalid request. A 401 is returned when the request lacks valid authentication, a 403 when the authenticated user lacks permission, and a 500 when an internal server error occurs.

import { NetBirdManagementAPIUnofficialOctriFullPreview } from "netbird-management-api-|-unofficial-octri-full-preview";

const client = new NetBirdManagementAPIUnofficialOctriFullPreview({
  baseUrl: "https://api.netbird.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.postureChecks.list();

[
  {
    "checks": {
      "certificate_check": {
        "ca_certificates": [
          "-----BEGIN CERTIFICATE-----\nMIIB...\n-----END CERTIFICATE-----"
        ]
      },
      "geo_location_check": {
        "action": "allow",
        "locations": [
          {
            "city_name": "Berlin",
            "country_code": "DE"
          }
        ]
      },
      "nb_version_check": {
        "min_version": "14.3"
      },
      "os_version_check": {
        "android": {
          "min_version": "13"
        },
        "darwin": {
          "min_version": "14.2.1"
        },
        "ios": {
          "min_version": "17.3.1"
        },
        "linux": {
          "min_kernel_version": "5.3.3"
        },
        "windows": {
          "min_kernel_version": "10.0.1234"
        }
      },
      "peer_network_range_check": {
        "action": "allow",
        "ranges": [
          "192.168.1.0/24",
          "10.0.0.0/8",
          "1.0.0.0/24",
          "2.2.2.2/32",
          "2001:db8:1234:1a00::/56"
        ]
      },
      "process_check": {
        "processes": [
          {
            "linux_path": "/usr/local/bin/netbird",
            "mac_path": "/Applications/NetBird.app/Contents/MacOS/netbird",
            "windows_path": "C: rogramDataetBird\netbird.exe"
          }
        ]
      }
    },
    "description": "This checks if the peer is running required NetBird's version",
    "id": "ch8i4ug6lnn4g9hqv7mg",
    "name": "Default"
  }
]

Response

Errors