Template (O.S.)¶

Entity¶

Template¶

Template resource:

Field	Explanation
id	template identifier
label	template label
backup_id	backup identifier
public	is template public
status	template status
template_size	template size
operating_system	operating system
operating_system_distro	operating system distribution
operating_system_edition	operating system edition
operating_system_arch	operating system architecture
clone_id	UUIDv4 that identifies a unique set of clones

Template resource list:

[template resource 1, template resource 2, …]

Operations¶

Delete template¶

Method: DELETE
Url: /account/<account_id>/template/<template_id>
Success Code: 202
Returned Data: No data returned
Has Token: Yes

Remove a template.

Edit template¶

Method: PUT
Url: /account/<account_id>/template/<template_id>
Success Code: 200
Returned Data: Template resource
Has Token: No

Change template name

With parameters:

label: rename the template

clone_id: unique ID to filter clones

Get template¶

Method: GET
Url: /account/<account_id>/template/<template_id>
Success Code: 200
Returned Data: Template resource
Has Token: No

Get a template resource.

List templates¶

Method: GET
Url: /account/<account_id>/templates
Success Code: 200
Returned Data: Template resource list
Has Token: No

List templates which the user can access.

Filters:

label

public

operating_system

operating_system_distro

operating_system_edition

operating_system_arch

status: (‘inactive’, ‘active’, ‘pending’)

clone_id

Clone template¶

Method: POST
Url: /account/<account_id>/template/<template_id>/clone
Success Code: 202
Returned Data: Template resource
Has Token: Yes

Clone an existing template to the selected user and location

Mandatory parameters:

user_id: User id to which the template will be cloned

location_id: Location id to which the template will be cloned

Rearrange template¶

Method: POST
Url: /account/<account_id>/template/<template_id>/rearrange
Success Code: 202
Returned Data: Template resource
Has Token: Yes

Clone an existing template to given users and locations.