1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-26 16:58:28 +00:00
gns3-server/docs/index.rst

55 lines
1016 B
ReStructuredText
Raw Normal View History

2015-01-14 00:05:26 +00:00
Welcome to API documentation!
======================================
.. WARNING::
2015-12-10 22:00:16 +00:00
The API is not stable, feel free to post comments on our website
https://gns3.com/
2015-01-14 00:05:26 +00:00
.. toctree::
general
2015-02-18 10:06:13 +00:00
glossary
2015-01-14 00:05:26 +00:00
development
Endpoints
------------
GNS3 expose two type of endpoints:
* Controller
2016-04-18 18:55:22 +00:00
* Compute
2016-03-04 16:50:17 +00:00
Controller API Endpoints
~~~~~~~~~~~~~~~~~~~~~~~~
2015-01-14 00:05:26 +00:00
The controller manage all the running topologies. The controller
has knowledge of everything on in GNS3. If you want to create and
2016-04-18 18:55:22 +00:00
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
2016-04-18 18:55:22 +00:00
computes.
2016-03-04 16:50:17 +00:00
.. toctree::
:glob:
:maxdepth: 2
2016-03-07 16:57:12 +00:00
api/v2/controller/*
2016-03-04 16:50:17 +00:00
2016-04-18 18:55:22 +00:00
Compute API Endpoints
~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-04-18 18:55:22 +00:00
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.
2015-01-14 00:05:26 +00:00
.. toctree::
:glob:
:maxdepth: 2
2016-04-18 18:55:22 +00:00
api/v2/compute/*
2015-01-14 00:05:26 +00:00