VMaintain
Docs
openapi.jsonopenapi.yaml

Changelog

API versioning history and breaking-change notices.

v1.0.0
release
2025-01-15
  • Initial public API release
  • REST endpoints for auth, workspaces, tickets, sites, tasks, clients, monitors, webhooks
  • Bearer token + session cookie authentication
  • Per-user sliding-window rate limiting with response headers
  • OpenAPI 3.1 spec auto-generated from Zod schemas — served at /docs/openapi.json and /docs/openapi.yaml
  • Interactive API explorer via Scalar at /docs/api
  • MCP server at /mcp for Claude, Cursor, and other AI agents
  • Webhook events for 11 platform actions with HMAC-SHA256 signature verification

Versioning policy

All paths are prefixed with /api/v1/. Breaking changes will be introduced as a new version prefix (e.g. /api/v2/) — old versions are deprecated for a minimum of 6 months before removal.