Navigation

  • index
  • next |
  • previous |
  • GNS3 2.0.1 documentation »
  • Endpoints »
  • Link »

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

Contents

  • /v2/projects/{project_id}/links/{link_id}
    • PUT /v2/projects/{project_id}/links/{link_id}
      • Parameters
      • Response status codes
      • Input
      • Output
    • DELETE /v2/projects/{project_id}/links/{link_id}
      • Parameters
      • Response status codes
      • Sample session

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¶

curl -i -X DELETE 'http://localhost:3080/v2/projects/42a1b682-b5bf-4de4-b5af-5366fc20a111/links/105966d0-8a04-4cf5-95a4-ff13f1de7660'

DELETE /v2/projects/42a1b682-b5bf-4de4-b5af-5366fc20a111/links/105966d0-8a04-4cf5-95a4-ff13f1de7660 HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 21 Mar 2017 09:31:58 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/projects/{project_id}/links/{link_id}

Quick search

Navigation

  • index
  • next |
  • previous |
  • GNS3 2.0.1 documentation »
  • Endpoints »
  • Link »
© Copyright 2015, GNS3 GNS3 Technologies Inc.. Created using Sphinx 1.5.6.