Skip to content

Patcher API Documentation¶

Table of Contents¶

  1. Getting Started
  2. Uploading Releases
  3. Checking for Updates
  4. Channels & Publishing
  5. API Reference
  6. GitHub Actions Integration

What is the Patcher API?¶

The Patcher API is a complete software update distribution system that allows developers to:

  • Upload new versions of their applications
  • Manage multiple release channels (production, beta, dev)
  • Distribute updates to end-users automatically
  • Control how updates are installed and displayed

Key Features¶

🚀 Large File Support¶

Upload files of any size (GBs) using presigned S3 URLs. No more 6MB limits.

📦 Multi-Channel Distribution¶

Release to different audiences: - Production: Stable releases for all users - Beta: Testing versions for early adopters - Dev/Alpha: Nightly builds for developers

🎯 Granular Control¶

Control every aspect of the update process: - Install Action: How to process the download (unzip, execute, etc.) - Update Action: How to apply the update (replace, clean_install, etc.) - Display Mode: UI behavior (active, passive, silent) - Latest Flag: Explicitly pin a version as "current"

🔒 Secure & Authenticated¶

All API calls require authentication via API keys registered in the system.

  • Base URL: https://apis.novasuite.one/api/patcher
  • Example Workflows: See example_full_workflow.yml in the repository
  • Test Script: Use test-patcher.ps1 to verify your setup

Support¶

For questions or issues, contact: - Email: support@novasuite.one - Website: https://novasuite.one/help