Repository navigation
Two Way PSA and REST API
Tyler Hatfield edited this page Nov 12, 2026
·
4 revisions
Vitrine RMM provides bidirectional ticketing synchronization with ITFlow, authenticated webhook ingestion, and a comprehensive session-authenticated REST & WebSocket API.
-
Ticket Lifecycle (
GET,POST,PUT /api/psa/tickets): Create service tickets directly from Vitrine, automatically open incident tickets from Policy Condition Alert Rules (createTicket: true) or tripped Self-Healing Watchdogs, and synchronize status changes bidirectionally with ITFlow (POST /api/psa/sync). -
Authenticated Webhook Ingestion (
POST /api/psa/webhook): VerifiesX-Vitrine-Webhook-Secret/ HMAC-SHA256 signature (psa_webhook_secret, stored encrypted in the AES-256-GCM vault) using constant-time comparison before applying inbound ticket updates.
All /api/* endpoints (except /api/health, /api/public/portal-config, /api/auth/status, /api/auth/setup-initial-admin, /api/auth/login, token-gated /api/agent/*, and /api/guest-portal/*) require an authenticated vitrine_session cookie or Authorization: Bearer <token> header.
-
Authentication, RBAC & Step-Up MFA:
-
GET /api/auth/status— Check bootstrap status and active user session. -
POST /api/auth/setup-initial-admin— One-time initialsuper_adminbootstrap (locks with409once initialized). -
POST /api/auth/login&POST /api/auth/logout— Scrypt password login & session revocation. -
POST /api/auth/verify-mfa— Step-Up RFC 6238 TOTP / single-use recovery code verification (anti-replay enforced). -
GET /api/users,POST /api/users,PUT /api/users/:id,DELETE /api/users/:id— Multi-tenant RBAC user management (super_adminonly).
-
-
Fleet, Vault Secrets & LAPS:
-
GET /api/devices&GET /api/devices/:id— Tenant-scoped endpoint inventory (bitlocker_keystripped;has_bitlocker_keyboolean returned). -
GET /api/devices/:id/bitlocker— Step-Up MFA-gated BitLocker/LUKS/FileVault recovery key reveal. -
GET /api/devices/:id/laps?reveal=true&POST /api/devices/:id/laps/rotate— MFA-gated LAPS password reveal & offline-safe rotation. -
POST /api/laps/break-glass-export— Super-Admin + Step-Up MFA emergency LAPS vault export.
-
-
Offboarding & Data Archive Vault:
-
POST /api/devices/:id/offboard&POST /api/devices/:id/force-archive— Clean online offboard or offline pending queue / immediate Archive Vault transition. -
POST /api/tenants/:id/offboard&POST /api/tenants/:id/reactivate— Archive entire client in last-known state or permanently delete with Tombstone registration. -
DELETE /api/devices/:id/archive-purge— Permanent Super-Admin purge of an archived endpoint.
-
-
Policies, Condition Alerts & Specialty Endpoints:
-
GET /api/policies,POST /api/policies,PUT /api/policies/:id,GET /api/policies/effective/:deviceId— 4-tier cascading policy & alert matrix CRUD. -
GET /api/alerts/events&POST /api/alerts/evaluate— Condition notification ledger & on-demand evaluation. -
GET /api/discovery/vendor-profiles,GET /api/discovery/appliances,POST /api/discovery/appliances,POST /api/discovery/appliances/:id/poll— Vendor-native specialty device monitoring.
-
-
Encrypted Backups & Self-Updater (
super_admin):-
GET /api/backups,POST /api/backups,GET /api/backups/:id/download,POST /api/backups/:id/restore,POST /api/backups/upload-restore—VRMMENC1encrypted backups & live atomic restore. -
GET /api/updater/status,POST /api/updater/check,POST /api/updater/apply—stable/alpharelease channel self-updater.
-
-
Authenticated WebSockets:
-
/ws/telemetry— Authenticated real-time fleet CPU, RAM, and Network Mbps stream. -
/ws/terminal— Authenticated (technician/super_admin+ tenant-verified) background shell bridge.
-
GET /api/reports/qbr computes live composite Fleet Health Index scores across endpoint availability, patch compliance, disk encryption coverage, EDR status, and self-healing hours saved — ready for one-click Executive PDF/Print export.