Get a policy | NetBird Full API Reference + Read-Only MCP Prototype

1 parameter

policyIdstringrequired

The unique identifier of the policy to retrieve.

5 status codes

200Returns the policy object, including its name, enabled state, rules, and source posture checks.

descriptionstringoptional

Policy friendly description

enabledbooleanrequired

Policy status

namestringrequired

Policy name identifier

idstringoptional

Policy ID

rulesarray<object>required

Policy rule object for policy UI editor

source_posture_checksarray<string>required

Posture checks ID's applied to policy source groups

400Returned when the request is invalid.

401Returned when authentication is missing or invalid.

403Returned when the authenticated user is not permitted to retrieve the policy.

500Returned when an internal server error occurs.

Error handling

A 400 is returned when the request is invalid; a 401 is returned when authentication is missing or invalid; a 403 is returned when the authenticated user is not permitted to retrieve the policy; and a 500 is returned when an internal server error occurs. The policyId path parameter must identify the policy to retrieve.

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.policies.get({ policyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "description": "This is a default policy that allows connections between all the resources",
  "enabled": true,
  "name": "ch8i4ug6lnn4g9hqv7mg",
  "id": "ch8i4ug6lnn4g9hqv7mg",
  "rules": [
    {
      "action": "accept",
      "bidirectional": true,
      "description": "This is a default rule that allows connections between all the resources",
      "enabled": true,
      "name": "Default",
      "port_ranges": [
        {
          "end": null,
          "start": null
        }
      ],
      "ports": [
        "80"
      ],
      "protocol": "tcp",
      "destinationResource": {
        "id": null,
        "type": null
      },
      "destinations": [
        {
          "id": null,
          "issued": null,
          "name": null,
          "peers_count": null,
          "resources_count": null
        }
      ],
      "id": "ch8i4ug6lnn4g9hqv7mg",
      "sourceResource": {
        "id": null,
        "type": null
      },
      "sources": [
        {
          "id": null,
          "issued": null,
          "name": null,
          "peers_count": null,
          "resources_count": null
        }
      ]
    }
  ],
  "source_posture_checks": [
    "chacdk86lnnboviihd70"
  ]
}

Request

Response

Errors