ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-12-29 09:08:54 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
e8353e68bb
gns3-server/docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
Julien Duponchelle 73c31b4b87
Update docs
2017-03-21 13:32:04 +01:00

4.2 KiB
Raw Blame History

/v2/projects/{project_id}/links/{link_id}

PUT /v2/projects/{project_id}/links/{link_id}

Update a link instance

Parameters

  • project_id: Project UUID
  • link_id: Link UUID

Response status codes

  • 201: Link updated
  • 400: Invalid request

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
link_type enum Possible values: ethernet, serial
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
link_type enum Possible values: ethernet, serial
nodes ✔ array List of the VMS
project_id string Project UUID

DELETE /v2/projects/{project_id}/links/{link_id}

Delete a link instance

Parameters

  • project_id: Project UUID
  • link_id: Link UUID

Response status codes

  • 204: Link deleted
  • 400: Invalid request

Sample session

../../../examples/controller_delete_projectsprojectidlinkslinkid.txt