xlnszia Docs App

API Reference

Base URL: https://api.xlnszia.com/api/v1. The API is versioned — all endpoints below are prefixed with /api/v1. The application at https://app.xlnszia.com calls it directly (cross-origin, CORS-enabled), and WebSockets connect to wss://api.xlnszia.com/api/v1/ws. The unversioned https://api.xlnszia.com/api/health endpoint is kept for health checks.

Authenticate with the Authorization: Bearer <token> header (JWT from login or a personal access token).

Health

MethodPathDescription
GET/api/healthHealth check (unversioned)

Authentication

MethodPathDescription
GET/api/v1/auth/optionsLogin options + SSO configured flag
POST/api/v1/auth/loginLogin with email + password (OAuth2 form), returns JWT
GET/api/v1/auth/meCurrent user + permissions
POST/api/v1/auth/change-passwordChange own password
GET/api/v1/auth/sso/loginRedirect to the IdP (SAML AuthnRequest)
POST/api/v1/auth/sso/acsSAML ACS: consume response, SSO login
GET/PUT/api/v1/sso/settingsSSO settings + login options
CRUD/api/v1/sso/mappingsSAML role mappings

Dashboard & tests

MethodPathDescription
GET/api/v1/dashboard/statsDashboard statistics
CRUD/api/v1/testsTest CRUD (SSL / DNS)
GET/api/v1/tests/{id}/checksCheck history
POST/api/v1/tests/{id}/checkTrigger a manual check

Alerts & events

MethodPathDescription
CRUD/api/v1/alerts/rulesConfigured alert rules
GET/PUT/api/v1/alertsFired alerts: list / acknowledge / resolve
GET/api/v1/alerts/countOpen / unread alert counts (navbar badge)
GET/api/v1/eventsEvent stream (filters: type, severity, alert_triggered, test)
GET/api/v1/auditAudit trail (filters: action, user)

Administration

MethodPathDescription
CRUD/api/v1/usersUser CRUD
CRUD/api/v1/teamsTeam CRUD
CRUD/api/v1/environmentsEnvironment CRUD
GET/api/v1/roles/permissionsPermission catalog
CRUD/api/v1/rolesRole CRUD
CRUD/api/v1/tokensPersonal access tokens

Governance, integrations & secrets

MethodPathDescription
GET/api/v1/governance/usagePlan + current usage
GET/api/v1/governance/plansAvailable plans
PUT/api/v1/governance/planChange the workspace plan
CRUD/api/v1/integrationsIntegrations
GET/api/v1/integrations/typesIntegration type catalog
CRUD/api/v1/secretsKey Vault secrets

WebSocket

EndpointDescription
wss://api.xlnszia.com/api/v1/ws?token=<jwt>Real-time event stream (heartbeat, subscribe / unsubscribe)

Messages are JSON; the server filters events by the authenticated user's role and team.