NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove /controller from the api endpoint

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-03-11 17:16:09 +01:00
1 parent e3580d52c3
commit 8c1560332e
107 files changed
+356 -310
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/hypervisor/s.rst
+2 -2
View File
@@ -1,9 +1,9 @@
/v2/controller/hypervisors
/v2/hypervisors
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/hypervisors
POST /v2/hypervisors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Register a hypervisor
docs/api/v2/controller/hypervisor/sshutdown.rst
+2 -2
View File
@@ -1,9 +1,9 @@
/v2/controller/hypervisors/shutdown
/v2/hypervisors/shutdown
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/hypervisors/shutdown
POST /v2/hypervisors/shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Shutdown the local hypervisor
docs/api/v2/controller/link.rst
+8
View File
@@ -0,0 +1,8 @@
Link
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
link/*
docs/api/v2/controller/link/projectsprojectidlinks.rst
+38
View File
@@ -0,0 +1,38 @@
/v2/projects/{project_id}/links
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/links
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new link instance
Parameters
**********
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Link created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
<tr><td>vms</td> <td>&#10004;</td> <td>array</td> <td>List of the VMS</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
<tr><td>vms</td> <td>&#10004;</td> <td>array</td> <td>List of the VMS</td> </tr>
</table>
docs/api/v2/controller/project/projects.rst
+2 -8
View File
@@ -1,9 +1,9 @@
/v2/controller/projects
/v2/projects
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects
POST /v2/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new project on the server
@@ -36,9 +36,3 @@ Output
<tr><td>temporary</td> <td>&#10004;</td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projects.txt
docs/api/v2/controller/project/projectsprojectid.rst
+2 -8
View File
@@ -1,9 +1,9 @@
/v2/controller/projects/{project_id}
/v2/projects/{project_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v2/controller/projects/**{project_id}**
DELETE /v2/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk
@@ -16,9 +16,3 @@ Response status codes
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
docs/api/v2/controller/project/projectsprojectidclose.rst
+2 -8
View File
@@ -1,9 +1,9 @@
/v2/controller/projects/{project_id}/close
/v2/projects/{project_id}/close
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/close
POST /v2/projects/**{project_id}**/close
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Close a project
@@ -16,9 +16,3 @@ Response status codes
- **404**: The project doesn't exist
- **204**: The project has been closed
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
docs/api/v2/controller/project/projectsprojectidcommit.rst
+2 -8
View File
@@ -1,9 +1,9 @@
/v2/controller/projects/{project_id}/commit
/v2/projects/{project_id}/commit
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/commit
POST /v2/projects/**{project_id}**/commit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write changes on disk
@@ -16,9 +16,3 @@ Response status codes
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidcommit.txt
docs/api/v2/controller/version/version.rst
+3 -15
View File
@@ -1,9 +1,9 @@
/v2/controller/version
/v2/version
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/controller/version
GET /v2/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the server version number
@@ -21,14 +21,8 @@ Output
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number human readable</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_version.txt
POST /v2/controller/version
POST /v2/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Check if version is the same as the server
@@ -57,9 +51,3 @@ Output
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number human readable</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_version.txt
docs/api/v2/controller/vm/projectsprojectidvms.rst
+2 -8
View File
@@ -1,9 +1,9 @@
/v2/controller/projects/{project_id}/vms
/v2/projects/{project_id}/vms
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/vms
POST /v2/projects/**{project_id}**/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VM instance
@@ -48,9 +48,3 @@ Output
<tr><td>vm_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvms.txt
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Delete a Docker container
Parameters
**********
- **project_id**: UUID for the project
- **id**: ID for the container
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **id**: ID of the container
- **port_number**: Port on the adapter
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Docker container
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **id**: ID of the container
- **port_number**: Port on the adapter
Response status codes
**********************
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
Response status codes
**********************
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter from where the nio should be removed
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
Response status codes
**********************
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
Response status codes
**********************
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a IOU instance
Parameters
**********
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port where the nio should be added
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
Parameters
**********
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port from where the nio should be removed
Response status codes
**********************
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
Response status codes
**********************
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter from where the nio should be removed
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -27,10 +27,10 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter from where the nio should be removed
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to start a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **adapter_number**: Adapter to stop a packet capture
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port where the nio should be added
Response status codes
**********************
@@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
- **adapter_number**: Network adapter where the nio is located
- **vm_id**: UUID for the instance
- **port_number**: Port from where the nio should be removed
Response status codes
**********************