Virtualmin Remote API

HTTP-based Remote API served from Webmin's remote.cgi on port 10000. Each call passes a `program` parameter naming one of ~200 command-line programs (create-domain, list-domains, create-user, create-alias, create-database, generate-letsencrypt-cert, backup-domain, etc.) plus that program's parameters as CGI query/POST params. Authentication is HTTP Basic as the Webmin master administrator. Output is plain text with an exit-status line, or JSON (json=1), XML (xml=1) or Perl (perl=1); list-* programs accept multiline for detailed output. The API is self-hosted per Virtualmin installation.

API entry from apis.yml

apis.yml Raw ↑
name: Virtualmin Remote API
description: HTTP-based Remote API served from Webmin's remote.cgi on port 10000. Each call passes a `program`
  parameter naming one of ~200 command-line programs (create-domain, list-domains, create-user, create-alias,
  create-database, generate-letsencrypt-cert, backup-domain, etc.) plus that program's parameters as CGI
  query/POST params. Authentication is HTTP Basic as the Webmin master administrator. Output is plain
  text with an exit-status line, or JSON (json=1), XML (xml=1) or Perl (perl=1); list-* programs accept
  multiline for detailed output. The API is self-hosted per Virtualmin installation.
humanURL: https://www.virtualmin.com/docs/development/remote-api/
baseURL: https://yourserver:10000/virtual-server/remote.cgi
tags:
- Web Hosting
- Server Management
- Automation
properties:
- type: Documentation
  url: https://www.virtualmin.com/docs/development/remote-api/
- type: APIReference
  url: https://www.virtualmin.com/docs/development/api-programs/