Skip to main content

Crate wings_api

Crate wings_api 

Source
Expand description

The Calagopus Panel Wings API library.

Used for communicating with the Wings daemon. This library contains auto-generated code from the OpenAPI specification as well as some utilities for working with the Wings API. In 99% of cases you will want to use the crate::client::WingsClient struct to interact with the API.

Modules§

backups_backup
backups_backup_export
backups_backup_query
client
deauthorize_user
permissions_invalidate
ports_used
servers
servers_power
servers_server
servers_server_backup
servers_server_backup_backup
servers_server_backup_backup_restore
servers_server_commands
servers_server_database_backup
servers_server_database_backup_backup_restore
servers_server_files_chmod
servers_server_files_compress
servers_server_files_contents
servers_server_files_copy
servers_server_files_copy_many
servers_server_files_copy_remote
servers_server_files_create_directory
servers_server_files_create_symlink
servers_server_files_decompress
servers_server_files_delete
servers_server_files_directory_sizes
servers_server_files_fingerprints
servers_server_files_ignore_matches
servers_server_files_largest_directories
servers_server_files_lines
servers_server_files_list
servers_server_files_list_directory
servers_server_files_operations
servers_server_files_operations_operation
servers_server_files_pull
servers_server_files_pull_pull
servers_server_files_pull_query
servers_server_files_rename
servers_server_files_revisions
servers_server_files_revisions_revision
servers_server_files_search
servers_server_files_sqlite_query
servers_server_files_stat
servers_server_files_trash
servers_server_files_trash_purge
servers_server_files_trash_restore
servers_server_files_write
servers_server_install_abort
servers_server_logs
servers_server_logs_install
servers_server_power
servers_server_reinstall
servers_server_schedules_schedule
servers_server_schedules_schedule_abort
servers_server_schedules_schedule_trigger
servers_server_script
servers_server_sync
servers_server_transfer
servers_server_utilization
servers_server_version
servers_server_ws_broadcast
servers_server_ws_deny
servers_server_ws_permissions
servers_utilization
setup
system
system_backups_test
system_config
system_ips
system_logs
system_logs_file
system_overview
system_restic_prune
system_restic_stats
system_restic_unlock
system_stats
system_upgrade
transfers
transfers_capabilities
transfers_files
transfers_files_stat
transfers_query
transfers_server
tundra
tundra_metrics
tundra_rotate
tundra_sync
tunnel
update

Structs§

ApiError
BandwidthLimits
BandwidthStatus
Config
ContentMatches
CopyFile
Device
DirectoryEntry
DirectorySizes
Download
FilesystemOperation
FirewallRule
InstallationScript
KopiaBackupConfiguration
MatchBlock
MatchSpan
Mount
PbsRepositoryConfiguration
QueryColumn
QueryResultSet
ResourceUsage
ResourceUsageNetwork
ResticBackupConfiguration
ResticTaskResult
RevisionInfo
S3TestConfiguration
Schedule
ScheduleAction
ScheduleHttpHeader
ScheduleStatus
ScheduleVariable
Server
ServerConfiguration
ServerConfigurationAllocations
ServerConfigurationAllocationsDefault
ServerConfigurationAutoKill
ServerConfigurationBuild
ServerConfigurationContainer
ServerConfigurationContainerSeccomp
ServerConfigurationEgg
ServerConfigurationFeatures
ServerConfigurationFeaturesRuntimeCpuBoost
ServerConfigurationFeaturesStartupCpuBoost
ServerConfigurationMeta
ServerConfigurationTrash
SystemStats
SystemStatsCpu
SystemStatsDisk
SystemStatsMemory
SystemStatsNetwork
TransferCapabilities
TransferProgress
TrashEntry
TundraMetrics
The mesh daemon reports considerably more than this - per-path congestion detail, UDP socket counters, restart handover state - and serde drops what is not declared here. The fields below are the ones the panel renders, so a daemon that stops sending one fails deserialization on the panel rather than the browser.
TundraNodeMetrics
TundraPeerDropMetrics
TundraPeerFlowMetrics
TundraPeerMetrics
TundraPeerPathMetrics
TundraPeerRelayMetrics
TundraStatus
What a node reports about the tundra mesh daemon it manages. Hand-written rather than generated because the panel drives these routes directly, not through the shim.
UploadEntry
UsedPort
WebsocketMessage

Enums§

Algorithm
AppContainerType
ArchiveFormat
BackupAdapter
BackupTestTarget
CompressionLevel
CompressionType
DirectorySortingMode
DiskLimiterMode
FirewallBackendKind
FirewallRuleAction
FirewallRuleProtocol
Game
QueryValue
ScheduleActionInner
ScheduleBackupSelector
ScheduleCondition
ScheduleConditionComparator
ScheduleDynamicParameter
ScheduleHttpMethod
ScheduleResourceMetric
ScheduleTrigger
ServerAutoStartBehavior
ServerBackupStatus
ServerPowerAction
ServerSelector
ServerState
StreamableArchiveFormat
SystemBackupsDdupBakCompressionFormat
TransferArchiveFormat
WebsocketEvent

Constants§

FORBIDDEN_CONFIG_PATHS
SECRET_CONFIG_PATHS
Config paths holding secrets, * matching every key of a map.

Functions§

strip_config_paths

Type Aliases§

MiB
SystemPath