gns3-server/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst

27 lines
836 B
ReStructuredText
Raw Normal View History

/v2/compute/projects/{project_id}/virtualbox/nodes/{node_id}/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/virtualbox/nodes/**{node_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a VirtualBox VM instance
Parameters
**********
2016-09-27 15:15:40 +00:00
- **node_id**: Node UUID
2016-11-03 17:20:51 +00:00
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxnodesnodeidstop.txt