API Reference
The Karios Core API is served under /api/v2. It is described by an OpenAPI
specification generated from the backend source and enriched with hand-written
examples maintained in api/examples/.
Get the raw specification
The full OpenAPI specification is served at a stable URL for anyone generating their own client:
Karios Core (734 operations across 94 tags): https://docs.karios.com/_static/api-specs/karios-core.yaml
The specification is refreshed on every doc-site build, so the version served matches the tag pages below.
By tag
The pages below are generated into this site and are covered by the documentation search.
- Agent Health
- Alerts
- audit
- AutoScale
- BGP
- bmc-lock
- bridges
- Chargeback
- Clusters
- Configuration
- configure
- control node
- Dashboard
- DDI-DHCP
- DDI-DNS
- DDI-PublicIP
- dell-inventory
- dell-jobs
- Discovery
- Disk Offerings
- Events
- Firewall Rules
- FRR
- FRR BFD
- FRR BGP
- FRR EVPN
- FRR OSPF
- FRR Status
- GPU
- Health Monitoring
- Host Firewall
- Hosts
- hpe-inventory
- Images
- Instance Groups
- Internal Load Balancer
- inventory
- IPAM
- IPAM Dashboard
- K-Lens
- Load Balancer
- Management IP Ranges
- Management Servers
- Monitoring
- netinfra-registry
- Netinfra Routing
- network
- Network Configuration
- Network Discovery
- Network Offerings
- Network Service Providers
- Networks
- Node Health
- Object Gateway
- Observability
- Onboarding
- operations
- Permission Management
- Physical Networks
- pikvm
- Pods
- Port Forwarding
- Public IP Addresses
- Registration
- Resource Tags
- Role Management
- Service Offerings
- Snapshots
- SSH Keys
- Storage
- Storage Benchmark
- Storage Host
- Storage Host ZFS
- Storage Networks
- Storage Pools
- Storage Tags
- Support
- system-inventory
- SystemVMs
- Tenant Management
- Traffic Types
- Untagged
- User Authentication
- User Data
- User Management
- Virtual Machines
- VirtualRouter
- VLAN
- VLAN IP Ranges
- Volumes
- VPC
- VPN
- VR Offerings
- Zones
Regenerating
These pages are build output. To refresh them after a backend change:
./api/scripts/sync-specs.sh karios-core /path/to/karios-core
python3 api/scripts/inject_examples.py karios-core
python3 api/scripts/build_sphinx_pages.py karios-core
See api/README.md for the full pipeline, including how to add an example.