API Reference

NeXusOS exposes an open REST API (v2). This page describes authentication, basic endpoints, and examples.

Authentication

The API uses Bearer tokens. Create a token in the admin panel under Users → API Tokens and send it in the header with every request:

Authorization: Bearer YOUR_TOKEN_HERE

Base URL

All endpoints live under:

https://your-installation.example.com/api/v2

Key endpoints

Method	Path	Description
GET	/users	List all users
POST	/users	Create a new user
GET	/users/{id}	Fetch a single user
PATCH	/users/{id}	Update a user
DELETE	/users/{id}	Delete a user
GET	/audit-logs	Fetch audit logs

Example request

curl -X GET https://your-installation.example.com/api/v2/users \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Accept: application/json"

Rate limiting

The API is limited to 100 requests per minute per token. If exceeded, you receive a 429 Too Many Requests status.