List all Reverse Proxy Access Logs | NetBird Read-Only MCP Preview

16 parameters

pageintegeroptional

Page number for pagination (1-indexed)

Default:1

page_sizeintegeroptional

Number of items per page (max 100)

Default:50

sort_bystringoptional

Field to sort by (url sorts by host then path)

Allowed:timestampurlhostpathmethodstatus_codedurationsource_ipuser_idauth_methodreasonDefault:timestamp

sort_orderstringoptional

Sort order (ascending or descending)

Allowed:ascdescDefault:desc

searchstringoptional

General search across request ID, host, path, and source IP

source_ipstringoptional

Filter by source IP address

hoststringoptional

Filter by host header

pathstringoptional

Filter by request path (supports partial matching)

user_idstringoptional

Filter by authenticated user ID

user_emailstringoptional

Filter by user email (partial matching)

user_namestringoptional

Filter by user name (partial matching)

methodstringoptional

Filter by HTTP method

Allowed:GETPOSTPUTPATCHDELETEHEADOPTIONS

statusstringoptional

Filter by status (success = 2xx/3xx, failed = 1xx/4xx/5xx)

Allowed:successfailed

status_codeintegeroptional

Filter by HTTP status code

start_datestringoptional

Filter by timestamp >= start_date (RFC3339 format)

end_datestringoptional

Filter by timestamp <= end_date (RFC3339 format)

4 status codes

200Paginated list of reverse proxy access logs

dataarray<object>required

List of proxy access log entries

pageintegerrequired

Current page number

page_sizeintegerrequired

Number of items per page

total_pagesintegerrequired

Total number of pages available

total_recordsintegerrequired

Total number of log records available

401Requires authentication

403Forbidden

500Internal Server Error

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error.

import { NetBirdManagementAPIUnofficialOctriFullPreview } from "netbird-read-only-mcp-preview-sdk";

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

const result = await client.events.listProxy();

{
  "data": [
    {
      "auth_method_used": "oidc",
      "bytes_download": 8192,
      "bytes_upload": 1024,
      "city_name": "San Francisco",
      "country_code": "US",
      "duration_ms": 150,
      "host": "example.com",
      "id": "ch8i4ug6lnn4g9hqv7m0",
      "method": "GET",
      "path": "/api/users",
      "protocol": "http",
      "reason": "Authentication failed",
      "service_id": "ch8i4ug6lnn4g9hqv7m0",
      "source_ip": "192.168.1.100",
      "status_code": 200,
      "subdivision_code": "CA",
      "timestamp": "2024-01-31T15:30:00Z",
      "user_id": "user-123"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total_pages": 11,
  "total_records": 523
}

Request

Response

Errors