/v2/projects/{project_id}/links/{link_id} ------------------------------------------------------------------------------------------------------------------------------------------ .. contents:: 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 ******* .. raw:: html <table> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr> <tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr> <tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr> <tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr> <tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr> <tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr> <tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr> <tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr> <tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr> </table> Sample session *************** .. literalinclude:: ../../../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 ********************** - **400**: Invalid request - **201**: Link updated Input ******* .. raw:: html <table> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr> <tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr> <tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr> <tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr> <tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr> <tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr> <tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr> <tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr> <tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr> </table> Output ******* .. raw:: html <table> <tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr> <tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr> <tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr> <tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr> <tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr> <tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr> <tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr> <tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr> <tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr> <tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr> </table> Sample session *************** .. literalinclude:: ../../../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 ********************** - **400**: Invalid request - **204**: Link deleted Sample session *************** .. literalinclude:: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt