Skip to content
VEX-NXDocs

Assist and automation

OpenAPI reference

Provide a machine-readable OpenAPI 3 description of core VEX-NX HTTP APIs.

OpenAPI reference (diagram)
OpenAPI reference (diagram)

Goal

Provide a machine-readable OpenAPI 3 description of core VEX-NX HTTP APIs.

Artifact

Download / browse the checked-in specification:

  • openapi.json

This is a curated subset of routes (auth, health, labs, nodes power, images, templates, MCP, assist agent). It is not an exhaustive dump of every internal path. Prefer live discovery (GET /api/v1/mcp/tools, UI network tab) when a path is missing.

How to use

  • Import openapi.json into Postman, Insomnia, or an OpenAPI code generator
  • Replace the server URL with http://<appliance-ip> or https://<appliance-ip>
  • Use POST /api/v1/auth/login then the Authorization: Bearer <token> security scheme
  • Never commit real tokens into generated clients checked into public repos
  • REST API overview
  • MCP and AI tools