Guides
Step-by-step walkthroughs for the most common integration patterns.
Your first API request
Authenticate, list workspaces, and create your first ticket in under 5 minutes.
- 1
POST /api/v1/auth/login with your email and password - 2
Copy the token from the response - 3
GET /api/v1/workspaces to find your workspace ID - 4
POST /api/v1/tickets to create a ticket
Listen for events with webhooks
Register a webhook and receive live notifications when tickets and monitors change.
- 1
Expose a public HTTPS endpoint on your server - 2
POST /api/v1/webhooks to register the URL and choose events - 3
Verify the X-VMaintain-Signature header on each delivery - 4
Handle the JSON payload — all events share the same envelope shape
Use VMaintain with Claude
Add the MCP server to Claude Desktop so Claude can read and update your workspace.
- 1
Open ~/Library/Application Support/Claude/claude_desktop_config.json - 2
Add the vmaintain MCP server entry (see MCP docs) - 3
Restart Claude Desktop - 4
Ask Claude to list open tickets or create a new one
Generate a TypeScript SDK
Download the OpenAPI spec and generate a fully typed client.
- 1
curl -o openapi.json https://your-domain.com/docs/openapi.json - 2
npx @openapitools/openapi-generator-cli generate -i openapi.json -g typescript-fetch -o ./sdk - 3
Import and configure the generated ApiClient - 4
All requests and responses are fully typed from the spec
Need help?
Open the interactive API explorer to run live requests against the API without writing any code.