gns3-server/docs/api/v2/controller/appliance/appliances.rst

/v2/appliances

POST /v2/appliances

Create a new appliance

Response status codes

• 201: Appliance created
• 400: Invalid request

Input

Name	Mandatory	Type	Description
appliance_id		string	Appliance UUID from which the node has been created. Read only
appliance_type	✔	enum	Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin		boolean	Appliance is builtin
category			Appliance category
compute_id	✔	string	Compute identifier
default_name_format		string	Default name format
name	✔	string	Appliance name
symbol		string	Symbol of the appliance

Output

Name	Mandatory	Type	Description
appliance_id	✔	string	Appliance UUID from which the node has been created. Read only
appliance_type	✔	enum	Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin	✔	boolean	Appliance is builtin
category	✔		Appliance category
compute_id	✔	string	Compute identifier
default_name_format	✔	string	Default name format
name	✔	string	Appliance name
symbol	✔	string	Symbol of the appliance

Sample session

../../../examples/controller_post_appliances.txt

GET /v2/appliances

List of appliance

Response status codes

• 200: Appliance list returned

Sample session

../../../examples/controller_get_appliances.txt