gns3-server/docs/api/vpcsuuid.rst

/vpcs/{uuid}

GET /vpcs/{uuid}

Get a VPCS instance

Parameters

• uuid: Instance UUID

Response status codes

• 200: Success
• 404: Instance doesn't exist

Output

Name	Mandatory	Type	Description
console	✔	integer	console TCP port
name	✔	string	VPCS device name
project_id	✔	string	Project UUID
script_file		['string', 'null']	VPCS startup script
startup_script		['string', 'null']	Content of the VPCS startup script
uuid	✔	string	VPCS device UUID

Sample session

examples/get_vpcsuuid.txt

PUT /vpcs/{uuid}

Update a VPCS instance

Parameters

• uuid: Instance UUID

Response status codes

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

Input

Name	Mandatory	Type	Description
console		['integer', 'null']	console TCP port
name		['string', 'null']	VPCS device name
startup_script		['string', 'null']	Content of the VPCS startup script

Output

Name	Mandatory	Type	Description
console	✔	integer	console TCP port
name	✔	string	VPCS device name
project_id	✔	string	Project UUID
script_file		['string', 'null']	VPCS startup script
startup_script		['string', 'null']	Content of the VPCS startup script
uuid	✔	string	VPCS device UUID

DELETE /vpcs/{uuid}

Delete a VPCS instance

Parameters

• uuid: Instance UUID

Response status codes

• 404: Instance doesn't exist
• 204: Instance deleted