PHAROS DATA ARK · 2026-10-29-01024f5b59
Data Ark API reference
The HTTP contract shipped with this software edition. Download OpenAPI JSON · Handbook contents
Interactive reference on your Ark. Protected operations use the caretaker or integration authorization described in the administrator guides.
GET /api/
Root
Parameters, request and responses
{
"operationId": "root__get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Root"
}GET /api/about
About
Parameters, request and responses
{
"operationId": "about_about_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "About",
"tags": [
"About"
]
}POST /api/bugout/cancel
Cancel
Parameters, request and responses
{
"operationId": "cancel_bugout_cancel_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Cancel",
"tags": [
"Bugout"
]
}POST /api/bugout/credentials/{task_id}
Credentials
Parameters, request and responses
{
"operationId": "credentials_bugout_credentials__task_id__post",
"parameters": [
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Credentials",
"tags": [
"Bugout"
]
}POST /api/bugout/credentials/{task_id}/test
Test Credentials
Parameters, request and responses
{
"operationId": "test_credentials_bugout_credentials__task_id__test_post",
"parameters": [
{
"in": "path",
"name": "task_id",
"required": true,
"schema": {
"title": "Task Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Test Credentials",
"tags": [
"Bugout"
]
}GET /api/bugout/state
State
Parameters, request and responses
{
"operationId": "state_bugout_state_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "State",
"tags": [
"Bugout"
]
}POST /api/bugout/sync
Sync
Parameters, request and responses
{
"operationId": "sync_bugout_sync_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Sync",
"tags": [
"Bugout"
]
}POST /api/bugout/trigger
Trigger
Parameters, request and responses
{
"operationId": "trigger_bugout_trigger_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Trigger",
"tags": [
"Bugout"
]
}GET /api/callsigns/metadata
Metadata
Parameters, request and responses
{
"operationId": "metadata_callsigns_metadata_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Metadata",
"tags": [
"Callsigns"
]
}GET /api/callsigns/search
Search
Parameters, request and responses
{
"operationId": "search_callsigns_search_get",
"parameters": [
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"default": "",
"maxLength": 80,
"title": "Q",
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"schema": {
"default": "callsign",
"pattern": "^(callsign|name)$",
"title": "Mode",
"type": "string"
}
},
{
"in": "query",
"name": "state",
"required": false,
"schema": {
"default": "",
"maxLength": 2,
"title": "State",
"type": "string"
}
},
{
"in": "query",
"name": "city",
"required": false,
"schema": {
"default": "",
"maxLength": 60,
"title": "City",
"type": "string"
}
},
{
"in": "query",
"name": "grid",
"required": false,
"schema": {
"default": "",
"maxLength": 8,
"title": "Grid",
"type": "string"
}
},
{
"in": "query",
"name": "radius_km",
"required": false,
"schema": {
"default": 50,
"maximum": 1000,
"minimum": 1,
"title": "Radius Km",
"type": "number"
}
},
{
"in": "query",
"name": "active",
"required": false,
"schema": {
"default": true,
"title": "Active",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Search",
"tags": [
"Callsigns"
]
}GET /api/clone/drives
Drives
Parameters, request and responses
{
"operationId": "drives_clone_drives_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Drives",
"tags": [
"Drive cloning"
]
}GET /api/clone/plan
Plan
Parameters, request and responses
{
"operationId": "plan_clone_plan_get",
"parameters": [
{
"in": "query",
"name": "drive",
"required": true,
"schema": {
"title": "Drive",
"type": "string"
}
},
{
"in": "query",
"name": "mode",
"required": false,
"schema": {
"default": "config",
"pattern": "^(config|fit|populated)$",
"title": "Mode",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Plan",
"tags": [
"Drive cloning"
]
}GET /api/clone/status
Status
Parameters, request and responses
{
"operationId": "status_clone_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"Drive cloning"
]
}POST /api/community/backup
Backup
Parameters, request and responses
{
"operationId": "backup_community_backup_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Backup",
"tags": [
"Community board"
]
}POST /api/community/messages/{identifier}/edit
Edit
Parameters, request and responses
{
"operationId": "edit_community_messages__identifier__edit_post",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Edit",
"tags": [
"Community board"
]
}POST /api/community/messages/{identifier}/remove
Remove
Parameters, request and responses
{
"operationId": "remove_community_messages__identifier__remove_post",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Remove",
"tags": [
"Community board"
]
}POST /api/community/messages/{identifier}/replies
Nested Reply
Parameters, request and responses
{
"operationId": "nested_reply_community_messages__identifier__replies_post",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "integer"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Nested Reply",
"tags": [
"Community board"
]
}GET /api/community/notice
Notice
Parameters, request and responses
{
"operationId": "notice_community_notice_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Notice",
"tags": [
"Community board"
]
}POST /api/community/notice
Set Notice
Parameters, request and responses
{
"operationId": "set_notice_community_notice_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Set Notice",
"tags": [
"Community board"
]
}POST /api/community/restore/apply
Restore Apply
Parameters, request and responses
{
"operationId": "restore_apply_community_restore_apply_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Restore Apply",
"tags": [
"Community board"
]
}POST /api/community/restore/preview
Restore Preview
Parameters, request and responses
{
"operationId": "restore_preview_community_restore_preview_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Restore Preview",
"tags": [
"Community board"
]
}GET /api/community/threads
Listing
Parameters, request and responses
{
"operationId": "listing_community_threads_get",
"parameters": [
{
"in": "query",
"name": "category",
"required": false,
"schema": {
"default": "",
"title": "Category",
"type": "string"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"default": 0,
"title": "Offset",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Listing",
"tags": [
"Community board"
]
}POST /api/community/threads
Create
Parameters, request and responses
{
"operationId": "create_community_threads_post",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Create",
"tags": [
"Community board"
]
}GET /api/community/threads/{identifier}
Thread
Parameters, request and responses
{
"operationId": "thread_community_threads__identifier__get",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Thread",
"tags": [
"Community board"
]
}POST /api/community/threads/{identifier}/replies
Reply
Parameters, request and responses
{
"operationId": "reply_community_threads__identifier__replies_post",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "integer"
}
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Reply",
"tags": [
"Community board"
]
}GET /api/configuration
Read
Parameters, request and responses
{
"operationId": "read_configuration_get",
"parameters": [
{
"in": "query",
"name": "file",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "File"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Read",
"tags": [
"Configuration"
]
}GET /api/configuration/history/{identifier}
History
Parameters, request and responses
{
"operationId": "history_configuration_history__identifier__get",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"title": "Identifier",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "History",
"tags": [
"Configuration"
]
}GET /api/configuration/status
Status
Parameters, request and responses
{
"operationId": "status_configuration_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"Configuration"
]
}POST /api/configuration/{action}
Change
Parameters, request and responses
{
"operationId": "change_configuration__action__post",
"parameters": [
{
"in": "path",
"name": "action",
"required": true,
"schema": {
"title": "Action",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Change",
"tags": [
"Configuration"
]
}GET /api/debug
Get Debug
Parameters, request and responses
{
"operationId": "get_debug_debug_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Get Debug",
"tags": [
"Debug"
]
}POST /api/debug/off
Debug Off
Parameters, request and responses
{
"operationId": "debug_off_debug_off_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Debug Off",
"tags": [
"Debug"
]
}POST /api/debug/on
Debug On
Parameters, request and responses
{
"operationId": "debug_on_debug_on_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Debug On",
"tags": [
"Debug"
]
}GET /api/events
Events
Parameters, request and responses
{
"operationId": "events_events_get",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"maximum": 1000,
"minimum": 1,
"title": "Limit",
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Events",
"tags": [
"Events"
]
}GET /api/health
Health
Parameters, request and responses
{
"operationId": "health_health_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Health",
"tags": [
"Health"
]
}GET /api/https/setup
Details
Parameters, request and responses
{
"operationId": "details_https_setup_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Details",
"tags": [
"HTTPS setup"
]
}POST /api/https/setup
Setup
Parameters, request and responses
{
"operationId": "setup_https_setup_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Setup",
"tags": [
"HTTPS setup"
]
}GET /api/https/status
Status
Parameters, request and responses
{
"operationId": "status_https_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"HTTPS setup"
]
}GET /api/library
Inventory
Parameters, request and responses
{
"operationId": "inventory_library_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Inventory",
"tags": [
"Library"
]
}GET /api/library/catalogue
Catalogue
Parameters, request and responses
{
"operationId": "catalogue_library_catalogue_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Catalogue",
"tags": [
"Library"
]
}GET /api/library/changes
Changes
Parameters, request and responses
{
"operationId": "changes_library_changes_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Changes",
"tags": [
"Library"
]
}POST /api/library/install
Install
Parameters, request and responses
{
"operationId": "install_library_install_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Install",
"tags": [
"Library"
]
}POST /api/library/remove
Remove
Parameters, request and responses
{
"operationId": "remove_library_remove_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Remove",
"tags": [
"Library"
]
}POST /api/library/restore
Restore
Parameters, request and responses
{
"operationId": "restore_library_restore_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Restore",
"tags": [
"Library"
]
}POST /api/library/unlock
Unlock
Parameters, request and responses
{
"operationId": "unlock_library_unlock_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Unlock",
"tags": [
"Library"
]
}GET /api/network
Network
Parameters, request and responses
{
"operationId": "network_network_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Network",
"tags": [
"Network"
]
}GET /api/network/admin/access
Current Access
Parameters, request and responses
{
"operationId": "current_access_network_admin_access_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Current Access",
"tags": [
"Network administration"
]
}POST /api/network/admin/{action}
Network Action
Parameters, request and responses
{
"operationId": "network_action_network_admin__action__post",
"parameters": [
{
"in": "path",
"name": "action",
"required": true,
"schema": {
"title": "Action",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Network Action",
"tags": [
"Network administration"
]
}GET /api/recovery/presets
Presets
Parameters, request and responses
{
"operationId": "presets_recovery_presets_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Presets",
"tags": [
"Recovery"
]
}GET /api/recovery/status
Status
Parameters, request and responses
{
"operationId": "status_recovery_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"Recovery"
]
}GET /api/software-updates
Current Build
Read the published build identity without contacting the internet.
Parameters, request and responses
{
"description": "Read the published build identity without contacting the internet.",
"operationId": "current_build_software_updates_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Current Build",
"tags": [
"Software updates"
]
}POST /api/software-updates/check
Check
Check official software releases; no installation or configuration changes.
Parameters, request and responses
{
"description": "Check official software releases; no installation or configuration changes.",
"operationId": "check_software_updates_check_post",
"parameters": [
{
"in": "query",
"name": "preview",
"required": false,
"schema": {
"default": false,
"title": "Preview",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "Check",
"tags": [
"Software updates"
]
}POST /api/software-updates/install
Install
Parameters, request and responses
{
"operationId": "install_software_updates_install_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Install",
"tags": [
"Software updates"
]
}GET /api/software-updates/installation
Installation Status
Parameters, request and responses
{
"operationId": "installation_status_software_updates_installation_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Installation Status",
"tags": [
"Software updates"
]
}POST /api/software-updates/stage
Stage
Verify an explicitly submitted signed package; does not install it.
Parameters, request and responses
{
"description": "Verify an explicitly submitted signed package; does not install it.",
"operationId": "stage_software_updates_stage_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Stage",
"tags": [
"Software updates"
]
}GET /api/sources/check
Status
Parameters, request and responses
{
"operationId": "status_sources_check_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Status",
"tags": [
"Source availability"
]
}POST /api/sources/check
Start
Parameters, request and responses
{
"operationId": "start_sources_check_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
}
},
"description": "Successful Response"
}
},
"summary": "Start",
"tags": [
"Source availability"
]
}GET /api/status
Current appliance status
Parameters, request and responses
{
"operationId": "status_status_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusResponse"
}
}
},
"description": "Successful Response"
}
},
"summary": "Current appliance status",
"tags": [
"Status"
]
}Data models
AccessPoint
{
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Active"
},
"client_count": {
"title": "Client Count",
"type": "integer"
},
"clients": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Clients",
"type": "array"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"interface": {
"default": "wlan0",
"title": "Interface",
"type": "string"
},
"ip": {
"default": "",
"title": "Ip",
"type": "string"
},
"ssid": {
"title": "Ssid",
"type": "string"
},
"state": {
"default": "unknown",
"title": "State",
"type": "string"
}
},
"required": [
"ssid",
"client_count",
"clients"
],
"title": "AccessPoint",
"type": "object"
}CPU
{
"properties": {
"load": {
"items": {
"type": "number"
},
"title": "Load",
"type": "array"
},
"temperature_c": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Temperature C"
}
},
"required": [
"temperature_c",
"load"
],
"title": "CPU",
"type": "object"
}Disk
{
"properties": {
"free": {
"title": "Free",
"type": "string"
},
"percent": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Percent"
},
"used": {
"title": "Used",
"type": "string"
}
},
"required": [
"used",
"free",
"percent"
],
"title": "Disk",
"type": "object"
}Ethernet
{
"properties": {
"addresses": {
"items": {
"type": "string"
},
"title": "Addresses",
"type": "array"
},
"carrier": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Carrier"
},
"connected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Connected"
},
"default_route": {
"default": false,
"title": "Default Route",
"type": "boolean"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"gateway": {
"title": "Gateway",
"type": "string"
},
"interface": {
"default": "eth0",
"title": "Interface",
"type": "string"
},
"ip": {
"title": "Ip",
"type": "string"
},
"managed": {
"default": true,
"title": "Managed",
"type": "boolean"
},
"permanent_mac": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Permanent Mac"
},
"route_metric": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Route Metric"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"state",
"connected",
"ip",
"gateway"
],
"title": "Ethernet",
"type": "object"
}HTTPValidationError
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}Memory
{
"properties": {
"available": {
"title": "Available",
"type": "string"
},
"swap_used": {
"title": "Swap Used",
"type": "string"
},
"used": {
"title": "Used",
"type": "string"
}
},
"required": [
"used",
"available",
"swap_used"
],
"title": "Memory",
"type": "object"
}Network
{
"properties": {
"access_point": {
"$ref": "#/components/schemas/AccessPoint"
},
"ethernet": {
"$ref": "#/components/schemas/Ethernet"
},
"ethernet_interfaces": {
"items": {
"$ref": "#/components/schemas/Ethernet"
},
"title": "Ethernet Interfaces",
"type": "array"
},
"wifi": {
"$ref": "#/components/schemas/Wifi"
}
},
"required": [
"ethernet",
"wifi",
"access_point"
],
"title": "Network",
"type": "object"
}Resources
{
"properties": {
"cpu": {
"$ref": "#/components/schemas/CPU"
},
"memory": {
"$ref": "#/components/schemas/Memory"
},
"storage": {
"$ref": "#/components/schemas/Storage"
}
},
"required": [
"cpu",
"memory",
"storage"
],
"title": "Resources",
"type": "object"
}Services
{
"properties": {
"apache": {
"default": "unknown",
"title": "Apache",
"type": "string"
},
"fastapi": {
"default": "running",
"title": "Fastapi",
"type": "string"
},
"kiwix": {
"default": "unknown",
"title": "Kiwix",
"type": "string"
},
"network_manager": {
"default": "unknown",
"title": "Network Manager",
"type": "string"
},
"samba": {
"default": "unknown",
"title": "Samba",
"type": "string"
}
},
"title": "Services",
"type": "object"
}Signal
{
"properties": {
"dbm": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Received signal strength (dBm)",
"title": "Dbm"
},
"percent": {
"anyOf": [
{
"maximum": 100.0,
"minimum": 0.0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Percent"
}
},
"title": "Signal",
"type": "object"
}Status
{
"properties": {
"debug": {
"title": "Debug",
"type": "boolean"
},
"issues": {
"items": {
"type": "string"
},
"title": "Issues",
"type": "array"
},
"state": {
"title": "State",
"type": "string"
},
"sync": {
"default": "Unavailable",
"title": "Sync",
"type": "string"
},
"update": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Update"
},
"updated": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Updated"
}
},
"required": [
"state",
"debug"
],
"title": "Status",
"type": "object"
}StatusResponse
{
"properties": {
"network": {
"anyOf": [
{
"$ref": "#/components/schemas/Network"
},
{
"type": "null"
}
]
},
"resources": {
"anyOf": [
{
"$ref": "#/components/schemas/Resources"
},
{
"type": "null"
}
]
},
"services": {
"$ref": "#/components/schemas/Services"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"system": {
"anyOf": [
{
"$ref": "#/components/schemas/System"
},
{
"type": "null"
}
]
}
},
"required": [
"network",
"system",
"resources",
"services",
"status"
],
"title": "StatusResponse",
"type": "object"
}Storage
{
"properties": {
"sd": {
"$ref": "#/components/schemas/Disk"
},
"ssd": {
"$ref": "#/components/schemas/Disk"
}
},
"required": [
"sd",
"ssd"
],
"title": "Storage",
"type": "object"
}System
{
"properties": {
"hostname": {
"title": "Hostname",
"type": "string"
},
"platform": {
"title": "Platform",
"type": "string"
},
"uptime": {
"title": "Uptime",
"type": "string"
}
},
"required": [
"hostname",
"platform",
"uptime"
],
"title": "System",
"type": "object"
}ValidationError
{
"properties": {
"ctx": {
"title": "Context",
"type": "object"
},
"input": {
"title": "Input"
},
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"title": "Location",
"type": "array"
},
"msg": {
"title": "Message",
"type": "string"
},
"type": {
"title": "Error Type",
"type": "string"
}
},
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError",
"type": "object"
}Wifi
{
"properties": {
"connected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Connected"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled"
},
"gateway": {
"title": "Gateway",
"type": "string"
},
"interface": {
"default": "wlan1",
"title": "Interface",
"type": "string"
},
"ip": {
"title": "Ip",
"type": "string"
},
"rate": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Rate"
},
"signal": {
"$ref": "#/components/schemas/Signal"
},
"ssid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ssid"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"state",
"connected",
"ssid",
"signal",
"rate",
"ip",
"gateway"
],
"title": "Wifi",
"type": "object"
}