gns3-server/docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst

27 lines
779 B
ReStructuredText
Raw Normal View History

/v1/projects/{project_id}/virtualbox/vms/{vm_id}/stop
----------------------------------------------------------------------------------------------------------------------
2015-02-04 17:48:33 -07:00
.. contents::
POST /v1/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2015-02-04 17:48:33 -07:00
Stop a VirtualBox VM instance
Parameters
**********
2015-04-07 16:09:27 +02:00
- **vm_id**: UUID for the instance
2015-05-01 11:20:55 +02:00
- **project_id**: UUID for the project
2015-02-04 17:48:33 -07:00
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
2015-02-24 11:38:57 +01:00
Sample session
***************
.. literalinclude:: ../../examples/post_projectsprojectidvirtualboxvmsvmidstop.txt