REST API reference
Every operation of the native REST API by tag, the schemas, and the OpenAPI document to download.
The native REST API, version 1.1.1-m10: 414 operations in 28 tags. The pages are generated from the OpenAPI document of the release.
Downloads
Tags
| Tag | Operations | Description |
|---|---|---|
| alarms | 7 | Alarms |
| auth | 13 | Browser login (decision L-113): access token in the body, rotating refresh token in the HttpOnly cookie kyv_refresh (Path=/v1/auth), CSRF double submit with the kyv_csrf cookie and the X-Kyvernon-CSRF header, Origin checks, forced password change and TOTP enrolment, API tokens. See docs/control-plane/SECURITY.md |
| backup | 30 | Consistent backup points, changed-block areas and NBD exports (HX-GT-02); restore-to-new-disk |
| content | 16 | Local content libraries and ISO/OVF items that reference datastore files (Wave C4 thin slice) |
| customization | 5 | |
| datastores | 15 | Datastore files: folders, listing, streamed upload and download (also at /folder, the vSphere-compatible datastore endpoint) |
| events | 3 | Events |
| firewall | 52 | Distributed firewall at the vNIC (docs/network/DFW-HOSTBRIDGE.md, ADR-011) |
| guest | 18 | Guest operations through the guest agent (GuestOperationsManager) |
| hosts | 26 | Host lifecycle (enter/exit maintenance mode) |
| identity | 51 | Login, sessions, users, roles, permissions, audit |
| inventory | 39 | Inventory tree, objects, change feed |
| ip-pools | 18 | Public IP pools on host-bridge networks, address allocation bound to VM NICs, reverse DNS (L-127) |
| licence | 3 | Offline licence entitlements and free-tier limits (decision L-121) |
| metrics | 6 | Performance counters and samples of hosts, VMs and datastores (20 s realtime, 5 min to 1 day rollups) |
| networks | 10 | Host-bridge networks / standard port groups (create, update, delete) |
| nfc | 8 | ImportVApp / ExportVm HttpNfcLease lifecycle and file transfer |
| ovf | 3 | OVF descriptor parse and import-spec planning (ParseDescriptor / CreateImportSpec) |
| plans | 8 | VM plans and the self-service image catalogue (operator-managed) |
| scheduled-tasks | 6 | Scheduled power tasks (Once/Hourly/Daily/Weekly/Monthly*) |
| servers | 14 | Tenant-scoped self-service servers (section 3): create from a plan and a catalogue image, power, reinstall, resize, rescue, password reset, snapshots, console, delete; every operation is a task |
| system | 4 | Health, metrics, service information |
| tasks | 4 | Tasks |
| tenants | 14 | Multi-tenant self-service (docs/cloud/SELF_SERVICE.md section 2): tenants with their folders and pools, quota, suspend/resume/close, tenant users and API tokens, monthly usage |
| traffic | 7 | Monthly traffic per VM and tenant, limits, threshold webhooks, throttling and extra packages (L-127) |
| usage | 2 | Usage ledger for chargeback: vCPU, memory, storage and network per VM, tenant and day |
| vms | 25 | Virtual machine lifecycle (long-running operations) |
| webhooks | 7 | Webhook subscriptions |
Version 0.1.