Authentication & System Health APIs Overview
N-central's Authentication and System Health APIs provide secure access management and system monitoring capabilities. These APIs enable secure token-based authentication and provide visibility into the health and version information of your N-central deployment.
API Methods
Authentication
Provides JWT (JSON Web Token) based authentication flow with access and refresh token management.
Key Methods
| Endpoint | Method | Description |
|---|---|---|
/api/auth | GET | Returns links to available authentication endpoints (authenticate, refresh, validate). |
/api/auth/authenticate | POST | Obtains initial access and refresh tokens using N-central User-API Token (JWT). |
/api/auth/refresh | POST | Obtains new access token using a valid refresh token. |
/api/auth/validate | GET | Verifies if the current access token is valid. |
Authentication Flow
- Generate N-central User-API Token from N-central UI
- Exchange User-API Token for access/refresh tokens via authenticate endpoint
- Use access token for API requests
- Use the refresh endpoint to obtain new tokens before the expiry
- Validate tokens as needed
System Health
Provides system status, version information, and health metrics for the N-central deployment.
Key Methods
| Endpoint | Method | Description |
|---|---|---|
/api | GET | Returns links to all available API endpoints. |
/api/health | GET | Returns server's current time and status for basic availability monitoring. |
/api/server-info | GET | Returns API service version and JVM version for version compatibility checking. |
/api/server-info/extra | GET | Returns information about versions of different systems in N-central. |
/api/server-info/extra/authenticated | POST | Returns detailed version information about N-central systems. Requires valid access token. |
Key Features
Secure Token Management
Complete JWT-based authentication flow with automatic token refresh capabilities and configurable token expiry.
Granular Access Control
Fine-grained API access control through token validation and custom token expiry settings.
Comprehensive Health Monitoring
Multiple endpoints for monitoring system health from basic availability checks to detailed component-level diagnostics.
Updated 6 days ago