Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

API Essentials

API Key Generation





Firewall Rules

Flex Cloud VM Control

Getting Started with Superb Flex Cloud

IP Addresses


Network Interfaces


SSH Keys


Test Route

Troubleshooting API Issues

Viewing Activity Logs

Virtual Server Operating Systems

Virtual Servers

VS Disks

GET /templates

Returns a list of all usable templates

GET /templates/own

Returns templates you are currently using


Response Parameters

allowed_resize_without_reboot – true if resize without reboot is allowed, otherwise false

allowed_hot_migrate – true if hot migration is allowed, otherwise false

allowed_swap – true if swap is allowed, otherwise false

backup_server_id – the ID of the backup server where the template is stored

baremetal_server - true if the baremetal server can be built from this template

cdn – true if this template can be used for building edge servers. Otherwise false.

checksum – file checksum

created_at – the date in the [YYYY][MM][DD]T[hh][mm][ss]Z format

disk_target_device – the prefix indicating the method of translating the disk to a VS by hypervisor

ext4 - true if ext4 file system is supported

file_name – the name of the template file

id – ID of template

initial_password - the password set for the VS built on this template

initial_username - the username set for the VS built on this template

label – the template title

manager_id - ID of the template on the template server

min_disk_size – minimum disk size required to build a VS on this template (GB) 

min_memory_size – minimum memory size required to build a VS on this template (MB)

operating_system – operating system name

operating_system_arch – architecture of the operating system

operating_system_distro – operating system distribution

operating_system_edition – edition of the OS

operating_system_tail – tail of the OS

parent_template_id – true if this is a system template

remote_id - ID of the template, if it came from the market

resize_without_reboot_policy - all specifically tested templates (all newly added templates and some of the most frequently used ones) will have this parameter which indicates the hot resize possibility for a particular template considering its OS version and virtualization type:

	"xen": {
	"centos5": 15,
	"centos6": 15
	"kvm": {
	"centos5": 12,
	"centos6": 12


The indicated integer is a decimal representation of a 4-bit binary code, which indicates whether CPU or RAM can (1) or cannot (0) be resized without reboot, where: 

    • 1st bit defines the ability to increase cpu
    • 2nd bit defines the ability to decrease cpu
    • 3rd bit defines the ability to increase RAM
    • 4th bit defines the ability to decrease RAM

smart_server - true if a smart server can be built from this template

state – state of the template (active, inactive)

template_size-  the size of the template

updated_at — the date when the Network was updated in the [YYYY][MM][DD]T[hh][mm][ss]Z format

user_id - the ID of a user who owns this template

version – version of the file

virtualization – type of virtualization (xen, kvm or kvm_virtio) which is compatible with this template

JSON Request example

 curl -i -X GET -H 'Accept: application/json' -H 'Content-type: application/json' -u user:userpass --url <api_url>/templates.json

JSON Response

        "image_template": {
            "allow_resize_without_reboot": true,
            "allowed_hot_migrate": true,
            "allowed_swap": true,
            "backup_server_id": null,
            "baremetal_server": false,
            "cdn": false,
            "checksum": "ea42c529f195ee767ffc71f2e124b9c3",
            "created_at": "2013-12-18T01:59:27+00:00",
            "disk_target_device": "---\nxen: sda\nkvm: hd\n",
            "ext4": false,
            "file_name": "centos-5.3-lbva_6.11-x64-1.7.tar.gz",
            "id": 10,
            "initial_password": "Password1",
            "initial_username": "root",
            "label": "Load Balancer Virtual Appliance",
            "manager_id": "centos5.3lbva_6.11x64",
            "min_disk_size": 5,
            "min_memory_size": 512,
            "operating_system": "linux",
            "operating_system_arch": "x64",
            "operating_system_distro": "lbva",
            "operating_system_edition": null,
            "operating_system_tail": null,
            "parent_template_id": null,
            "remote_id": null,
            "resize_without_reboot_policy": {},
            "smart_server": false,
            "state": "active",
            "template_size": 762660,
            "updated_at": "2015-07-10T21:35:56+00:00",
            "user_id": null,
            "version": "1.7",
            "virtualization": "xen,kvm"

XML Request example

 curl -i -X GET -H 'Accept: application/xml' -H 'Content-type: application/xml' -u user:userpass --url <api_url>/templates.xml

XML Response example

 <?xml version="1.0" encoding="UTF-8"?>
<image_templates type="array">
<allow_resize_without_reboot type="boolean">false</allow_resize_without_reboot>
<allowed_hot_migrate type="boolean">false</allowed_hot_migrate>
<allowed_swap type="boolean">true</allowed_swap>
<backup_server_id nil="true"/>
<baremetal_server type="boolean">true</baremetal_server>
<cdn type="boolean">false</cdn>
<created_at type="datetime">2012-04-03T14:30:59+00:00</created_at>
<disk_target_device>---xen: xvda kvm: hd</disk_target_device>
<ext4 type="boolean">false</ext4>
<id type="integer">1</id>
<label>CentOS 6.2 x64</label>
<min_disk_size type="integer">5</min_disk_size>
<min_memory_size type="integer">128</min_memory_size>
<operating_system_edition nil="true"/>
<operating_system_tail nil="true"/>
<parent_template_id nil="true"/>
<remote_id nil="true"/>
<smart_server type="boolean">true</smart_server>
<template_size type="integer">271308</template_size>
<updated_at nil="true"/>
<user_id nil="true"/>
  • No labels