Skip to content

plugin admin api

github-actions[bot] edited this page Apr 26, 2026 · 2 revisions

Admin API Plugin

System metrics, service health, session management, and audit log API for your ɳSelf instance. Pro plugin.

Requires: Basic license tier or higher. nself license set nself_pro_...

Install

nself license set nself_pro_xxxxx...
nself plugin install admin-api

What It Does

Provides admin-only REST endpoints for monitoring and managing a running ɳSelf instance. Exposes service health checks, real-time system metrics, active session enumeration and revocation, and a queryable audit log. All endpoints require the ADMIN_API_SECRET header and are restricted at the Nginx layer.

Configuration

Env Var Default Description
ADMIN_API_PORT 3212 Admin API service port
ADMIN_API_SECRET Required bearer secret for all admin endpoints
ADMIN_SESSION_RETENTION 90 Number of days to retain session records

Ports

Port Purpose
3212 Admin API REST endpoints

Database Tables

2 tables added to your Postgres database:

  • np_admin_api_sessions, tracked admin session records
  • np_admin_api_audit_log, admin action audit trail

Nginx Routes

Route Target Notes
/admin-api/ Admin API Restricted , authentication required

Home


Getting Started


Commands


Features


Configuration


Plugins (87 + 10 monitoring)

Free (25)
Pro (62)
Planned (26)
  • plugin-audit
  • plugin-blog
  • plugin-checkout
  • plugin-commerce
  • plugin-drm
  • plugin-export
  • plugin-flow
  • plugin-import
  • plugin-ldap
  • plugin-mailgun
  • plugin-media
  • plugin-oauth-providers
  • plugin-pages
  • plugin-postmark
  • plugin-rate-limit
  • plugin-reports
  • plugin-saml
  • plugin-scheduler
  • plugin-sendgrid
  • plugin-sso
  • plugin-subscription
  • plugin-thumb
  • plugin-transcoder
  • plugin-twilio
  • plugin-waf
  • plugin-watermark

Guides


Architecture


Reference


Licensing


Security


Brand


Operations


Contributing


Changelog

Clone this wiki locally