ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-12-30 09:38:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
e3580d52c3
gns3-server/docs/index.rst
Julien Duponchelle b2ce7ee8d7
API V2
2016-03-07 17:57:12 +01:00

1.0 KiB
Raw Blame History

Welcome to API documentation!

Warning

The API is not stable, feel free to post comments on our website https://gns3.com/

general glossary development

Endpoints

GNS3 expose two type of endpoints:

  • Controller
  • Hypervisor

Controller API Endpoints

The controller manage all the running topologies. The controller has knowledge of everything on in GNS3. If you want to create and manage a topology it's here. The controller will call the hypervisor API when needed.

In a standard GNS3 installation you have one controller and one or many hypervisors.

api/v2/controller/*

Hypervisor API Endpoints

The hypervisor is the GNS3 process running on a server and controlling the VM process.

Warning

Consider this endpoints as a private API used by the controller.

api/v2/hypervisor/*