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

5 body fields

Policy configuration containing its name, enabled state, and rules.

descriptionstringoptional

Policy friendly description

enabledbooleanrequired

Policy status

namestringrequired

Policy name identifier

rulesarray<object>required

Policy rule object for policy UI editor

source_posture_checksarray<string>optional

Posture checks ID's applied to policy source groups

1 status code

200Returns the created 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

Error handling

name, enabled, and rules are required. Each value must match the corresponding field's expected type: a string for name, a boolean for enabled, and an array for rules.

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.create({
  name: "ch8i4ug6lnn4g9hqv7mg",
  enabled: true,
  rules: [],
});

{
  "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