gns3-server/docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst

/v1/projects/{project_id}/vpcs/vms/{vm_id}

GET /v1/projects/{project_id}/vpcs/vms/{vm_id}

Get a VPCS 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
console	✔	integer	console TCP port
name	✔	string	VPCS VM name
project_id	✔	string	Project UUID
startup_script		['string', 'null']	Content of the VPCS startup script
startup_script_path	✔	['string', 'null']	Path of the VPCS startup script relative to project directory
status	✔	enum	Possible values: started, stopped
vm_id	✔	string	VPCS VM UUID

Sample session

../../examples/get_projectsprojectidvpcsvmsvmid.txt

PUT /v1/projects/{project_id}/vpcs/vms/{vm_id}

Update a VPCS 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
console		['integer', 'null']	console TCP port
name		['string', 'null']	VPCS VM name
startup_script		['string', 'null']	Content of the VPCS startup script

Output

Name	Mandatory	Type	Description
console	✔	integer	console TCP port
name	✔	string	VPCS VM name
project_id	✔	string	Project UUID
startup_script		['string', 'null']	Content of the VPCS startup script
startup_script_path	✔	['string', 'null']	Path of the VPCS startup script relative to project directory
status	✔	enum	Possible values: started, stopped
vm_id	✔	string	VPCS VM UUID

Sample session

../../examples/put_projectsprojectidvpcsvmsvmid.txt

DELETE /v1/projects/{project_id}/vpcs/vms/{vm_id}

Delete a VPCS 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

Sample session

../../examples/delete_projectsprojectidvpcsvmsvmid.txt