Divarion-D
040143215a
Full bilingual documentation for XC_VM has been added with Docsify SPA and the outdated database migration has been replaced. ## Docsify - docs/index.html — SPA entry point: en-us/ru-ru routing, search, syntax highlighting (bash, PHP, SQL, nginx, JSON) ## EN Documentation - docs/en/info/faq.md — FAQ (12 questions: streams, access, database, SSL, updates, permissions) - docs/en/info/migration_guide.md — migration guide from other systems - docs/en/info/update.md — step-by-step update via the web panel - docs/en/info/watch_folder.md — Watch Folder: workflow, PTN/guessit parsers, configuration - docs/en/updates_checklist.md — release preparation checklist ## RU Documentation (fully localized) - docs/ru/README.md — Main Page - docs/ru/_sidebar.md — Sidebar Navigation - docs/ru/administration/ssl-generation.md — Self-Signed SSL Generation - docs/ru/administration/update-system.md — Update Mechanism (PHP → Python → Post-Update) - docs/ru/api/playlist.md — Playlist API with Error Codes - docs/ru/api/system_api.md — System API (13 endpoints) - docs/ru/api/xtreamcodes_api.md — XtreamCodes API (Authorization, Live, VOD, TV Series, EPG) - docs/ru/builds/build_binaries.md — nginx build, nginx_rtmp, PHP-FPM, network - docs/ru/builds/build_ffmpeg.md — Building FFmpeg 8.0 with NVENC/CUDA - docs/ru/builds/build_system.md — MAIN vs. LB build system - docs/ru/development/cli-tools.md — CLI: 26 commands, 25 crons, 8 daemons, database migrations - docs/ru/info/faq.md — FAQ (12 questions) - docs/ru/info/migration_guide.md — Migration guide - docs/ru/info/update.md — Updating via the control panel - docs/ru/info/watch_folder.md — Watch Folder - docs/ru/updates_checklist.md — Release checklist ## Migrations - Removed: 001_drop_watch_folders_plex_token.sql (Deprecated) - Added: 001_update_crontab_filenames.sql — removes the .php suffix from filenames in the crontab table (switches to console.php commands)
5.2 KiB
📡 System API (Method Verification Required)
This API provides various system functionalities, including log viewing, video-on-demand (VOD) and stream management, statistics retrieval, background command execution, and more.
File Location
The System API is handled by the controller:
src/public/Controllers/Api/AdminApiController.php
HTTP entry-point: /api.php → routed by nginx to public/index.php with XC_API=internal.
API Architecture Overview
Base URI: http://<host>:<http port>/api.php
Authentication: password parameter matching the live_streaming_pass configuration
Example:
http://<host>:<http port>/api.php?password=<live_streaming_pass>&action=<api endpoint>
Main API Endpoints
1. VOD Management
GET /api.php?action=vod
Description: Starts or stops Video-on-Demand (VOD) streams. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| stream_ids | array of integers | yes | List of stream IDs. |
| function | string | yes | Action to perform (start or stop). |
2. Live Stream Management
GET /api.php?action=stream
Description: Starts or stops live streams. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| stream_ids | array of integers | yes | List of stream IDs. |
| function | string | yes | Action to perform (start or stop). |
3. System Telemetry
GET /api.php?action=stats
Description: Retrieves system statistics. Response:
{
"cpu": 8.32,
"cpu_cores": 56,
"cpu_avg": 8.86,
"cpu_name": "Intel(R) Xeon(R) CPU E5-2680 v4 @ 2.40GHz",
...
}
4. Process Lifecycle Check
GET /api.php?action=pidsAreRunning
Description: Checks whether specified process IDs (PIDs) are currently running. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| pids | array of integers | yes | List of PIDs to verify. |
| program | string | yes | Program name. |
5. Get File
GET /api.php?action=getFile
Description: Downloads the specified file. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| filename | string | yes | Path to the file. |
Response:
- File contents.
6. Directory Listing
GET /api.php?action=viewDir
Description: Retrieves a directory listing. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| dir | string | yes | Path to the directory. |
Response:
<ul class="jqueryFileTree" style="display: none;">
<li class="directory collapsed"><a href="#" rel="/path/to/directory/">directory_name</a></li>
<li class="file ext_txt"><a href="#" rel="/path/to/file.txt">file.txt</a></li>
</ul>
7. Connection Redirection
GET /api.php?action=redirect_connection
Description: Redirects a connection based on the activity ID and stream ID. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| activity_id | integer | yes | Activity ID. |
| stream_id | integer | yes | Stream ID. |
8. Send Signal
GET /api.php?action=signal_send
Description: Sends a signal message to trigger an action. Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| message | string | yes | Message or command. |
| activity_id | integer | yes | Activity ID. |
9. Clear Temporary Folder
GET /api.php?action=free_temp
Description: Deletes temporary files and executes a caching script.
10. Clear Streams Folder
GET /api.php?action=free_streams
Description: Clears the streams directory.
11. Get Free Disk Space
GET /api.php?action=get_free_space
Description: Returns information about available disk space.
12. Get Process PIDs
GET /api.php?action=get_pids
Description: Returns a list of running process IDs.
13. Kill Process by PID
GET /api.php?action=kill_pid
Description: Terminates a process by its PID.
Error Codes
| Code | Description |
|---|---|
| INVALID_API_PASSWORD | Invalid API password. |
| API_IP_NOT_ALLOWED | IP address not allowed. |
| INVALID_REQUEST | Invalid request parameters. |
Notes
- All requests must be authenticated using the correct API password.
- Some actions may require additional permissions or may be restricted depending on the server configuration.