mirror of https://github.com/GNS3/gns3-server
Julien Duponchelle
9 years ago
parent
08158884a4
commit
ca354ae7f2
@ -0,0 +1,13 @@
|
||||
curl -i -X DELETE 'http://localhost:8000/projects/{project_id}'
|
||||
|
||||
DELETE /projects/{project_id} HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /v1/projects/{project_id}
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X DELETE 'http://localhost:8000/project/{uuid}'
|
||||
|
||||
DELETE /project/{uuid} HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /project/{uuid}
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X DELETE 'http://localhost:8000/virtualbox/{uuid}/ports/{port_id:\d+}/nio'
|
||||
|
||||
DELETE /virtualbox/{uuid}/ports/{port_id:\d+}/nio HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /virtualbox/{uuid}/ports/{port_id:\d+}/nio
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
curl -i -xDELETE 'http://localhost:8000/vpcs/{id:\d+}/ports/{port_id}/nio'
|
||||
|
||||
DELETE /vpcs/{id:\d+}/ports/{port_id}/nio HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 2
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{id:\d+}/ports/{port_id}/nio
|
||||
|
||||
{}
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X DELETE 'http://localhost:8000/vpcs/{uuid}/ports/{port_id:\d+}/nio'
|
||||
|
||||
DELETE /vpcs/{uuid}/ports/{port_id:\d+}/nio HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /vpcs/{uuid}/ports/{port_id:\d+}/nio
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X DELETE 'http://localhost:8000/vpcs/{uuid}/ports/{port_id}/nio'
|
||||
|
||||
DELETE /vpcs/{uuid}/ports/{port_id}/nio HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{uuid}/ports/{port_id}/nio
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
curl -i -xDELETE 'http://localhost:8000/vpcs/{vpcs_id}/ports/{port_id}/nio'
|
||||
|
||||
DELETE /vpcs/{vpcs_id}/ports/{port_id}/nio HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 2
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{vpcs_id}/ports/{port_id}/nio
|
||||
|
||||
{}
|
||||
@ -0,0 +1,19 @@
|
||||
curl -i -X GET 'http://localhost:8000/projects/{project_id}'
|
||||
|
||||
GET /projects/{project_id} HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 108
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /v1/projects/{project_id}
|
||||
|
||||
{
|
||||
"location": "/tmp",
|
||||
"project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f",
|
||||
"temporary": false
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
curl -i -X GET 'http://localhost:8000/project/{uuid}'
|
||||
|
||||
GET /project/{uuid} HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 102
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /project/{uuid}
|
||||
|
||||
{
|
||||
"location": "/tmp",
|
||||
"temporary": false,
|
||||
"uuid": "00010203-0405-0607-0809-0a0b0c0d0e0f"
|
||||
}
|
||||
@ -1,22 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/project' -d '{"location": "/tmp", "uuid": "00010203-0405-0607-0809-0a0b0c0d0e0f"}'
|
||||
|
||||
POST /project HTTP/1.1
|
||||
{
|
||||
"location": "/tmp",
|
||||
"uuid": "00010203-0405-0607-0809-0a0b0c0d0e0f"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 102
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /project
|
||||
|
||||
{
|
||||
"location": "/tmp",
|
||||
"temporary": false,
|
||||
"uuid": "00010203-0405-0607-0809-0a0b0c0d0e0f"
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
curl -i -X POST 'http://localhost:8000/projects/{project_id}/close' -d '{}'
|
||||
|
||||
POST /projects/{project_id}/close HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /v1/projects/{project_id}/close
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
curl -i -X POST 'http://localhost:8000/projects/{project_id}/commit' -d '{}'
|
||||
|
||||
POST /projects/{project_id}/commit HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /v1/projects/{project_id}/commit
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/project/{uuid}/close' -d '{}'
|
||||
|
||||
POST /project/{uuid}/close HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /project/{uuid}/close
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/project/{uuid}/commit' -d '{}'
|
||||
|
||||
POST /project/{uuid}/commit HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /project/{uuid}/commit
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/udp' -d '{}'
|
||||
|
||||
POST /udp HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 201
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 25
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /udp
|
||||
|
||||
{
|
||||
"udp_port": 10000
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/virtualbox/{uuid}/ports/{port_id:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||
|
||||
POST /virtualbox/{uuid}/ports/{port_id:\d+}/nio HTTP/1.1
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 201
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 89
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /virtualbox/{uuid}/ports/{port_id:\d+}/nio
|
||||
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/virtualbox/{uuid}/start' -d '{}'
|
||||
|
||||
POST /virtualbox/{uuid}/start HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /virtualbox/{uuid}/start
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/virtualbox/{uuid}/stop' -d '{}'
|
||||
|
||||
POST /virtualbox/{uuid}/stop HTTP/1.1
|
||||
{}
|
||||
|
||||
|
||||
HTTP/1.1 204
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /virtualbox/{uuid}/stop
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
curl -i -xPOST 'http://localhost:8000/vpcs/{id:\d+}/ports/{port_id}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||
|
||||
POST /vpcs/{id:\d+}/ports/{port_id}/nio HTTP/1.1
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 89
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{id:\d+}/ports/{port_id}/nio
|
||||
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/vpcs/{uuid}/ports/{port_id:\d+}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||
|
||||
POST /vpcs/{uuid}/ports/{port_id:\d+}/nio HTTP/1.1
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 201
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 89
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /vpcs/{uuid}/ports/{port_id:\d+}/nio
|
||||
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
curl -i -X POST 'http://localhost:8000/vpcs/{uuid}/ports/{port_id}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||
|
||||
POST /vpcs/{uuid}/ports/{port_id}/nio HTTP/1.1
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 201
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 89
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{uuid}/ports/{port_id}/nio
|
||||
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
@ -1,28 +0,0 @@
|
||||
curl -i -xPOST 'http://localhost:8000/vpcs/{vpcs_id}/nio' -d '{"id": 42, "nio": {"local_file": "/tmp/test", "remote_file": "/tmp/remote", "type": "nio_unix"}, "port": 0, "port_id": 0}'
|
||||
|
||||
POST /vpcs/{vpcs_id}/nio HTTP/1.1
|
||||
{
|
||||
"id": 42,
|
||||
"nio": {
|
||||
"local_file": "/tmp/test",
|
||||
"remote_file": "/tmp/remote",
|
||||
"type": "nio_unix"
|
||||
},
|
||||
"port": 0,
|
||||
"port_id": 0
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 62
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{vpcs_id}/nio
|
||||
|
||||
{
|
||||
"console": 4242,
|
||||
"name": "PC 2",
|
||||
"vpcs_id": 42
|
||||
}
|
||||
@ -1,25 +0,0 @@
|
||||
curl -i -xPOST 'http://localhost:8000/vpcs/{vpcs_id}/ports/{port_id}/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
|
||||
|
||||
POST /vpcs/{vpcs_id}/ports/{port_id}/nio HTTP/1.1
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: close
|
||||
CONTENT-LENGTH: 89
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 aiohttp/0.13.1
|
||||
X-ROUTE: /vpcs/{vpcs_id}/ports/{port_id}/nio
|
||||
|
||||
{
|
||||
"lport": 4242,
|
||||
"rhost": "127.0.0.1",
|
||||
"rport": 4343,
|
||||
"type": "nio_udp"
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
curl -i -X PUT 'http://localhost:8000/projects/{project_id}' -d '{"temporary": false}'
|
||||
|
||||
PUT /projects/{project_id} HTTP/1.1
|
||||
{
|
||||
"temporary": false
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 164
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /v1/projects/{project_id}
|
||||
|
||||
{
|
||||
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmptf8_s67s",
|
||||
"project_id": "12d03846-c355-4da9-b708-cd45e5d30a50",
|
||||
"temporary": false
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
curl -i -X PUT 'http://localhost:8000/project/{uuid}' -d '{"temporary": false}'
|
||||
|
||||
PUT /project/{uuid} HTTP/1.1
|
||||
{
|
||||
"temporary": false
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 158
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.3.dev1
|
||||
X-ROUTE: /project/{uuid}
|
||||
|
||||
{
|
||||
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmphb8dmyls",
|
||||
"temporary": false,
|
||||
"uuid": "1aa054dd-e672-4961-90c3-fef730fc6301"
|
||||
}
|
||||
@ -1,19 +0,0 @@
|
||||
/interfaces
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /interfaces
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List all the network interfaces available on the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: OK
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/get_interfaces.txt
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
/ports/udp
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /ports/udp
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Allocate an UDP port on the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: UDP port allocated
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_portsudp.txt
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
/project/{uuid}/close
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /project/**{uuid}**/close
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Close project
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Project instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **404**: Project instance doesn't exist
|
||||
- **204**: Project closed
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_projectuuidclose.txt
|
||||
|
||||
@ -1,24 +0,0 @@
|
||||
/project/{uuid}/commit
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /project/**{uuid}**/commit
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Write changes on disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Project instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **404**: Project instance doesn't exist
|
||||
- **204**: Changes write on disk
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_projectuuidcommit.txt
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
/udp
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /udp
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Allocate an UDP port on the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: UDP port allocated
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_udp.txt
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
/v1/interfaces
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v1/interfaces
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List all the network interfaces available on the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: OK
|
||||
|
||||
@ -0,0 +1,13 @@
|
||||
/v1/ports/udp
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/ports/udp
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Allocate an UDP port on the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: UDP port allocated
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
/v1/projects/{project_id}/close
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/close
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Close a project
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **404**: The project doesn't exist
|
||||
- **204**: The project has been closed
|
||||
|
||||
@ -0,0 +1,18 @@
|
||||
/v1/projects/{project_id}/commit
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/commit
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Write changes on disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **404**: The project doesn't exist
|
||||
- **204**: Changes have been written on disk
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
/virtualbox/{uuid}/capture/{adapter_id:\d+}/start
|
||||
---------------------------------------------
|
||||
/v1/virtualbox/{uuid}/capture/{adapter_id:\d+}/start
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/capture/**{adapter_id:\d+}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/virtualbox/**{uuid}**/capture/**{adapter_id:\d+}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
@ -1,10 +1,10 @@
|
||||
/virtualbox/{uuid}/capture/{adapter_id:\d+}/stop
|
||||
---------------------------------------------
|
||||
/v1/virtualbox/{uuid}/capture/{adapter_id:\d+}/stop
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/capture/**{adapter_id:\d+}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/virtualbox/**{uuid}**/capture/**{adapter_id:\d+}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
@ -1,10 +1,10 @@
|
||||
/virtualbox/{uuid}/reload
|
||||
---------------------------------------------
|
||||
/v1/virtualbox/{uuid}/reload
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/virtualbox/**{uuid}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
@ -1,10 +1,10 @@
|
||||
/virtualbox/{uuid}/resume
|
||||
---------------------------------------------
|
||||
/v1/virtualbox/{uuid}/resume
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/virtualbox/**{uuid}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Resume a suspended VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
@ -0,0 +1,19 @@
|
||||
/v1/virtualbox/{uuid}/start
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/virtualbox/**{uuid}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
@ -0,0 +1,19 @@
|
||||
/v1/virtualbox/{uuid}/stop
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/virtualbox/**{uuid}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
/virtualbox/{uuid}/suspend
|
||||
---------------------------------------------
|
||||
/v1/virtualbox/{uuid}/suspend
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/virtualbox/**{uuid}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
@ -0,0 +1,13 @@
|
||||
/v1/virtualbox/vms
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v1/virtualbox/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get all VirtualBox VMs available
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
/vpcs/{uuid}/reload
|
||||
---------------------------------------------
|
||||
/v1/vpcs/{uuid}/reload
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/**{uuid}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/vpcs/**{uuid}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VPCS instance
|
||||
|
||||
Parameters
|
||||
@ -1,10 +1,10 @@
|
||||
/vpcs/{uuid}/start
|
||||
---------------------------------------------
|
||||
/v1/vpcs/{uuid}/start
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/**{uuid}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/vpcs/**{uuid}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VPCS instance
|
||||
|
||||
Parameters
|
||||
@ -1,10 +1,10 @@
|
||||
/vpcs/{uuid}/stop
|
||||
---------------------------------------------
|
||||
/v1/vpcs/{uuid}/stop
|
||||
-----------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/**{uuid}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
POST /v1/vpcs/**{uuid}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VPCS instance
|
||||
|
||||
Parameters
|
||||
@ -1,13 +0,0 @@
|
||||
/virtualbox/list
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /virtualbox/list
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get all VirtualBox VMs available
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
/virtualbox/{uuid}/capture/{port_id:\d+}/start
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/capture/**{port_id:\d+}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port to start a packet capture
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capture_filename</td> <td>✔</td> <td>string</td> <td>Capture file name</td> </tr>
|
||||
</table>
|
||||
|
||||
@ -1,20 +0,0 @@
|
||||
/virtualbox/{uuid}/capture/{port_id:\d+}/stop
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/capture/**{port_id:\d+}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port to stop a packet capture
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
/virtualbox/{uuid}/ports/{port_id:\d+}/nio
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/ports/**{port_id:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_virtualboxuuidportsportiddnio.txt
|
||||
|
||||
|
||||
DELETE /virtualbox/**{uuid}**/ports/**{port_id:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port from where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/delete_virtualboxuuidportsportiddnio.txt
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
/virtualbox/{uuid}/start
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_virtualboxuuidstart.txt
|
||||
|
||||
@ -1,25 +0,0 @@
|
||||
/virtualbox/{uuid}/stop
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /virtualbox/**{uuid}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_virtualboxuuidstop.txt
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
/virtualbox/vms
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /virtualbox/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get all VirtualBox VMs available
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
/vpcs/{uuid}/ports/{port_id:\d+}/nio
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/**{uuid}**/ports/**{port_id:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_vpcsuuidportsportiddnio.txt
|
||||
|
||||
|
||||
DELETE /vpcs/**{uuid}**/ports/**{port_id:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **uuid**: Instance UUID
|
||||
- **port_id**: ID of the port from where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid instance UUID
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/delete_vpcsuuidportsportiddnio.txt
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
/vpcs/{uuid}/ports/{port_id}/nio
|
||||
---------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /vpcs/**{uuid}**/ports/**{port_id}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VPCS
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **port_id**: Id of the port where the nio should be add
|
||||
- **uuid**: VPCS instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid VPCS instance UUID
|
||||
- **201**: NIO created
|
||||
- **404**: VPCS instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/post_vpcsuuidportsportidnio.txt
|
||||
|
||||
|
||||
DELETE /vpcs/**{uuid}**/ports/**{port_id}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VPCS
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **port_id**: ID of the port where the nio should be removed
|
||||
- **uuid**: VPCS instance UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid VPCS instance UUID
|
||||
- **404**: VPCS instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: examples/delete_vpcsuuidportsportidnio.txt
|
||||
|
||||
Loading…
Reference in new issue