API Reference¶
MazeVault REST API Documentation
This section provides comprehensive API documentation for integrating with the MazeVault platform.
In This Section¶
| Document | Description |
|---|---|
| Getting Started | Authentication, base URLs, versioning, rate limits |
| Secrets API | Create, read, update, delete, rotate, and share secrets |
| Certificates API | Certificate lifecycle — request, issue, revoke, renew, import/export |
| Agents API | Agent registration, heartbeat, discovery, and management |
| KeyTab API | Kerberos KeyTab import, discovery, cipher compliance, and lifecycle |
| Tokens API | Externally-issued API tokens — registration, expiry tracking, renewal, and deployment targets |
| Configuration Management API | Managed configuration files, discovery results, configuration templates, and secret naming policy |
| Reports API | Weekly expiry reports — settings, manual trigger, and preview |
| Governance Schema | Governance import schema endpoint and downloadable JSON schema |
API Conventions¶
- All endpoints use JSON for request and response bodies
- Authentication via Bearer token (JWT) or API key
- All timestamps are ISO 8601 UTC
- Pagination uses
pageandper_pagequery parameters - Error responses follow a consistent JSON structure
- API versioned via URL path (
/api/v1/) - Browser sessions of the web interface are not an authentication method for integrations; use Bearer tokens, API keys or API tokens
Interactive API Documentation¶
Every installation serves its own API description:
| URL | Content |
|---|---|
https://<your-mazevault-host>/swagger/index.html |
Swagger UI 5 with "Try it out" |
https://<your-mazevault-host>/swagger/doc.json |
The OpenAPI 3.1 document |
The OpenAPI document types the JSON API. Routes that are not described as typed operations (ACME RFC 8555 including the HTTP-01 challenge, OCSP, SCEP RFC 8894, CRL, certificate export, the agent websocket, binary downloads, health and Swagger itself; 28 in all) are listed in the description of the document. The "Try it out" server comes from SWAGGER_HOST, otherwise from FRONTEND_URL. Set SWAGGER_ENABLED=false to turn the documentation off (see Environment Variables).