Gandi

Table Of Contents

Previous topic

Datacenter API Reference

Next topic

Disk API Reference

Disk Image API Reference

Methods

hosting.image.info(apikey, image)

Get information about a disk image.

Parameters:
  • apikey (string) – API connection key
  • image (int) – disk image unique identifier
Returns:

struct – disk image information

hosting.image.list(apikey[, opts=nil])

List available disk images.

Parameters:
Returns:

list of struct – list of images

Parameters

Image

parameter of hosting.image.info() and image.info()

ImageArch

used by ImageListOptions and ImageReturn

Name Description
x86-32 32-bit processor using x86 instruction set.
x86-64 64-bit processor using x86 instruction set.
ImageListOptions

parameter of hosting.image.list() and image.list()

Name Default Type Mandatory
datacenter_id   int no
id of the datacenter where the image is available
items_per_page 100 int no
number of items returned for the pagination
label   string no
name of the image
os_arch   string no
Supported Processor Architecture for the Operating System
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: datacenter_id, label, os_arch, system, visibility
system   string no
visibility   string no
all, beta, deprecated
ImageVisibility

used by ImageListOptions and ImageReturn

Name Description
all Those images will reviced regular update
beta Those images are in beta will be ‘all’ after some time
deprecated Those images don’t reviced any update
OperatingSystem

used by ImageListOptions and ImageReturn

Name Description
Debian -
Ubuntu -
CentOS -
FreeBSD -
Other -

Returns

ImageReturn

returned by hosting.image.info(), hosting.image.list(), image.info() and image.list()

Changed in version 3.3.34: key add has changed.
add system and version fields.

Name Type
author_id int
datacenter_id int
id of the datacenter where the image is available
date_created dateTime.iso8601
date_updated dateTime.iso8601
disk_id int
id of the disk where the image is available
id int
unique identifier of the image
kernel_version string
version of the operating system kernel
label string
name of the image
os_arch string
target cpu architecture of the image
size int
disk size of the image in megabytes
system string
System type of the system
version string
string corresponding to the version of the system
visibility string
all, beta, deprecated