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

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

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

Get a link instance

Parameters

• project_id: Project UUID
• link_id: Link UUID

Response status codes

• 200: Link found
• 400: Invalid request
• 404: Link doesn't exist

Output

Name	Mandatory	Type	Description
capture_compute_id		['string', 'null']	Read only property. The compute identifier where a capture is running
capture_file_name		['string', 'null']	Read only property. The name of the capture file if a capture is running
capture_file_path		['string', 'null']	Read only property. The full path of the capture file if a capture is running
capturing		boolean	Read only property. True if a capture running on the link
filters		object	Packet filter. This allow to simulate latency and errors
link_id		string	Link UUID
link_style		object	Link line style
link_type		enum	Possible values: ethernet, serial
nodes		array	List of the VMS
project_id		string	Project UUID
suspend		boolean	Suspend the link

Sample session

../../../examples/controller_get_projectsprojectidlinkslinkid.txt

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_compute_id		['string', 'null']	Read only property. The compute identifier where a capture is running
capture_file_name		['string', 'null']	Read only property. The name of the capture file if a capture is running
capture_file_path		['string', 'null']	Read only property. The full path of the capture file if a capture is running
capturing		boolean	Read only property. True if a capture running on the link
filters		object	Packet filter. This allow to simulate latency and errors
link_id		string	Link UUID
link_style		object	Link line style
link_type		enum	Possible values: ethernet, serial
nodes		array	List of the VMS
project_id		string	Project UUID
suspend		boolean	Suspend the link

Output

Name	Mandatory	Type	Description
capture_compute_id		['string', 'null']	Read only property. The compute identifier where a capture is running
capture_file_name		['string', 'null']	Read only property. The name of the capture file if a capture is running
capture_file_path		['string', 'null']	Read only property. The full path of the capture file if a capture is running
capturing		boolean	Read only property. True if a capture running on the link
filters		object	Packet filter. This allow to simulate latency and errors
link_id		string	Link UUID
link_style		object	Link line style
link_type		enum	Possible values: ethernet, serial
nodes		array	List of the VMS
project_id		string	Project UUID
suspend		boolean	Suspend the link

Sample session

../../../examples/controller_put_projectsprojectidlinkslinkid.txt

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