ZoneweaverAPI Documentation

Node.js API backend for Zoneweaverzone hypervisor management. Provides RESTful API for managing Bhyve virtual machines, networking, storage, and system monitoring on OmniOS/illumos.

Get started now View API Reference View on GitHub

Getting started

ZoneweaverAPI is the backend component of the Zoneweaverzone management system. It provides a comprehensive RESTful API for managing Bhyve virtual machines, networking, storage, and system monitoring on OmniOS/illumos systems.

Key Features

Zone Management: Complete lifecycle management of Bhyve zones
Network Management: VLAN, VNIC, and etherstub configuration
Storage Management: ZFS dataset and pool management
VNC Console Access: Web-based console access to zones
API Key Authentication: Secure API access with bearer tokens
Real-time Monitoring: System metrics and zone status monitoring
Package Management: Automated provisioning and updates

Architecture

graph TD
    A[ZoneweaverFrontend] -- HTTPS/HTTP API Calls --> B[Zoneweaver API on OmniOS Host];
    B -- Manages --> C[Bhyve Zones / Virtual Machines];
    B -- Monitors --> D[OmniOS Host System];

Quick start

Installation: Install via OmniOS package or build from source
Configuration: Configure settings in /etc/zoneweaver-api/config.yaml
API Key: Generate API key via bootstrap endpoint or configuration
Integration: Connect your frontend or tools using the RESTful API

API Documentation

The ZoneweaverAPI provides comprehensive OpenAPI 3.0 documentation:

Interactive API Reference - Complete API reference with examples
Getting Started Guide - Step-by-step setup instructions
Authentication Guide - API key setup and usage
Configuration Reference - Complete configuration options

About the project

License

ZoneweaverAPI is distributed by an GPL-3.0 license.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in our GitHub repo.

Thank you to the contributors of ZoneweaverAPI!

Code of Conduct

ZoneweaverAPI is committed to fostering a welcoming community.

View our Code of Conduct on our GitHub repository.