/
AL
alchemillahq
/
Sylve API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 12m ago · Updated 5h ago
latest
Swagger 2.0
BSD-2-Clause
raw.githubusercontent.com
2026-08-23
391
595
1.5 MB
abcc7aa63309
Authentication
10
post
Login
get
Get Login Configuration
post
Logout
post
Begin passkey login
post
Finish passkey login
post
Begin passkey registration
post
Finish passkey registration
post
Create SSE token
get
List user passkeys
delete
Delete user passkey
Basic
3
post
Initialize Sylve
get
Get Basic Settings
post
Initiate System Reboot
Certificates
10
get
List TLS certificates
post
Create a TLS certificate
get
Check TLS certificate domain resolution
delete
Delete a TLS certificate
patch
Update a TLS certificate
post
Schedule TLS certificate activation
delete
Cancel pending TLS certificate activation
get
Download a TLS certificate archive
post
Renew a TLS certificate
post
Retry managed TLS certificate issuance
Cluster
15
get
Get Cluster
post
Create Cluster
post
Accept Join
post
Join Cluster
get
Reveal Cluster Join Key
get
Get All Cluster Nodes
get
Get All Cluster Notes
post
Create a New Cluster Note
post
Bulk Delete Cluster Notes
put
Update a Cluster Note
delete
Delete a Cluster Note
delete
Reset Raft Node
get
Get Cluster Resources (per node)
post
Resync Cluster State
post
Remove Peer
Cluster Backups
23
get
List Backup Events
get
List Backup Events with Pagination
get
Get a Backup Event
get
Get Backup Event Progress
get
List Backup Jobs
post
Create a Backup Job
put
Update a Backup Job
delete
Delete a Backup Job
post
Restore a Backup Job Snapshot
post
Run a Backup Job
get
List Backup Job Snapshots
get
List Backup Targets
post
Create a Backup Target
put
Update a Backup Target
delete
Delete a Backup Target
get
List Backup Target Datasets
get
Get Backup Jail Metadata
get
List Backup Target Dataset Snapshots
get
Get Backup VM Metadata
get
Get Backup Target Readiness
post
Restore a Backup Target Dataset
get
List Running Jobs for a Backup Target
post
Validate a Backup Target
Cluster Internal
1
post
Sync Cluster Health
Cluster Replication
9
get
List Replication Events
get
Get a Replication Event
get
Get Replication Event Progress
get
List Replication Policies
post
Create a Replication Policy
put
Update a Replication Policy
delete
Delete a Replication Policy
post
Fail Over a Replication Policy
post
Run a Replication Policy Now
Disk
12
get
List disk devices
delete
Delete partition
get
Get S.M.A.R.T. self-test information
post
Start a S.M.A.R.T. self-test
post
Abort a S.M.A.R.T. self-test
get
List S.M.A.R.T. self-test schedules
post
Create a S.M.A.R.T. self-test schedule
put
Update a S.M.A.R.T. self-test schedule
delete
Delete a S.M.A.R.T. self-test schedule
post
Initialize GPT
delete
Clear a disk partition table
post
Create disk partitions
Dynamic DNS
5
get
List Dynamic DNS entries
post
Create a Dynamic DNS entry
put
Update a Dynamic DNS entry
delete
Delete a Dynamic DNS entry
post
Synchronize a Dynamic DNS entry
Events
1
get
Subscribe to server-sent events
Groups
4
get
List groups
post
Create group
delete
Delete group
put
Replace group members
Health
2
get
Basic health check
get
HTTP health check
Info
18
get
Get Audit Records
get
Get Basic Info
get
Get Current CPU information
get
Get Historical CPU information
get
Get Historical Network information
get
Get Node Info
get
Get All Notes
post
Create a new note
delete
Bulk delete notes
put
Update a note by ID
delete
Delete a note by ID
get
Get RAM Info
get
Get Historical RAM information
get
Get node summary chart history
get
Get node summary chart history deltas
get
Get Swap Info
get
Get Historical Swap information
get
Open a host terminal WebSocket
iSCSI
15
get
List iSCSI initiators
post
Create an iSCSI initiator
put
Update an iSCSI initiator
delete
Delete an iSCSI initiator
post
Connect an iSCSI initiator
get
Get iSCSI initiator status
get
List iSCSI target sessions
get
List iSCSI targets
post
Create an iSCSI target
put
Update an iSCSI target
delete
Delete an iSCSI target
post
Add an iSCSI target LUN
delete
Remove an iSCSI target LUN
post
Add an iSCSI target portal
delete
Remove an iSCSI target portal
Jail
45
get
List Jails
post
Create a new Jail
get
List bootstraps
post
Create bootstrap
delete
Delete bootstrap
get
List Jails (Simple)
get
Get a Jail (Simple)
get
List jail templates
get
Get a jail template
delete
Delete a jail template
post
Create jails from a template
get
Get a Jail
delete
Delete a Jail
post
Queue a Jail lifecycle action
get
Open a jail console WebSocket
patch
Edit a Jail's description
put
Update jail CPU limit
put
Update jail RAM limit
put
Set jail resource limits
get
Get jail logs
post
Queue a Jail migration
patch
Edit a Jail's name
put
Set jail network inheritance
post
Attach a network to a jail
delete
Detach a network from a jail
patch
Update a jail network
put
Replace additional jail.conf options
put
Replace allowed jail options
put
Replace jail automatic-start configuration
put
Replace jail DevFS rules
put
Replace jail execution timeout
put
Replace jail fstab configuration
put
Replace jail lifecycle hooks
put
Replace jail metadata
put
Replace jail resolv.conf configuration
put
Replace jail Wake-on-LAN configuration
get
Resolve a jail root mountpoint
get
List jail snapshots
post
Create a jail snapshot
delete
Delete a jail snapshot
post
Roll back a jail snapshot
get
Get jail state
get
Get initial jail statistics
get
Get jail statistics
post
Capture a jail as a template
mDNS
6
get
Get mDNS settings
put
Update mDNS settings
get
List mDNS records
post
Create an mDNS record
put
Update an mDNS record
delete
Delete an mDNS record
Network
61
get
Get DHCP configuration
put
Update DHCP configuration
get
List DHCP leases
post
Create a static DHCP lease
delete
Delete a dynamic DHCP lease
put
Update a static DHCP lease
delete
Delete a static DHCP lease
get
List DHCP ranges
post
Create a DHCP range
put
Update a DHCP range
delete
Delete a DHCP range
get
Get Firewall Advanced Settings
put
Update Firewall Advanced Settings
post
Preview Firewall Configuration
get
Get Rendered Firewall Configuration
get
List Live Firewall Logs
get
List Firewall NAT Rules
post
Create Firewall NAT Rule
delete
Bulk Delete Firewall NAT Rules
get
List Firewall NAT Rule Counters
put
Reorder Firewall NAT Rules
put
Update Firewall NAT Rule
delete
Delete Firewall NAT Rule
get
Suggest routes from NAT rule
get
List Firewall Traffic Rules
post
Create Firewall Traffic Rule
delete
Bulk Delete Firewall Traffic Rules
get
List Firewall Traffic Rule Counters
put
Reorder Firewall Traffic Rules
put
Update Firewall Traffic Rule
delete
Delete Firewall Traffic Rule
get
List Network Interfaces
get
List Network Objects
post
Create Network Object
delete
Bulk Delete Network Objects
put
Update Network Object
delete
Delete Network Object
get
List static routes
post
Create static route
put
Update static route
delete
Delete static route
get
List network switches
post
Create a manual switch
delete
Delete a manual switch
post
Create a standard switch
put
Update a standard switch
delete
Delete a standard switch
get
List WireGuard clients
post
Create WireGuard client
put
Update WireGuard client
delete
Delete WireGuard client
patch
Set WireGuard client state
get
Get WireGuard server
put
Update WireGuard server
post
Initialize WireGuard server
delete
Deinitialize WireGuard server
patch
Set WireGuard server state
post
Add WireGuard server peer
put
Update WireGuard server peer
delete
Remove WireGuard server peer
patch
Set WireGuard server peer state
Notifications
17
get
List notifications
get
Count active notifications
post
Dismiss all notifications
get
List notification rules
put
Update notification rules
post
Create a notification rule
post
Delete notification rules in bulk
post
Update notification rules in bulk
post
Test a notification rule
put
Update a notification rule
delete
Delete a notification rule
get
List notification transports
post
Create a notification transport
put
Update a notification transport
delete
Delete a notification transport
post
Test a notification transport
post
Dismiss a notification
Samba
8
get
Get Samba audit logs
get
Get Samba global configuration
put
Update Samba global configuration
get
Get Samba shares
post
Create a Samba share
put
Update a Samba share
delete
Delete a Samba share
put
Enable or disable a Samba share
System
19
get
Get Basic System Settings
put
Replace Usable ZFS Pools
patch
Set Service State
get
Browse Files and Folders
post
Create a File or Folder
post
Copy or Move Files or Folders
post
Delete Files or Folders
get
Download a file
post
Rename File or Folder
post
Upload a File
delete
Revert an Uploaded File
get
List PCI devices
get
List managed passthrough devices
post
Enable PCI passthrough
post
Import a PCI passthrough device
post
Prepare PCI passthrough
delete
Disable PCI passthrough
put
Set Sysctl Tunable
get
List Sysctl Tunables
Tasks
5
get
List active lifecycle tasks
get
Get the active lifecycle task for a guest
get
List recent lifecycle tasks
get
Validate a guest migration
post
Request migration cancellation
Users
9
get
List users
post
Create local user
get
Get user-management capabilities
post
Import Unix user
get
List importable Unix users
post
Create PAM User
get
Get next Unix UID
put
Update user
delete
Delete user
Utilities
16
get
List Cloud-Init Templates
post
Create Cloud-Init Template
put
Replace Cloud-Init Template
delete
Delete Cloud-Init Template
post
Stage a Downloader Upload
delete
Abort a Downloader Upload
post
Complete a Downloader Upload
get
List Downloads
post
Start Download
post
Bulk Delete Downloads
get
Get Download Paths
post
Get Signed Download URL
get
List Completed Download Choices
delete
Delete Download
patch
Update Download
get
Download File
VM
48
get
List all Virtual Machines
post
Create a new Virtual Machine
get
List all VMs (Simple)
get
Get a simple Virtual Machine by RID
get
List VM templates
get
Get a VM template
delete
Delete a VM template
post
Create VMs from a template
get
Get a Virtual Machine by RID
delete
Remove a Virtual Machine
post
Queue a Virtual Machine lifecycle action
get
Open a VM serial console WebSocket
patch
Edit a Virtual Machine's description
get
Get a Virtual Machine's Domain
get
Get virtual machine guest-agent information
put
Replace virtual machine CPU configuration
put
Replace virtual machine PCI passthrough configuration
put
Replace virtual machine RAM configuration
put
Replace virtual machine VNC configuration
get
Get VM Logs
post
Queue a Virtual Machine migration
patch
Edit a Virtual Machine's name
post
Attach network to a virtual machine
delete
Detach network from a virtual machine
patch
Update virtual machine network
put
Replace virtual machine automatic-start configuration
put
Replace virtual machine boot ROM configuration
put
Replace virtual machine clock configuration
put
Replace virtual machine cloud-init configuration
put
Replace virtual machine extra bhyve options
put
Replace virtual machine unknown-MSR handling
put
Replace virtual machine QEMU Guest Agent configuration
put
Replace virtual machine serial-console configuration
put
Replace virtual machine shutdown wait time
put
Replace virtual machine TPM-emulation configuration
put
Replace virtual machine Wake-on-LAN configuration
delete
Purge an orphaned Virtual Machine registration
get
List VM snapshots
post
Create a VM snapshot
delete
Delete a VM snapshot
post
Roll back a VM snapshot
get
Get Initial VM Statistics
get
Get VM Statistics
post
Attach storage to a virtual machine
delete
Detach storage from a virtual machine
patch
Update virtual machine storage
post
Capture a VM as a template
get
Open a VM VNC WebSocket
ZFS
29
get
Get ZFS dashboard history
get
Get ZFS dashboard history delta
get
Get the current ZFS dashboard snapshot
get
Get all ZFS datasets
delete
Bulk delete ZFS datasets
post
Create a ZFS filesystem
delete
Delete a ZFS filesystem
patch
Edit a ZFS filesystem
get
Get all ZFS Datasets with Pagination
post
Create a ZFS snapshot
get
Get all periodic ZFS snapshot jobs
post
Create a periodic ZFS snapshot job
delete
Delete a periodic ZFS snapshot job
patch
Modify retention of a periodic ZFS snapshot job
delete
Delete a ZFS snapshot
post
Rollback to a ZFS snapshot
post
Create a ZFS volume
delete
Delete a ZFS volume
patch
Edit a ZFS volume
post
Flash a ZFS volume
get
Get Pools
post
Create Pool
get
Get Disk Usage
delete
Delete Pool
patch
Edit Pool
post
Detach Device
post
Replace Device
post
Scrub Pool
get
Get Pool Status
Groups
List groups
List all managed groups and their public user records
get
/auth/groups
Response
Success
GithubComAlchemillahqSylveInternalAPIResponseArrayInternalHandlersAuthPublicGroup
required
data
InternalHandlersAuthPublicGroup[]
error
string
message
string
status
string