Get Instance Status | NetBird Full API Reference + Read-Only MCP Prototype

2 status codes

200Instance status information

setup_requiredbooleanrequired

Indicates whether the instance requires initial setup

500Internal Server Error

Error handling

A 500 is returned: Internal Server Error.

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.instance.list();

{
  "setup_required": true
}

Response

Errors