Get the customer portal URL | NetBird Full API Reference + Read-Only MCP Prototype

1 parameter

baseURLstringrequired

The base URL for the redirect after accessing the customer portal.

4 status codes

200Returns the customer portal session identifier and the URL to redirect the user to the portal.

session_idstringrequired

The unique identifier for the customer portal session.

urlstringrequired

URL to redirect the user to the customer portal.

400Returned when the request is invalid.

401Returned when the request lacks valid authentication.

500Returned when an internal server error occurs.

Error handling

A 400 is returned when baseURL is missing or the request is invalid. A 401 is returned when the request lacks valid authentication; a 500 indicates an 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.portal.list({ baseUrl: "https://api.example.com/v1" });

{
  "session_id": "cps_test_123456789",
  "url": "https://billing.stripe.com/session/a1b2c3d4e5f6g7h8i9j0k"
}

Request

Response

Errors