/v2/projects/{project_id}/links
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/links
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List links of a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: List of links returned
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinks.txt
POST /v2/projects/**{project_id}**/links
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new link instance
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Link created
Input
*******
.. raw:: html
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
*******
.. raw:: html
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 |
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinks.txt