HTTP Routing Table

 
/admin
GET /admin/tenants List tenants
GET /admin/tenants/is-multi-tenant Check multi-tenant mode
GET /admin/tenants/stats Get tenant statistics
GET /admin/tenants/{id} Get tenant
GET /admin/tenants/{id}/limits Get tenant limits
GET /admin/tenants/{id}/network Get tenant network
POST /admin/tenants Create tenant
POST /admin/tenants/{id}/network Assign network to tenant
PUT /admin/tenants/{id}/limits Configure tenant limits
PUT /admin/tenants/{id}/status Toggle tenant active status
 
/alerts
GET /alerts/types List alert types
POST /alerts/archive Archive alerts
POST /alerts/get-by-id Get alert by ID
POST /alerts/get-id Get alert ID
POST /alerts/list List alerts
 
/api
GET /api/v2/configuration/groups List configuration groups
GET /api/v2/configuration/list List configurations
GET /api/v2/configuration/status Health check
GET /api/v2/storage/benchmark/profiles List benchmark profiles
GET /api/v2/storage/benchmark/tools Check benchmark tool availability
POST /api/v2/network/bridges Create a bridge
POST /api/v2/storage/benchmark/disk Run disk benchmark (fio)
POST /api/v2/storage/benchmark/pool Run pool benchmark (rados bench)
POST /api/v2/storage/benchmark/rbd Run RBD benchmark (rbd bench)
PUT /api/v2/configuration/update Update configuration value
PUT /api/v2/network/bridges Update a bridge (ports, STP, offloads)
 
/bmc
GET /bmc/onboarding/available-positions Get available rack positions
GET /bmc/onboarding/device-roles List device roles
GET /bmc/onboarding/device-types List device types by manufacturer
GET /bmc/onboarding/devices List devices in site/location/rack
GET /bmc/onboarding/hardware-info Get complete hardware information for a device
GET /bmc/onboarding/interfaces Get device network interfaces
GET /bmc/onboarding/inventory-items Get device inventory items
GET /bmc/onboarding/locations List locations in site
GET /bmc/onboarding/manufacturers List supported manufacturers
GET /bmc/onboarding/nodes List nodes by site and provision status with pagination
GET /bmc/onboarding/racks List racks in location
GET /bmc/onboarding/site Get site by ID or default site
GET /bmc/onboarding/site/{id} Get site by ID or default site
GET /bmc/onboarding/site/{id}/vlans Get all VLANs for a site grouped by role
GET /bmc/onboarding/site/{id}/vlans/{role} Get VLANs for a specific role at a site
POST /bmc/onboarding/device-types Create a new device type
POST /bmc/onboarding/locations Create a new location
POST /bmc/onboarding/manufacturers Create a new manufacturer
POST /bmc/onboarding/racks Create a new rack
POST /bmc/onboarding/register Register device via onboarding wizard
 
/catalog
POST /catalog/serviceofferings/create Create service offering
POST /catalog/serviceofferings/diskoffering/create Create disk offering
POST /catalog/serviceofferings/diskoffering/getByID Get disk offering by ID
POST /catalog/serviceofferings/diskoffering/getByName Get disk offering by name
POST /catalog/serviceofferings/diskoffering/getID GetDiskOfferingID
POST /catalog/serviceofferings/diskoffering/list List disk offerings
POST /catalog/serviceofferings/diskoffering/update Update disk offering
POST /catalog/serviceofferings/getByID Get service offering by ID
POST /catalog/serviceofferings/getByName Get service offering by name
POST /catalog/serviceofferings/getID Get service offering ID
POST /catalog/serviceofferings/list List service offerings
POST /catalog/serviceofferings/update Update service offering
POST /catalog/serviceofferings/vroffering/create Create custom VR system offering
POST /catalog/serviceofferings/vroffering/list List all VR system offerings
 
/chargeback
GET /chargeback/tenants/{id}/bill Get current month's bill
GET /chargeback/tenants/{id}/bill/pdf Download current month's bill as PDF
GET /chargeback/tenants/{id}/bill/upcoming Get upcoming month's estimated bill
GET /chargeback/tenants/{id}/bills List historical bills
GET /chargeback/tenants/{id}/bills/{period}/pdf Download a historical bill as PDF
GET /chargeback/tenants/{id}/pricing Get tenant pricing
POST /chargeback/tenants/{id}/bills/snapshot Snapshot (lock) current month's bill
PUT /chargeback/tenants/{id}/billable Toggle tenant billable status
PUT /chargeback/tenants/{id}/pricing Set tenant pricing
 
/compute
GET /compute/vms/isos List available ISOs
GET /compute/vms/metrics/aggregate Aggregate VM metrics
GET /compute/vms/usage-history List VM usage history
POST /compute/vms/attach-disk Attach disk
POST /compute/vms/attachiso Attach ISO to VM
POST /compute/vms/autoscale/conditions/create Create autoscale condition
POST /compute/vms/autoscale/conditions/getByID Get autoscale condition by ID
POST /compute/vms/autoscale/conditions/list List autoscale conditions
POST /compute/vms/autoscale/conditions/update Update autoscale condition
POST /compute/vms/autoscale/counters/create Create autoscale counter
POST /compute/vms/autoscale/counters/getByID Get autoscale counter by ID
POST /compute/vms/autoscale/counters/getByName Get autoscale counter by name
POST /compute/vms/autoscale/counters/list List autoscale counters
POST /compute/vms/autoscale/policies/create Create autoscale policy
POST /compute/vms/autoscale/policies/getByID Get autoscale policy by ID
POST /compute/vms/autoscale/policies/getByName Get autoscale policy by name
POST /compute/vms/autoscale/policies/list List autoscale policies
POST /compute/vms/autoscale/policies/update Update autoscale policy
POST /compute/vms/autoscale/vm-groups/create Create autoscale VM group
POST /compute/vms/autoscale/vm-groups/disable Disable autoscale VM group
POST /compute/vms/autoscale/vm-groups/enable Enable autoscale VM group
POST /compute/vms/autoscale/vm-groups/getByID Get autoscale VM group by ID
POST /compute/vms/autoscale/vm-groups/getByName Get autoscale VM group by name
POST /compute/vms/autoscale/vm-groups/list List autoscale VM groups
POST /compute/vms/autoscale/vm-groups/update Update autoscale VM group
POST /compute/vms/autoscale/vm-profiles/create Create autoscale VM profile
POST /compute/vms/autoscale/vm-profiles/getByID Get autoscale VM profile by ID
POST /compute/vms/autoscale/vm-profiles/list List autoscale VM profiles
POST /compute/vms/autoscale/vm-profiles/update Update autoscale VM profile
POST /compute/vms/byID GetVirtualMachineByID
POST /compute/vms/byName GetVirtualMachineByName
POST /compute/vms/configure-tpm Configure VM firmware (boot type, Secure Boot, vTPM)
POST /compute/vms/create-and-attach-disk Create and attach disk
POST /compute/vms/create-console CreateConsole
POST /compute/vms/detach-disk Detach disk
POST /compute/vms/detachiso Detach ISO from VM
POST /compute/vms/getIdbyName GetVirtualMachineID
POST /compute/vms/instance-groups/create Create instance group
POST /compute/vms/instance-groups/getByID Get instance group by ID
POST /compute/vms/instance-groups/getByName Get instance group by name
POST /compute/vms/instance-groups/list List instance groups
POST /compute/vms/instance-groups/update Update instance group
POST /compute/vms/list ListVirtualMachines
POST /compute/vms/list-for-import ListVmsForImport
POST /compute/vms/migrate MigrateVirtualMachine
POST /compute/vms/nic/add Add NIC to VM
POST /compute/vms/nic/ip/add Add secondary IP to NIC
POST /compute/vms/nic/ip/remove Remove secondary IP from NIC
POST /compute/vms/nic/ip/update Reconfigure primary IP of NIC
POST /compute/vms/nic/list List NICs on a VM
POST /compute/vms/nic/set-default Set default NIC for VM
POST /compute/vms/provision Provision a new virtual machine
POST /compute/vms/reboot Reboot virtual machine
POST /compute/vms/recover Recover virtual machine
POST /compute/vms/restore Restore virtual machine
POST /compute/vms/routers List Virtual Routers
POST /compute/vms/scale Scale virtual machine
POST /compute/vms/settings/compute Update VM compute
POST /compute/vms/settings/detail-options VM settings detail options
POST /compute/vms/settings/get Get VM settings
POST /compute/vms/settings/update Update VM settings
POST /compute/vms/start Start virtual machine
POST /compute/vms/stop Stop virtual machine
POST /compute/vms/systemvms List System VMs
POST /compute/vms/update Update VM configuration
POST /compute/vms/update-affinity Update VM affinity groups
POST /compute/vms/usage-history-byID VirtualMachinesUsageHistoryByID
POST /compute/vms/userdata/reset Reset user data for VM
PUT /compute/vms/update-disksize Update disk
 
/configuration
GET /configuration/smtp Get the SMTP relay configuration
POST /configuration/smtp Save the SMTP relay configuration
POST /configuration/smtp/test Test the SMTP relay connection
 
/configure
GET /configure/nodes/{bmcIP}/nics Get NICs from remote node
GET /configure/nodes/{nodeIP}/decommission/logs Audit log of the latest decommission for a node
GET /configure/nodes/{nodeIP}/decommission/snapshot One-shot status + log snapshot for a decommission
GET /configure/nodes/{nodeIP}/rollback/logs Audit log of the latest configure-failure rollback for a node
POST /configure/decommission/wipe-result Wipe ISO per-disk result callback (node → management)
POST /configure/nodes/{bmcIP}/preflight Run preflight check for node configuration
POST /configure/nodes/{nodeIP}/convert-gpu-mode null
POST /configure/nodes/{nodeIP}/decommission/preflight Preflight checks for decommissioning a node
POST /configure/nodes/{nodeIP}/decommission/status Status of the latest decommission for a node
POST /configure/nodes/{nodeIP}/nics/blink Blink NIC LED on remote node
POST /configure/nodes/{nodeIP}/rollback/status Status of the latest configure-failure rollback for a node
POST /configure/nodes/{nodeIP}/setup Get latest node setup status
POST /configure/setup/status Get latest node setup status
 
/console
GET /console/local null
GET /console/ws null
 
/controlnode
GET /controlnode/bmc/{bmc_ip}/disks Get available disks and NICs for a BMC
GET /controlnode/bmc/{bmc_ip}/gpus Get available GPUs for a BMC
GET /controlnode/fabric-config Get the current network fabric config
GET /controlnode/fabric-config/batches/{id}/postdeploy Post-deployment aggregate for a provisioning batch
GET /controlnode/fabric-config/latest Get the most recent fabric lifecycle job
GET /controlnode/fabric-config/node/{node_ip}/postdeploy Post-deployment step checklist for one node
GET /controlnode/fabric-config/vtep-pool Get VTEP IP pool status
GET /controlnode/job/{id} Get Job Status
GET /controlnode/provision/queue Get provision queue status
POST /controlnode/fabric-config Store network fabric configuration
POST /controlnode/fabric-config/apply Manually trigger a fabric rollout to compute nodes
POST /controlnode/fabric-config/node/{node_ip}/apply Apply EVPN/FRR config to a single node
POST /controlnode/fabric-config/plan Dry-run a fabric configuration
POST /controlnode/fabric-config/preflight Preflight underlay resolution per compute node
POST /controlnode/firstboot Receive first boot OS IP report
POST /controlnode/job/{id}/complete Mark job as installation complete
POST /controlnode/job/{id}/step Receive an install step status report from the live ISO
POST /controlnode/provision Provision a node with Debian OS
POST /controlnode/provision/cisco Provision a Cisco node with Debian OS
POST /controlnode/provision/dell Provision a Dell node with Debian OS
POST /controlnode/provision/hp Provision an HP node with Debian OS
POST /controlnode/provision/lenovo Provision a Lenovo node with Debian OS
POST /controlnode/provision/progress Get latest provision progress for a BMC IP
POST /controlnode/provision/progress/all Get all provision progress records for a BMC IP
POST /controlnode/provision/supermicro Provision a Supermicro node with Debian OS
POST /controlnode/register Register the control node (1st node) in bmc_infos
PATCH /controlnode/job/{id} Patch Job Status
 
/dashboard
GET /dashboard/dcim Get DCIM statistics
GET /dashboard/ipam Get IPAM statistics
GET /dashboard/provision-status Get device counts by provision_status
GET /dashboard/site Get site dashboard data
 
/ddi
GET /ddi/dhcp/leases List DHCP leases
GET /ddi/dhcp/leases/{mac_address} Get DHCP lease by MAC address
GET /ddi/dhcp/reservations List DHCP reservations
GET /ddi/dhcp/scopes List all DHCP scopes
GET /ddi/dhcp/scopes/{scope_name} Get DHCP scope details
GET /ddi/dhcp/scopes/{scope_name}/statistics Get DHCP scope statistics
GET /ddi/dns/records List DNS records
GET /ddi/dns/records/{zone_name}/{record_id} Get DNS record details
GET /ddi/dns/zones List all DNS zones
GET /ddi/dns/zones/{zone_name} Get DNS zone details
GET /ddi/public-ips List public IP addresses
GET /ddi/public-ips/{ip_id} Get public IP details
POST /ddi/dhcp/leases/{mac_address}/convert Convert a DHCP lease
POST /ddi/dhcp/reservations Create a DHCP reservation
POST /ddi/dhcp/scopes Create a DHCP scope
POST /ddi/dhcp/scopes/{scope_name}/disable Disable a DHCP scope
POST /ddi/dhcp/scopes/{scope_name}/enable Enable a DHCP scope
POST /ddi/dns/records Create a DNS record
POST /ddi/dns/records/bulk Bulk DNS record operations
POST /ddi/dns/zones Create a DNS zone
POST /ddi/public-ips Allocate a public IP address
POST /ddi/public-ips/{ip_id}/associate Associate a public IP to a VM
POST /ddi/public-ips/{ip_id}/disassociate Disassociate a public IP from a VM
PUT /ddi/dhcp/reservations/{mac_address} Update a DHCP reservation
PUT /ddi/dhcp/scopes/{scope_name} Update a DHCP scope
PUT /ddi/dns/records/{zone_name}/{record_id} Update a DNS record
PUT /ddi/dns/zones/{zone_name} Update a DNS zone
PUT /ddi/public-ips/{ip_id}/dns Update DNS records for a public IP
 
/dell-inventory
GET /dell-inventory/jobs/track/ws Track Dell Job Progress (WebSocket)
GET /dell-inventory/powerstate/sse Monitor Dell Power State (SSE)
POST /dell-inventory/bios Get Dell BIOS Settings
POST /dell-inventory/bios/patch Patch Dell BIOS Attributes
POST /dell-inventory/bios/pending Get Dell Pending BIOS Attributes
POST /dell-inventory/bios/restart Restart Dell System
POST /dell-inventory/bios/update BIOS Firmware Update
POST /dell-inventory/collect Collect Dell Inventory
POST /dell-inventory/iso/mount Mount ISO and Boot (Dell)
POST /dell-inventory/jobs/deleteall Delete All Dell Jobs
POST /dell-inventory/jobs/list List Dell Job IDs
POST /dell-inventory/poweraction Dell Power Action
POST /dell-inventory/powerstate Get Dell Power State
 
/discovery
GET /discovery/capabilities List capabilities
GET /discovery/listCapacity List capacity
POST /discovery/apis List available APIs
POST /discovery/asyncjobs List async jobs
POST /discovery/asyncjobs/result Query async job result
 
/events
GET /events/app-events/{id} Get application event by ID
GET /events/sse SSE Event Stream
GET /events/types List event types
POST /events/app-events List application events
POST /events/archive Archive events
POST /events/list List events
 
/health
GET /health/agent Get comprehensive agent node health with dependency analysis
GET /health/agents/error-trends Get agent node error trends
GET /health/agents/latency-trends Get agent node latency trends
GET /health/diagnostic Detailed diagnostic information with comprehensive health metrics
GET /health/healthz Basic liveness probe for service health monitoring
GET /health/nodes Get all nodes health (management + agents) from database
GET /health/readyz Comprehensive readiness probe with dependency status
 
/hpe-inventory
GET /hpe-inventory/powerstate/sse HPE Power State SSE
POST /hpe-inventory/bios Get HPE BIOS Settings
POST /hpe-inventory/bios/patch Patch HPE BIOS Attributes
POST /hpe-inventory/bios/pending Get HPE Pending BIOS Attributes
POST /hpe-inventory/bios/restart HPE Graceful Restart
POST /hpe-inventory/collect Collect HPE System Inventory
POST /hpe-inventory/firmware/recover Recover HPE from Firmware Deadlock
POST /hpe-inventory/firmware/update HPE Firmware Update
POST /hpe-inventory/iso/mount Mount ISO and Boot (HPE)
POST /hpe-inventory/poweraction HPE Power Action
POST /hpe-inventory/powerstate Get HPE Power State
POST /hpe-inventory/virtualmedia/check Check HPE Virtual Media Status
POST /hpe-inventory/virtualmedia/eject Eject HPE Virtual Media
 
/images
POST /images/iso/deleteiso Delete ISO image
POST /images/iso/getIsoById Get ISO by ID
POST /images/iso/getisoid Get ISO ID
POST /images/iso/listdomain List domain ISOs
POST /images/iso/listisos List ISO images
POST /images/iso/registeriso Register ISO image
POST /images/iso/upload Upload ISO image
POST /images/kubernetes/version/add Register Kubernetes supported version
POST /images/ostypes/list List OS types
POST /images/template/create Create template
POST /images/template/delete Delete template
POST /images/template/getbyid Get template by ID
POST /images/template/getid Get template ID
POST /images/template/list List templates
POST /images/template/listdomain List domain templates
POST /images/template/register Register template
POST /images/template/upload Upload template
 
/infrastructure
GET /infrastructure/hosts/console Get local ttyd status
GET /infrastructure/hosts/details Get Host Additional Details
GET /infrastructure/hosts/metrics/chart Get host metrics chart
GET /infrastructure/hosts/quick List all nodes
GET /infrastructure/hosts/sensors Get current BMC sensor metrics
GET /infrastructure/hosts/sensors/chart Get BMC sensor chart
GET /infrastructure/hosts/sensors/status Get BMC sensor poll status
GET /infrastructure/hosts/sensors/stream Stream BMC sensor metrics
GET /infrastructure/systemvms/{id}/resolvers Read a system VM's live resolvers from inside the VM
GET /infrastructure/zones/dns/applies/{id} List DNS applies for a zone
GET /infrastructure/zones/dns/apply/{id} Read a DNS apply's progress and per-target outcome
GET /infrastructure/zones/dns/logs/{apply_id} Read the log of a zone DNS apply
GET /infrastructure/zones/dns/status/{id} Which devices are using the zone's saved DNS
GET /infrastructure/zones/get-by-name Get zone by name
GET /infrastructure/zones/list List zones
GET /infrastructure/zones/metrics List zones metrics
POST /infrastructure/clusters/add Add a new cluster
POST /infrastructure/clusters/affinity-groups/create Create affinity group
POST /infrastructure/clusters/affinity-groups/getByID Get affinity group by ID
POST /infrastructure/clusters/affinity-groups/list List affinity groups
POST /infrastructure/clusters/affinity-groups/types List affinity group types
POST /infrastructure/clusters/configurations Get cluster configurations
POST /infrastructure/clusters/disableHA Disable HA for cluster
POST /infrastructure/clusters/enableHA Enable HA for cluster
POST /infrastructure/clusters/getAll List clusters
POST /infrastructure/clusters/getByID Get cluster by ID
POST /infrastructure/clusters/getID Get cluster ID
POST /infrastructure/clusters/listMetrics List cluster metrics
POST /infrastructure/clusters/resetDrsConfigs Reset cluster DRS configurations
POST /infrastructure/clusters/updateDrsConfigs Update cluster DRS configurations
POST /infrastructure/gpu/cards/list List GPU cards
POST /infrastructure/gpu/devices/convert Convert an onboarded host's GPU(s) to vgpu or passthrough
POST /infrastructure/gpu/devices/discover Discover GPU devices
POST /infrastructure/gpu/devices/list List GPU devices
POST /infrastructure/gpu/devices/manage Manage GPU device
POST /infrastructure/gpu/devices/repin Repin a PF's VFs to a vGPU profile
POST /infrastructure/gpu/devices/repin/inflight List in-flight vGPU repins
POST /infrastructure/gpu/devices/repin/status Current vGPU repin/convert status for a host
POST /infrastructure/gpu/devices/unmanage Unmanage GPU device
POST /infrastructure/gpu/profiles/create Create vGPU profile
POST /infrastructure/gpu/profiles/list List vGPU profiles
POST /infrastructure/gpu/profiles/sync Sync vGPU profile catalog for a host
POST /infrastructure/hosts/add Add a new host
POST /infrastructure/hosts/cs-mgmt-key/resync Resync the platform management SSH key (maintenance window)
POST /infrastructure/hosts/dedicate Dedicate a host
POST /infrastructure/hosts/dedicate/list List dedicated hosts
POST /infrastructure/hosts/dedicate/release Release a dedicated host
POST /infrastructure/hosts/disable DisableHost
POST /infrastructure/hosts/enable EnableHost
POST /infrastructure/hosts/getbyid Get host by ID
POST /infrastructure/hosts/lend Lend a host to tenants
POST /infrastructure/hosts/lend/release Un-lend a host
POST /infrastructure/hosts/list List hosts
POST /infrastructure/hosts/metrics ListHostsMetrics
POST /infrastructure/hosts/metrics/aggregate Aggregate host metrics
POST /infrastructure/management/list List management servers
POST /infrastructure/pods Create a new pod
POST /infrastructure/pods/delete Delete a pod
POST /infrastructure/pods/getbyid/{id} GetPodByID
POST /infrastructure/pods/getid/{name} GetPodID
POST /infrastructure/pods/list List pods
POST /infrastructure/zones/create Create a new zone
POST /infrastructure/zones/disable Disable a zone
POST /infrastructure/zones/dns/apply/{id} Apply the zone's DNS to its routers and system VMs, now or scheduled
POST /infrastructure/zones/enable Enable a zone
POST /infrastructure/zones/get-by-id Get zone by ID
POST /infrastructure/zones/get-metrics Get zone metrics with infrastructure details
PUT /infrastructure/zones/update Update zone configuration
 
/inventory
GET /inventory/audit/history Get Audit History
GET /inventory/audit/history/by-file/{filename} Get Audit History by File
GET /inventory/audit/history/by-user/{user_id} Get Audit History by User
GET /inventory/bmc-lock/{bmc_ip} Get BMC Lock Info
GET /inventory/device-by-bmc Get device ID by BMC IP
GET /inventory/iso-active-job Get Active ISO Build Job
GET /inventory/iso-job/{id} Get Inventory ISO Job Status
GET /inventory/isolist List Available Inventory ISOs
GET /inventory/list List BIOS Firmware Binaries
GET /inventory/listhw List Hardware Inventories
GET /inventory/power-state/sse Monitor Power State (SSE)
GET /inventory/update-task/sse Monitor Firmware Task (SSE)
POST /inventory/add-hardware Add hardware info to device
POST /inventory/bios-update Trigger BIOS Update
POST /inventory/bios/pending Get Pending BIOS Attributes
POST /inventory/bios/restart Trigger Graceful Restart
POST /inventory/bmc-lock/force-release Force Release BMC Lock
POST /inventory/bmc-reset Reset BMC (Unit Reset)
POST /inventory/bmc-update Trigger BMC Update
POST /inventory/boot/vmedia-check Check Virtual Media Boot Availability
POST /inventory/capture-progress/last Get Last Hardware Capture Progress
POST /inventory/captureinfo Capture Hardware Inventory
POST /inventory/collect Collect Baremetal Inventory
POST /inventory/firmware Get Firmware Inventory
POST /inventory/iso/boot-isolate Prepare BIOS for ISO Boot
POST /inventory/iso/build Build Custom Inventory ISO
POST /inventory/iso/mount Mount ISO via Redfish Virtual Media
POST /inventory/power-control Power Control
POST /inventory/update-task Monitor Firmware Update Task
POST /inventory/upload/fwbins Upload BIOS Firmware Binary
PATCH /inventory/bios Patch BIOS Attributes
 
/ipam
GET /ipam/addresses List IP addresses
GET /ipam/addresses/counts Count IP addresses
GET /ipam/dashboard/stats Get DNS/DHCP dashboard statistics
GET /ipam/ranges List IP ranges
GET /ipam/scopes List prefixes (scopes)
GET /ipam/scopes/counts Count prefixes (scopes)
GET /ipam/vlans List VLANs
GET /ipam/vlans/counts Count VLANs
POST /ipam/allocate Allocate IP address
POST /ipam/release Release IP address
 
/kcam
GET /kcam/cameras List cameras
GET /kcam/cameras/{id}/latest Latest camera snapshot (jpeg)
GET /kcam/cameras/{id}/live Live MSE WebSocket
GET /kcam/cameras/{id}/preview-frames List preview frames (per-second webp)
GET /kcam/cameras/{id}/previews List preview clips (per hour)
GET /kcam/cameras/{id}/recording/clip Recording clip
GET /kcam/cameras/{id}/recording/hls/{path} Recording HLS proxy
GET /kcam/cameras/{id}/recording/segments Recording segments
GET /kcam/cameras/{id}/recording/summary Recording summary
GET /kcam/cameras/{id}/webrtc Live WebRTC signaling
GET /kcam/clips/{path} Get a /clips file
GET /kcam/current Get current K-Lens instance
GET /kcam/events List events
GET /kcam/events/stream Events WebSocket
GET /kcam/events/{id} Get event
GET /kcam/events/{id}/clip Event clip (mp4)
GET /kcam/events/{id}/snapshot Event snapshot (jpeg)
GET /kcam/events/{id}/thumbnail Event thumbnail
GET /kcam/faces List faces
GET /kcam/preview-frames/{filename} Get preview frame (webp)
GET /kcam/review List review segments
GET /kcam/review/activity/motion Motion activity
GET /kcam/stats Frigate stats
GET /kcam/template K-Lens template status
POST /kcam/cameras/probe Probe a camera (ONVIF)
POST /kcam/cameras/{id}/audio Toggle camera audio detection
POST /kcam/cameras/{id}/detect Toggle camera detection
POST /kcam/cameras/{id}/motion Toggle camera motion detection
POST /kcam/cameras/{id}/recording Toggle camera recording
POST /kcam/current/admin-password Change Frigate admin password
POST /kcam/current/admin-password/ack Acknowledge first-boot Frigate password
POST /kcam/current/admin-password/verify Verify Frigate admin password
POST /kcam/faces/{name} Upload face image
POST /kcam/faces/{name}/classify Train (label) a face from the train bucket
POST /kcam/faces/{name}/create Create face person bucket
POST /kcam/initialize Initialize K-Lens
POST /kcam/reviews/viewed Mark review segments reviewed
POST /kcam/template Register K-Lens template
 
/netinfra
GET /netinfra/platforms List supported platforms
GET /netinfra/registry/routing-hosts List all BGP routers
GET /netinfra/registry/routing-hosts/{id} Get a BGP router by OS IP
GET /netinfra/routing/frr/bfd/peers Get BFD peers
GET /netinfra/routing/frr/bgp/summary Get BGP summary
GET /netinfra/routing/frr/evpn/routes Get EVPN routes
GET /netinfra/routing/frr/evpn/vni Get EVPN VNI table
GET /netinfra/routing/frr/ospf/database Get OSPF database
GET /netinfra/routing/frr/ospf/neighbors Get OSPF neighbors
GET /netinfra/routing/frr/ospf/status Get OSPF status
GET /netinfra/routing/frr/rib Get IP routing table
GET /netinfra/routing/frr/running-config Get FRR running config
GET /netinfra/routing/frr/status Get FRR status
GET /netinfra/routing/kernel/routes Get kernel routing table
POST /netinfra/registry/routing-hosts Register a BGP router (deprecated)
POST /netinfra/routing/frr/bgp/neighbor Get BGP neighbor detail
POST /netinfra/routing/frr/configure Configure FRR
POST /netinfra/routing/kernel/routes Add a static kernel route
PUT /netinfra/registry/routing-hosts/{id} Update a BGP router
 
/network
GET /network/config/bonds List LACP bonds
GET /network/config/bonds/{name} Get bond status
GET /network/config/bridges List network bridges
GET /network/config/bridges/{name} Get bridge status
GET /network/config/bridges/{name}/qos Get QoS state for a bridge
GET /network/config/interfaces List network interfaces
GET /network/config/interfaces/{name} Get network interface status
GET /network/config/interfaces/{name}/qos Get QoS state for a network interface
GET /network/config/vlan-interfaces List VLAN sub-interfaces
GET /network/config/vlan-interfaces/{name} Get VLAN sub-interface status
GET /network/config/vlan-interfaces/{name}/qos Get QoS state for a VLAN sub-interface
GET /network/guest-networks/jobs/last Get latest job per network
GET /network/guest-networks/jobs/latest Get latest guest network job by network name
GET /network/host-firewall/audit Host firewall: audit trail
GET /network/host-firewall/drift Host firewall: drift (live vs desired)
GET /network/host-firewall/manifest Host firewall: effective manifest
GET /network/host-firewall/nodes Host firewall: node registry
GET /network/host-firewall/planes Host firewall: plane model
GET /network/host-firewall/ports Host firewall: port-keyed surface
GET /network/host-firewall/reserved Host firewall: reserved port floor + never-deny interfaces
GET /network/host-firewall/rules Host firewall: port-keyed surface
GET /network/host-firewall/state Host firewall: live applied state
GET /network/monitoring/node-summary Get local node network summary
GET /network/monitoring/vxlan List VXLAN interfaces
GET /network/monitoring/vxlan/{name} Validate a VXLAN interface
GET /network/monitoring/vxlan/{name}/status Get VXLAN status by name
GET /network/mtu Get cluster MTU (declared vs actual)
GET /network/routers/{router_id}/resolvers Read a virtual router's live resolvers and DHCP hand-out from inside it
GET /network/vpcs/{id} Get VPC
POST /network/bgp-peers Create BGP peer
POST /network/bgp-peers/list List BGP peers
POST /network/bgp-peers/{id}/dedicate Dedicate BGP peer
POST /network/bgp-peers/{id}/release Release BGP peer
POST /network/config/interfaces Create a dummy interface
POST /network/config/interfaces/{name}/connectivity-test Test connectivity for a proposed interface change
POST /network/config/isolation-methods List network isolation methods
POST /network/config/supported-services List supported network services
POST /network/config/traffic-type-implementors List traffic type implementors
POST /network/config/vlan-interfaces Create VLAN sub-interface
POST /network/config/vlan-interfaces/{name}/connectivity-test Test connectivity for a proposed VLAN change
POST /network/egress-firewall-rules Create an egress firewall rule
POST /network/egress-firewall-rules/list List egress firewall rules
POST /network/firewall-rules Create an ingress firewall rule
POST /network/firewall-rules/list List ingress firewall rules
POST /network/guest-networks/eligible-nics List eligible NICs across all compute nodes
POST /network/guest-networks/list List guest networks
POST /network/guest-networks/{id}/restart Restart a guest network
POST /network/host-firewall/apply Host firewall: apply posture (observe/enforce)
POST /network/host-firewall/confirm Host firewall: confirm (disarm the dead-man)
POST /network/host-firewall/planes Host firewall: upsert plane→bridge override
POST /network/host-firewall/revert Host firewall: revert to snapshot
POST /network/host-firewall/rules/preview Host firewall: preview an operator rule
POST /network/host-firewall/validate Host firewall: pre-enforce validate (dry-run)
POST /network/internal-lb/rules Create internal LB rule
POST /network/internal-lb/rules/get-by-id Get internal LB by ID
POST /network/internal-lb/rules/list List internal load balancers
POST /network/internal-lb/vms/list List internal LB system VMs
POST /network/internal-lb/vms/start Start internal LB VM
POST /network/internal-lb/vms/stop Stop internal LB VM
POST /network/load-balancer/health-checks Create health check policy
POST /network/load-balancer/health-checks/list List health check policies
POST /network/load-balancer/rules Create load balancer rule
POST /network/load-balancer/rules/assign Assign VMs to LB rule
POST /network/load-balancer/rules/get-by-id Get load balancer rule by ID
POST /network/load-balancer/rules/get-by-name Get load balancer rule by name
POST /network/load-balancer/rules/instances List LB rule instances
POST /network/load-balancer/rules/list List load balancer rules
POST /network/load-balancer/rules/remove Remove VMs from LB rule
POST /network/load-balancer/stickiness Create stickiness policy
POST /network/load-balancer/stickiness/list List stickiness policies
POST /network/management-ip-ranges Create management IP range
POST /network/management-ip-ranges/list List management IP ranges
POST /network/monitoring/alerts Get cluster network alerts
POST /network/monitoring/dashboard Get cluster node network dashboard
POST /network/monitoring/frr/dashboard Get FRR dashboard
POST /network/mtu/l2probe Send or count raw MTU probe frames on this node
POST /network/mtu/node-apply Apply a rollout MTU to a role bridge on this node
POST /network/network-offerings Create network offering
POST /network/network-offerings/list List network offerings
POST /network/physical-networks Create physical network
POST /network/physical-networks/list List physical networks
POST /network/port-forwarding Create a port forwarding rule
POST /network/port-forwarding/list List port forwarding rules
POST /network/public-ip-addresses Associate a public IP address
POST /network/public-ip-addresses/list List public IP addresses
POST /network/public-ip-addresses/static-nat/disable Disable static NAT
POST /network/public-ip-addresses/static-nat/enable Enable static NAT
POST /network/public-ip-pools/list List public-IP prefix pools with free counts
POST /network/public-ip-ranges Create VLAN IP range
POST /network/public-ip-ranges/list List VLAN IP ranges
POST /network/public-ip-ranges/{id}/dedicate Dedicate public IP range
POST /network/public-ip-ranges/{id}/release Release public IP range
POST /network/public-ips/list List public IP addresses
POST /network/routers/list List all virtual routers
POST /network/routers/{router_id}/diagnostics Run network diagnostic on router (ping/arping/traceroute)
POST /network/routers/{router_id}/diagnostics/files Get diagnostics files from router (returns signed download URL)
POST /network/routers/{router_id}/health-checks Get virtual router health-check results
POST /network/routers/{router_id}/resize Resize virtual router (change service offering)
POST /network/routers/{router_id}/upgrade-template Upgrade virtual router template
POST /network/service-providers Add network service provider
POST /network/service-providers/list List network service providers
POST /network/service-providers/{nsp_type} Create NSP element
POST /network/service-providers/{nsp_type}/configure Configure NSP element
POST /network/service-providers/{nsp_type}/get Get NSP element by ID
POST /network/service-providers/{nsp_type}/list List NSP elements
POST /network/stats Get network statistics
POST /network/storage-ip-ranges Create storage network IP range
POST /network/storage-ip-ranges/list List storage network IP ranges
POST /network/tag-summary Get tag summary for a zone
POST /network/traffic-types Add traffic type
POST /network/traffic-types/list List traffic types
POST /network/vpc-offerings Ensure (idempotent create) Karios VPC offering
POST /network/vpc-offerings/ensure-for-size Compose (lazy create) a VPC offering for a chosen VR size
POST /network/vpcs Create VPC
POST /network/vpcs/acl-lists Create VPC ACL list
POST /network/vpcs/acl-lists/attach Attach ACL list to tier
POST /network/vpcs/acl-lists/items Create ACL item
POST /network/vpcs/acl-lists/items/list List ACL items
POST /network/vpcs/acl-lists/items/reposition Reposition ACL item by explicit siblings, returns ordered items
POST /network/vpcs/acl-lists/items/shift-position Shift ACL item position one step (up|down), returns ordered items
POST /network/vpcs/acl-lists/list List VPC ACL lists
POST /network/vpcs/list List VPCs
POST /network/vpcs/public-ips/acquire Acquire a public IP for a VPC (CS auto-picks from zone pool)
POST /network/vpcs/tiers Create VPC tier
POST /network/vpcs/{id}/bgp-peers/change Change BGP peers for VPC (atomic bulk apply)
POST /network/vpcs/{id}/private-gateways Create VPC private gateway
POST /network/vpcs/{id}/private-gateways/list List VPC private gateways
POST /network/vpcs/{id}/routers/list List VPC routers (system VMs)
POST /network/vpcs/{id}/routers/{router_id}/reboot Reboot VPC router
POST /network/vpcs/{id}/routers/{router_id}/start Start VPC router
POST /network/vpcs/{id}/routers/{router_id}/stop Stop VPC router
POST /network/vpcs/{id}/routers/{router_id}/usage-history Get VPC router usage history (CPU/Mem/Disk/Net time series)
POST /network/vpcs/{id}/static-routes Create VPC static route
POST /network/vpcs/{id}/static-routes/list List VPC static routes
POST /network/vpcs/{id}/tiers/list List VPC tiers
PUT /network/bgp-peers/{id} Update BGP peer
PUT /network/config/interfaces/{name} Update an interface
PUT /network/config/vlan-interfaces/{name} Update VLAN sub-interface
PUT /network/guest-networks Update a guest network
PUT /network/host-firewall/rules Host firewall: upsert operator rule
PUT /network/internal-lb/rules Update internal LB
PUT /network/load-balancer/health-checks Update health check policy
PUT /network/load-balancer/rules Update load balancer rule
PUT /network/load-balancer/stickiness Update stickiness policy
PUT /network/management-ip-ranges Update management IP range
PUT /network/mtu Declare the cluster's per-role MTU
PUT /network/network-offerings Update network offering
PUT /network/physical-networks Update physical network
PUT /network/port-forwarding Update a port forwarding rule
PUT /network/public-ip-ranges Update VLAN IP range
PUT /network/service-providers Update network service provider
PUT /network/storage-ip-ranges Update storage network IP range
PUT /network/traffic-types Update traffic type
PUT /network/vpcs/acl-lists Update VPC ACL list
PUT /network/vpcs/acl-lists/items Update ACL item
PUT /network/vpcs/{id} Update VPC
PUT /network/vpcs/{id}/restart Restart VPC
PUT /network/vpcs/{id}/tiers/{tier_id} Update VPC tier
PUT /network/vpn-customer-gateways/{cg_id} Update VPN customer gateway
 
/observability
GET /observability/health/metrics Get health metrics
 
/operations
GET /operations Unified operations feed for the notification center
 
/pikvm-inventory
GET /pikvm-inventory/power/sse Monitor PiKVM Power State (SSE)
GET /pikvm-inventory/power/status Get PiKVM power status
POST /pikvm-inventory/provision Full PiKVM Provision Flow
POST /pikvm-inventory/reveal Reveal hardware connected to PiKVM
 
/registration
POST /registration/register Register device from Redfish/BMC data
POST /registration/unregister-device Unregister device from NetBox
 
/storage
GET /storage/host/ceph/disks Get Ceph disks
GET /storage/host/cluster-status Get cluster storage status
GET /storage/host/disks Get physical disk information
GET /storage/host/health Get quick health status
GET /storage/host/metrics Get all storage metrics for the host
GET /storage/host/zfs/arc Get ZFS ARC memory statistics
GET /storage/host/zfs/arc/config Get ZFS ARC configuration
GET /storage/host/zfs/arc/recommendations Get ARC sizing recommendations
GET /storage/host/zfs/arc/stats Get ZFS ARC statistics
GET /storage/host/zfs/cache/status Get all pools cache status
GET /storage/host/zfs/cache/{pool_name}/status Get pool cache device status
GET /storage/host/zfs/datasets/get Get ZFS dataset details
GET /storage/host/zfs/datasets/list List ZFS datasets
GET /storage/host/zfs/datasets/recordsize-presets Get recordsize presets
GET /storage/host/zfs/disks List all disks with partitions and allocation details
GET /storage/host/zfs/pools Get ZFS pool overview
GET /storage/host/zfs/pools/importable List importable pools
GET /storage/host/zfs/pools/list List all ZFS pools
GET /storage/host/zfs/pools/{pool_name} Get ZFS pool details
GET /storage/host/zfs/pools/{pool_name}/iostat Get pool I/O statistics
GET /storage/host/zfs/snapshots/list List ZFS snapshots
GET /storage/object-gateway/enable/jobs/{id} Poll the enable wizard FSM job state
GET /storage/object-gateway/status Object Gateway service status
POST /storage/host/zfs/arc/set-limit Set ZFS ARC memory limit
POST /storage/host/zfs/cache/l2arc/add Add L2ARC device to pool
POST /storage/host/zfs/cache/slog/add Add SLOG device to pool
POST /storage/host/zfs/datasets/create Create a ZFS dataset
POST /storage/host/zfs/datasets/mount Mount a ZFS dataset
POST /storage/host/zfs/datasets/unmount Unmount a ZFS dataset
POST /storage/host/zfs/pools/create Create a ZFS pool
POST /storage/host/zfs/pools/export Export a ZFS pool
POST /storage/host/zfs/pools/import Import a ZFS pool
POST /storage/host/zfs/pools/scrub Start/stop pool scrub
POST /storage/host/zfs/snapshots/clone Clone a ZFS snapshot
POST /storage/host/zfs/snapshots/create Create a ZFS snapshot
POST /storage/imagestore/add Add image store
POST /storage/imagestore/add-s3 Add S3 image store
POST /storage/imagestore/delete Delete image store
POST /storage/imagestore/get/by-id Get image store by ID
POST /storage/imagestore/get/by-name Get image store by name
POST /storage/imagestore/get/id Get image store ID
POST /storage/imagestore/list List image stores
POST /storage/imagestore/migrate Migrate resource to secondary storage
POST /storage/imagestore/migrate-to-objectstore Update cloud to use object store
POST /storage/imagestore/objects/download Download image store object
POST /storage/imagestore/objects/get/by-id Get image store object by ID
POST /storage/imagestore/objects/list List image store objects
POST /storage/imagestore/staging/create Create secondary staging store
POST /storage/imagestore/staging/delete Delete secondary staging store
POST /storage/imagestore/staging/get-id Get secondary staging store ID
POST /storage/imagestore/staging/get/by-id Get secondary staging store by ID
POST /storage/imagestore/staging/get/by-name Get secondary staging store by name
POST /storage/imagestore/staging/list List secondary staging stores
POST /storage/imagestore/update Update image store
POST /storage/object-gateway/disable Disable Object Gateway service
POST /storage/object-gateway/enable Schedule the enable wizard FSM
POST /storage/object-gateway/preflight Run wizard Step 1 preflight probes
POST /storage/object-gateway/preflight/port-check Single-port re-check for the Step 2 form
POST /storage/objectstore/add Add object storage pool
POST /storage/objectstore/buckets/create Create a new bucket
POST /storage/objectstore/buckets/get/by-id Get bucket by ID
POST /storage/objectstore/buckets/get/by-name Get bucket by name
POST /storage/objectstore/buckets/get/id Get bucket ID by name
POST /storage/objectstore/buckets/list List buckets
POST /storage/objectstore/buckets/objects/download Download object from bucket
POST /storage/objectstore/buckets/objects/info Get object metadata
POST /storage/objectstore/buckets/objects/list List objects in bucket
POST /storage/objectstore/buckets/objects/upload Upload object to bucket
POST /storage/objectstore/buckets/update Update a bucket
POST /storage/objectstore/get/by-id Get object storage pool by ID
POST /storage/objectstore/get/by-name Get object storage pool by name
POST /storage/objectstore/list List object storage pools
POST /storage/objectstore/update Update object storage pool
POST /storage/pools/create Create a storage pool
POST /storage/pools/list List storage pools
POST /storage/pools/maintenance/enable Enable storage maintenance
POST /storage/pools/metrics ListStoragePoolsMetrics
POST /storage/pools/metrics/by-id GetStoragePoolsMetricByID
POST /storage/pools/metrics/by-name GetStoragePoolsMetricByName
POST /storage/pools/objects/list List storage pool objects
POST /storage/pools/providers/list ListStorageProviders
POST /storage/pools/scope/affected-vms ListAffectedVms
POST /storage/pools/scope/change ChangeStoragePoolScope
POST /storage/pools/update Update storage pool
POST /storage/snapshots/copy CopySnapshot
POST /storage/snapshots/create Create VM snapshot
POST /storage/snapshots/list List VM snapshots
POST /storage/volumes/get-by-id Get volume by ID
POST /storage/volumes/list List volumes
POST /storage/volumes/metrics-by-id Get volume metrics
POST /storage/volumes/usage-history-by-id Get volume usage history
PUT /storage/host/zfs/datasets/properties Update ZFS dataset properties
PUT /storage/host/zfs/pools/properties Update ZFS pool properties
 
/support
GET /support/bundle/download/{job_id} Download Support Bundle
GET /support/bundle/status/{job_id} Get Support Bundle Status
POST /support/bundle/generate Generate Support Bundle
 
/system
GET /system/{hostname}/hwinventory Get or Forward System Inventory
 
/tags
POST /tags Create resource tags
POST /tags/list List resource tags
POST /tags/storage/getID Get storage tag ID
POST /tags/storage/list List storage tags
 
/tenants
POST /tenants/{id}/account-mode Set tenant account mode
POST /tenants/{id}/auth-source Set tenant auth source
 
/users
GET /users Get users list
GET /users/permissions Get all permissions
GET /users/roles Get roles with permissions
GET /users/tenants List users by tenant
GET /users/{username}/approvers Get available approvers
GET /users/{username}/profile Get user profile
POST /users/mark-registered Register the deployment (first-run NAG)
POST /users/refresh Refresh access token
POST /users/register Register new user
POST /users/reset-password Reset password
POST /users/reset-token Generate password reset OTP
POST /users/roles Create role
POST /users/ssh-keys/create Create SSH key pair
POST /users/ssh-keys/getByID Get SSH key pair by ID
POST /users/ssh-keys/list List SSH key pairs
POST /users/tenants/assign Assign user to tenant
POST /users/userdata/getByID Get user data by ID
POST /users/userdata/list List user data
POST /users/userdata/register Register user data
POST /users/{username}/roles Assign roles to user
PUT /users/roles/{id} Update role
PUT /users/{username} Update user