API Reference

Complete REST API documentation for integrating with SysManage server and managing infrastructure programmatically.

Overview

SysManage provides a comprehensive REST API built with FastAPI, offering full programmatic access to all platform features. The API supports modern standards including OpenAPI 3.0 specification, JWT authentication, and real-time WebSocket communication.

API Features

RESTful Design - Standard HTTP methods with JSON request/response
OpenAPI 3.0 - Auto-generated documentation and schema validation
JWT Authentication - Secure token-based authentication with refresh tokens
WebSocket Support - Real-time bidirectional communication for live updates
Rate Limiting - Built-in protection against abuse and overload
CORS Support - Cross-origin resource sharing for web applications

Base URL

https://your-server.example.com/api/v1

Content Type

Content-Type: application/json

🔐 Authentication

JWT-based authentication system with support for user login, token refresh, and session management.

User login and token generation
Token refresh and validation
Session management and logout
Permission-based access control

Authentication API →

🖥️ Host Management

Complete host and agent management including registration, approval, and system information.

Host registration and approval
System information and status
Agent communication and control
Host tagging and organization

Host Management API →

📦 Package Management

Cross-platform package management for installing, updating, and removing software packages.

Package inventory and status
Install, update, and remove operations
Bulk package operations
Package search and information

Package Management API →

🔌 WebSocket API

Real-time bidirectional communication for live updates, command execution, and status monitoring.

WebSocket connection and authentication
Real-time status updates
Command execution and results
Event streaming and notifications

WebSocket API →

📊 Monitoring

System monitoring, metrics collection, and alerting through programmatic interfaces.

System metrics and performance data
Health checks and status monitoring
Alert configuration and management
Historical data and reporting

Monitoring API →

📋 Reports

Generate and access system reports, inventories, and analytics data.

Host inventory reports
Package status reports
User and security reports
PDF generation and export

Reports API →

👥 User Management

User account management, permissions, and role-based access control.

User creation and management
Role and permission assignment
User profile and preferences
Administrative functions

User Management API →

⚙️ Configuration

System configuration management and settings through API endpoints.

System settings and preferences
Configuration validation
Feature toggles and options
Environment-specific settings

Configuration API →

Quick Start

Get started with the SysManage API in just a few steps:

1. Authentication

curl -X POST "https://your-server.example.com/api/v1/auth/login" \
     -H "Content-Type: application/json" \
     -d '{"username": "admin", "password": "your-password"}'

2. Get Host List

curl -X GET "https://your-server.example.com/api/v1/hosts" \
     -H "Authorization: Bearer YOUR_JWT_TOKEN"

3. Install Package

curl -X POST "https://your-server.example.com/api/v1/packages/install" \
     -H "Authorization: Bearer YOUR_JWT_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"host_id": "host-uuid", "package": "nginx"}'