two/docs/exploitation/api-agent/index.rst
GnomeZworc cb904c4744
docs: premiere creation de documentation
Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
2026-08-26 23:41:50 +02:00

21 lines
702 B
ReStructuredText

API de l'agent
==============
L'agent expose une API HTTP par hyperviseur. C'est aujourd'hui la seule API de ``two`` ; les
API de niveau supérieur viendront avec les composants d'orchestration, et seront documentées
à part.
Elle est **machine-to-machine** : elle est consommée par un autre logiciel, pas par un humain.
La validation de cohérence des entrées (format des CIDR, plage des VXLAN ID, convention de
nommage) est à la charge de l'appelant — l'agent ne la refait pas.
.. warning::
Cette API **n'a aucune authentification**. Voir :doc:`/exploitation/configuration` avant de
l'exposer au-delà de la boucle locale.
.. toctree::
:maxdepth: 1
asynchronisme
reference