gns3-server/docs/index.rst
2016-06-14 10:36:54 +02:00

1.1 KiB

Welcome to API documentation!

Warning

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

Warning

This documentation are for developers for user documentation go to https://gns3.com/

general glossary development file_format

Endpoints

GNS3 expose two type of endpoints:

  • Controller
  • Compute

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 compute API when needed.

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

api/v2/controller/*

Compute API Endpoints

The compute 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/compute/*