gns3-server/docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst
Julien Duponchelle b2ce7ee8d7
API V2
2016-03-07 17:57:12 +01:00

27 lines
851 B
ReStructuredText

/v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a VirtualBox VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt