mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-04 06:21:15 +02:00
Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630
This commit is contained in:
1 parent
e5950674f8
commit
ff5ba3742e
343 files changed
+12431
-11199
No files matched your search
@@ -13,8 +13,8 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **400**: Invalid request
|
||||
|
||||
Input
|
||||
*******
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
GET /v2/projects/**{project_id}**/nodes/**{node_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a node instance
|
||||
Get a node
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -150,9 +150,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance deleted
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
@@ -14,8 +14,8 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance duplicated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Input
|
||||
|
||||
@@ -14,9 +14,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
@@ -14,9 +14,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
@@ -14,9 +14,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
|
||||
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/files/**{path:.+}**
|
||||
@@ -30,7 +30,7 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -14,7 +14,7 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Disk image resized
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully reloaded
|
||||
|
||||
Output
|
||||
*******
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully started
|
||||
|
||||
Output
|
||||
*******
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully stopped
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully stopped
|
||||
|
||||
Output
|
||||
*******
|
||||
|
||||
@@ -13,9 +13,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: All nodes successfully suspended
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: All nodes successfully suspended
|
||||
|
||||
Output
|
||||
*******
|
||||
|
||||
Reference in new issue
Block a user