API Reference

The Hyperweaver Server API provides comprehensive RESTful endpoints for user management, organization control, and server configuration. This API handles authentication, authorization, and configuration management for the Hyperweaver Server web interface.

Table of contents

  1. TOC

Authentication

All API endpoints require authentication using JWT tokens in the Bearer token format:

Authorization: Bearer <jwt_token>

See the Authentication Guide for detailed setup instructions.

Base URL

The API is served from your Hyperweaver Server frontend server:

  • HTTPS (Recommended): https://your-server:3443
  • HTTP: http://your-server:3443

OpenAPI Specification

The Hyperweaver Server API is fully documented using OpenAPI 3.0 specification.

Interactive Documentation

API Categories

The Hyperweaver Server API is organized into the following categories:

Authentication & Authorization

  • User registration and login
  • JWT token management
  • Session management
  • Password reset and recovery

User Management

  • User profile management
  • User preferences and settings
  • Account administration
  • Role-based access control

Organization Management

  • Organization creation and configuration
  • Multi-tenant organization support
  • User-organization relationships
  • Invitation management

Server Configuration

  • Zoneweaver Agent server management
  • Connection configuration and testing
  • Server health monitoring
  • API endpoint management

Settings & Configuration

  • Application settings management
  • Email configuration
  • Security settings
  • System preferences

Rate Limiting

The API currently does not implement rate limiting, but this may be added in future versions for production deployments.

Error Handling

The API uses standard HTTP status codes and returns JSON error responses:

{
  "success": false,
  "message": "Error description"
}

Common status codes:

  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized (Invalid or expired JWT token)
  • 403 - Forbidden (Insufficient permissions)
  • 404 - Not Found
  • 500 - Internal Server Error

Response Format

Successful responses follow this format:

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}