Referenční příručka API¶
Dokumentace REST API platformy MazeVault
Tato sekce poskytuje komplexní dokumentaci API pro integraci s platformou MazeVault.
V této sekci¶
| Dokument | Popis |
|---|---|
| Začínáme | Autentizace, základní URL, verzování, limity požadavků |
| API pro tajemství | Vytváření, čtení, aktualizace, mazání, rotace a sdílení tajemství |
| API pro certifikáty | Životní cyklus certifikátů — žádost, vydání, odvolání, obnovení, import/export |
| API pro agenty | Registrace agentů, heartbeat, discovery a správa |
| API pro KeyTab | Import Kerberos KeyTab, discovery, soulad šifer a životní cyklus |
| API pro tokeny | Externě vydané API tokeny — evidence, sledování exspirace, obnova a cíle nasazení |
| API pro správu konfigurací | Spravované konfigurační soubory, výsledky discovery, konfigurační šablony a politika pojmenování tajemství |
| API pro reporty | Týdenní reporty o exspiraci — nastavení, ruční spuštění a náhled |
Konvence API¶
- Všechny endpointy používají JSON pro těla požadavků a odpovědí
- Autentizace pomocí Bearer tokenu (JWT) nebo API klíče
- Všechny časové značky jsou ve formátu ISO 8601 UTC
- Stránkování využívá parametry
pageaper_page - Chybové odpovědi mají jednotnou JSON strukturu
- Verzování API je určeno cestou v URL (
/api/v1/) - Relace prohlížeče webového rozhraní nejsou autentizační metodou pro integrace; používejte tokeny Bearer, API klíče nebo API tokeny
Interaktivní dokumentace API¶
Každá instalace servíruje vlastní popis API:
| URL | Obsah |
|---|---|
https://<your-mazevault-host>/swagger/index.html |
Swagger UI 5 s funkcí „Try it out“ |
https://<your-mazevault-host>/swagger/doc.json |
Dokument OpenAPI 3.1 |
Dokument OpenAPI popisuje typovaně JSON API. Trasy, které nejsou popsány jako typované operace (ACME RFC 8555 včetně výzvy HTTP-01, OCSP, SCEP RFC 8894, CRL, export certifikátu, websocket agenta, binární soubory ke stažení, health a samotný Swagger; celkem 28), jsou vypsány v description dokumentu. Server pro „Try it out“ pochází z SWAGGER_HOST, jinak z FRONTEND_URL. Dokumentaci vypnete nastavením SWAGGER_ENABLED=false (viz Proměnné prostředí).