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 |
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/)