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

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

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

Update a link instance

Parameters

• link_id: Link UUID
• project_id: Project UUID

Response status codes

• 400: Invalid request
• 201: Link updated

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

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

Delete a link instance

Parameters

• link_id: Link UUID
• project_id: Project UUID

Response status codes

• 400: Invalid request
• 204: Link deleted

Sample session

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