mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-12-23 06:32:26 +00:00
3.8 KiB
3.8 KiB
/v2/projects/{project_id}/links
GET /v2/projects/{project_id}/links
List links of a project
Parameters
- project_id: Project UUID
Response status codes
- 200: List of links returned
Sample session
../../../examples/controller_get_projectsprojectidlinks.txt
POST /v2/projects/{project_id}/links
Create a new link instance
Parameters
- project_id: Project UUID
Response status codes
- 400: Invalid request
- 201: Link created
Input
| Name | Mandatory | Type | Description |
|---|---|---|---|
| capture_file_name | ['string', 'null'] | Read only property. The name of the capture file if capture is running | |
| capture_file_path | ['string', 'null'] | Read only property. The full path of the capture file if capture is running | |
| capturing | boolean | Read only property. True if a capture running on the link | |
| link_id | string | Link UUID | |
| nodes | ✔ | array | List of the VMS |
| project_id | string | Project UUID |
Output
| Name | Mandatory | Type | Description |
|---|---|---|---|
| capture_file_name | ['string', 'null'] | Read only property. The name of the capture file if capture is running | |
| capture_file_path | ['string', 'null'] | Read only property. The full path of the capture file if capture is running | |
| capturing | boolean | Read only property. True if a capture running on the link | |
| link_id | string | Link UUID | |
| nodes | ✔ | array | List of the VMS |
| project_id | string | Project UUID |
Sample session
../../../examples/controller_post_projectsprojectidlinks.txt