gns3-server/docs/api/v1projectidvirtualboxvmsvmid.rst

/v1/{project_id}/virtualbox/vms/{vm_id}

GET /v1/{project_id}/virtualbox/vms/{vm_id}

Get a VirtualBox VM instance

Parameters

• vm_id: UUID for the instance
• project_id: UUID for the project

Response status codes

• 200: Success
• 400: Invalid request
• 404: Instance doesn't exist

Output

Name	Mandatory	Type	Description
adapter_start_index		integer	adapter index from which to start using adapters
adapter_type		string	VirtualBox adapter type
adapters		integer	number of adapters
console		integer	console TCP port
enable_remote_console		boolean	enable the remote console
headless		boolean	headless mode
name	✔	string	VirtualBox VM instance name
project_id	✔	string	Project UUID
vm_id	✔	string	VirtualBox VM instance UUID
vmname		string	VirtualBox VM name (in VirtualBox itself)

PUT /v1/{project_id}/virtualbox/vms/{vm_id}

Update a VirtualBox VM instance

Parameters

• vm_id: UUID for the instance
• project_id: UUID for the project

Response status codes

• 200: Instance updated
• 400: Invalid request
• 404: Instance doesn't exist
• 409: Conflict

Input

Name	Mandatory	Type	Description
adapter_start_index		integer	adapter index from which to start using adapters
adapter_type		string	VirtualBox adapter type
adapters		integer	number of adapters
console		integer	console TCP port
enable_remote_console		boolean	enable the remote console
headless		boolean	headless mode
name		string	VirtualBox VM instance name
vmname		string	VirtualBox VM name (in VirtualBox itself)

Output

Name	Mandatory	Type	Description
adapter_start_index		integer	adapter index from which to start using adapters
adapter_type		string	VirtualBox adapter type
adapters		integer	number of adapters
console		integer	console TCP port
enable_remote_console		boolean	enable the remote console
headless		boolean	headless mode
name	✔	string	VirtualBox VM instance name
project_id	✔	string	Project UUID
vm_id	✔	string	VirtualBox VM instance UUID
vmname		string	VirtualBox VM name (in VirtualBox itself)

DELETE /v1/{project_id}/virtualbox/vms/{vm_id}

Delete 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 deleted