gns3-server/docs/api/v2/controller/template/templatestemplateid.rst

/v2/templates/{template_id}

GET /v2/templates/{template_id}

Get an template

Response status codes

• 200: Template found
• 400: Invalid request
• 404: Template doesn't exist

Output

Name	Mandatory	Type	Description
builtin	✔	boolean	Template is builtin
category	✔		Template category
compute_id	✔	['null', 'string']	Compute identifier
default_name_format	✔	string	Default name format
name	✔	string	Template name
symbol	✔	string	Symbol of the template
template_id	✔	string	Template UUID
template_type	✔	enum	Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu

Sample session

../../../examples/controller_get_templatestemplateid.txt

PUT /v2/templates/{template_id}

Update an template

Response status codes

• 200: Template updated
• 400: Invalid request
• 404: Template doesn't exist

Input

Name	Mandatory	Type	Description
builtin		boolean	Template is builtin
category			Template category
compute_id		['null', 'string']	Compute identifier
default_name_format		string	Default name format
name		string	Template name
symbol		string	Symbol of the template
template_id		string	Template UUID
template_type		enum	Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu

Output

Name	Mandatory	Type	Description
builtin	✔	boolean	Template is builtin
category	✔		Template category
compute_id	✔	['null', 'string']	Compute identifier
default_name_format	✔	string	Default name format
name	✔	string	Template name
symbol	✔	string	Symbol of the template
template_id	✔	string	Template UUID
template_type	✔	enum	Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu

Sample session

../../../examples/controller_put_templatestemplateid.txt

DELETE /v2/templates/{template_id}

Delete an template

Parameters

• template_id: template UUID

Response status codes

• 204: Template deleted
• 400: Invalid request
• 404: Template doesn't exist

Sample session

../../../examples/controller_delete_templatestemplateid.txt