gns3-server/docs/api/v2/controller/link/projectsprojectidlinks.rst

3.1 KiB

/v2/projects/{project_id}/links

POST /v2/projects/{project_id}/links

Create a new link instance

Parameters

  • project_id: UUID for the project

Response status codes

  • 400: Invalid request
  • 201: Link created

Input

Name Mandatory Type Description
capture_file_name ['string', 'null'] Read only propertie. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only propertie. The full path of the capture file if capture is running
capturing boolean Read only propertie. True if a capture running on the link
link_id string Link identifier
vms array List of the VMS

Output

Name Mandatory Type Description
capture_file_name ['string', 'null'] Read only propertie. The name of the capture file if capture is running
capture_file_path ['string', 'null'] Read only propertie. The full path of the capture file if capture is running
capturing boolean Read only propertie. True if a capture running on the link
link_id string Link identifier
vms array List of the VMS

Sample session

../../../examples/controller_post_projectsprojectidlinks.txt