/

/Sylve API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

v1

latestSwagger 2.0BSD-2-Clause2026-07-17198262523.1 KB

Groups

List Groups

List all groups in the system

get/auth/groups

Response

Success

errorstring

messagestring

statusstring

All 198 operations

get List Groups
post Create Group
delete Delete Group
put Update Group Members
post Add Users to Group
post Login
post Logout
get List Users
post Create User
delete Delete User
post Initialize Sylve
post Initiate System Reboot
get Get Basic Settings
get Get Cluster
post Create Cluster
post Accept Join
post Join Cluster
get Get All Cluster Nodes
post Remove Peer
delete Reset Raft Node
get Get Cluster Resources (per node)
post Resync Cluster State
post Create partition
post Delete partition
post Initialize GPT
get List disk devices
post Wipe disk
put Modify CPU of a Virtual Machine
put Modify PCI Devices of a Virtual Machine
put Modify RAM of a Virtual Machine
put Modify VNC of a Virtual Machine
get Basic health check
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
put Update a note by ID
delete Delete a note by ID
post Bulk delete notes
put Update a Cluster Note
delete Delete a Cluster Note
get Get RAM Info
get Get Historical RAM information
get Get Swap Info
get Get Historical Swap information
post Sync Cluster Health
get List all Jails
post Create a new Jail
get Get a Jail by an Identifier
get Get Jail Logs
post Perform Jail Action
post Create bootstrap
delete Delete bootstrap
get List bootstraps
put Update Jail CPU
put Edit a Jail's description
put Update Jail Memory
put Edit a Jail's name
put Edit Network Switch for Jail
post Add Network Switch to Jail
put Set Network Inheritance
delete Delete Network Switch from Jail
put Update Resource Limits
get List all Jails (Simple)
get Get a Jail by CTID or ID (Simple)
get List all Jails States
get Get Jail State
get Get Jail Statistics
delete Delete a Jail
post Attach Network to a Virtual Machine
post Detach Network from a Virtual Machine
get Get DHCP Config
put Modify DHCP Config
get Get DHCP Leases
put Update DHCP Lease
post Create DHCP Lease
post Delete Dynamic DHCP Lease
delete Delete DHCP Lease
get Get DHCP Ranges
post Create DHCP Range
put Modify DHCP Range
delete Delete DHCP Range
get List Network Interfaces
post Create a new Manual Switch
delete Delete a Manual Switch
get List Network Objects
post Create Network Object
post Bulk Delete Network Objects
put Edit Network Object
delete Delete Network Object
get List Network Switches
put Update a Standard Switch
post Create a new Standard Switch
delete Delete a Standard Switch
put Update Network Switch for a Virtual Machine
put Modify Additional Options of a Jail
put Modify Allowed Options of a Jail
put Modify Boot Order of a Virtual Machine
put Modify Boot ROM of a Virtual Machine
put Modify Clock of a Virtual Machine
put Modify Cloud-Init Data of a Virtual Machine
put Modify DevFS rules of a Jail
put Modify Extra Bhyve Options of a Virtual Machine
put Modify Fstab of a Jail
put Modify Ignore UMSRs of a Virtual Machine
put Modify Lifecycle Hooks of a Jail
put Modify Metadata of a Jail
put Modify QEMU Guest Agent of a Virtual Machine
put Modify resolv.conf of a Jail
put Modify Serial Console Access of a Virtual Machine
put Modify Shutdown Wait Time of a Virtual Machine
put Modify TPM of a Virtual Machine
put Modify Wake-on-LAN of a Virtual Machine
get Get QEMU Guest Agent info of a Virtual Machine
get Get Samba Audit Logs
get Get Samba Global Configuration
post Set Samba Global Configuration
get Get Samba Shares
put Update Samba Share
post Create Samba Share
delete Delete Samba Share
post Attach Storage to a Virtual Machine
post Detach Storage from a Virtual Machine
post Update Virtual Machine Storage
get Get Basic System Settings
put Add Usable ZFS Pools
put Toggle Service
get Find Files on System
post Add File or Folder
delete Delete File or Folder
post Copy or Move File or Folder
post Copy or Move Files or Folders
post Delete Files or Folders
get Download File
post Rename File or Folder
post Upload File (FilePond)
delete Delete Uploaded File
get List PCI Devices
get List Passed Through Devices
post Add Passed Through Device
post Import Passed Through Device
post Prepare Passed Through Device
delete Remove Passed Through Device
get List Cloud-Init Templates
post Add Cloud-Init Template
put Edit Cloud-Init Template
delete Delete Cloud-Init Template
get List Downloads
post Download File
post Bulk Delete Downloads
get Get Download Paths
get Get Signed Download URL
get List Downloads Grouped by Type
delete Delete Download
get Download File
get List all Virtual Machines
post Create a new Virtual Machine
get Get a Virtual Machine by RID or ID
put Edit a Virtual Machine's description
get Get a Virtual Machine's Domain
get Get VM Logs
put Edit a Virtual Machine's name
get List all VMs (Simple)
get Get a simple Virtual Machine by RID or ID
get Get VM Statistics
post Perform an action on a Virtual Machine
delete Remove a Virtual Machine
get Get all ZFS datasets
post Bulk delete ZFS datasets
post Bulk Delete Datasets By Name
post Create a ZFS filesystem
patch Edit a ZFS filesystem
delete Delete 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
patch Modify retention of a periodic ZFS snapshot job
delete Delete a periodic ZFS snapshot
post Rollback to a ZFS snapshot
delete Delete a ZFS snapshot
post Create a ZFS volume
patch Edit a ZFS volume
post Flash a ZFS volume
delete Delete a ZFS volume
get Get Pool Stats
get Get Pools
post Create Pool
patch Edit Pool
get Get Disk Usage
delete Delete Pool
post Replace Device
post Scrub Pool
get Get Pool Status