Skip to content

os_template

Manage OS templates

Create

Path
POST /v7.0/os_templates
Description
Authentication required
yes
Scope
os_template#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
os_template
ParameterTypeRequiredDetails
os_family
OS family
 Resource yes
label
Label
 String yes

Human-friendly label

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
info
Info
 Text no

Information about template

Default: null
enabled
Enabled
 Boolean no

Enable/disable template usage

Default: null
supported
Supported
 Boolean no

Is template known to work?

Default: null
order
Order
 Integer no

Template order

Default: null
hypervisor_type
Hypervisor_type
 String no

Default: vpsadminos

Validation rules
RuleDetails
Include

Allowed values:

  • openvz
  • vpsadminos

Validation error message: %{value} cannot be used
cgroup_version
Cgroup_version
 String no

Default: cgroup_any

Validation rules
RuleDetails
Include

Allowed values:

  • cgroup_any
  • cgroup_v1
  • cgroup_v2

Validation error message: %{value} cannot be used
manage_hostname
Manage hostname
 Boolean no

Determines whether vpsAdmin sets VPS hostname or not

Default: true
manage_dns_resolver
Manage DNS resolver
 Boolean no

Default: true
enable_script
vpsAdmin user scripts
 Boolean no

Default: null
enable_cloud_init
Cloud-init
 Boolean no

Default: null
vendor
Vendor
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
variant
Variant
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
arch
Arch
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
distribution
Distribution
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
version
Version
 String yes

4 or 6

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
config
Config
 Text no

Advanced configuration in YAML

Default: null

Output parameters

Layout
object
Namespace
os_template
ParameterTypeDescription
id
ID
 Integer OS template ID
os_family
OS family
 Resource
name
Name
 String Template file name
label
Label
 String Human-friendly label
info
Info
 Text Information about template
enabled
Enabled
 Boolean Enable/disable template usage
supported
Supported
 Boolean Is template known to work?
order
Order
 Integer Template order
hypervisor_type
Hypervisor_type
 String
cgroup_version
Cgroup_version
 String
manage_hostname
Manage hostname
 Boolean Determines whether vpsAdmin sets VPS hostname or not
manage_dns_resolver
Manage DNS resolver
 Boolean
enable_script
vpsAdmin user scripts
 Boolean
enable_cloud_init
Cloud-init
 Boolean
vendor
Vendor
 String
variant
Variant
 String
arch
Arch
 String
distribution
Distribution
 String
version
Version
 String 4 or 6
config
Config
 Text Advanced configuration in YAML

Delete

Path
DELETE /v7.0/os_templates/{os_template_id}
Description
Authentication required
yes
Scope
os_template#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/os_templates
Description
List OS templates
Authentication required
no
Scope
os_template#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
os_template
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
location
Location
 Resource no
os_family
OS family
 Resource no
hypervisor_type
Hypervisor_type
 String no

Default: vpsadminos

Validation rules
RuleDetails
Include

Allowed values:

  • openvz
  • vpsadminos

Validation error message: %{value} cannot be used
cgroup_version
Cgroup_version
 String no

Default: cgroup_any

Validation rules
RuleDetails
Include

Allowed values:

  • cgroup_any
  • cgroup_v1
  • cgroup_v2

Validation error message: %{value} cannot be used
enable_script
vpsAdmin user scripts
 Boolean no

Default: null
enable_cloud_init
Cloud-init
 Boolean no

Default: null

Output parameters

Layout
object_list
Namespace
os_templates
ParameterTypeDescription
id
ID
 Integer OS template ID
os_family
OS family
 Resource
name
Name
 String Template file name
label
Label
 String Human-friendly label
info
Info
 Text Information about template
enabled
Enabled
 Boolean Enable/disable template usage
supported
Supported
 Boolean Is template known to work?
order
Order
 Integer Template order
hypervisor_type
Hypervisor_type
 String
cgroup_version
Cgroup_version
 String
manage_hostname
Manage hostname
 Boolean Determines whether vpsAdmin sets VPS hostname or not
manage_dns_resolver
Manage DNS resolver
 Boolean
enable_script
vpsAdmin user scripts
 Boolean
enable_cloud_init
Cloud-init
 Boolean
vendor
Vendor
 String
variant
Variant
 String
arch
Arch
 String
distribution
Distribution
 String
version
Version
 String 4 or 6
config
Config
 Text Advanced configuration in YAML

Show

Path
GET /v7.0/os_templates/{os_template_id}
Description
Authentication required
no
Scope
os_template#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
os_template
ParameterTypeDescription
id
ID
 Integer OS template ID
os_family
OS family
 Resource
name
Name
 String Template file name
label
Label
 String Human-friendly label
info
Info
 Text Information about template
enabled
Enabled
 Boolean Enable/disable template usage
supported
Supported
 Boolean Is template known to work?
order
Order
 Integer Template order
hypervisor_type
Hypervisor_type
 String
cgroup_version
Cgroup_version
 String
manage_hostname
Manage hostname
 Boolean Determines whether vpsAdmin sets VPS hostname or not
manage_dns_resolver
Manage DNS resolver
 Boolean
enable_script
vpsAdmin user scripts
 Boolean
enable_cloud_init
Cloud-init
 Boolean
vendor
Vendor
 String
variant
Variant
 String
arch
Arch
 String
distribution
Distribution
 String
version
Version
 String 4 or 6
config
Config
 Text Advanced configuration in YAML

Update

Path
PUT /v7.0/os_templates/{os_template_id}
Description
Authentication required
yes
Scope
os_template#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
os_template
ParameterTypeRequiredDetails
os_family
OS family
 Resource no
label
Label
 String no

Human-friendly label

Default: null
info
Info
 Text no

Information about template

Default: null
enabled
Enabled
 Boolean no

Enable/disable template usage

Default: null
supported
Supported
 Boolean no

Is template known to work?

Default: null
order
Order
 Integer no

Template order

Default: null
hypervisor_type
Hypervisor_type
 String no

Default: vpsadminos

Validation rules
RuleDetails
Include

Allowed values:

  • openvz
  • vpsadminos

Validation error message: %{value} cannot be used
cgroup_version
Cgroup_version
 String no

Default: cgroup_any

Validation rules
RuleDetails
Include

Allowed values:

  • cgroup_any
  • cgroup_v1
  • cgroup_v2

Validation error message: %{value} cannot be used
manage_hostname
Manage hostname
 Boolean no

Determines whether vpsAdmin sets VPS hostname or not

Default: null
manage_dns_resolver
Manage DNS resolver
 Boolean no

Default: null
enable_script
vpsAdmin user scripts
 Boolean no

Default: null
enable_cloud_init
Cloud-init
 Boolean no

Default: null
vendor
Vendor
 String no

Default: null
variant
Variant
 String no

Default: null
arch
Arch
 String no

Default: null
distribution
Distribution
 String no

Default: null
version
Version
 String no

4 or 6

Default: null
config
Config
 Text no

Advanced configuration in YAML

Default: null

Output parameters

Layout
object
Namespace
os_template
ParameterTypeDescription
id
ID
 Integer OS template ID
os_family
OS family
 Resource
name
Name
 String Template file name
label
Label
 String Human-friendly label
info
Info
 Text Information about template
enabled
Enabled
 Boolean Enable/disable template usage
supported
Supported
 Boolean Is template known to work?
order
Order
 Integer Template order
hypervisor_type
Hypervisor_type
 String
cgroup_version
Cgroup_version
 String
manage_hostname
Manage hostname
 Boolean Determines whether vpsAdmin sets VPS hostname or not
manage_dns_resolver
Manage DNS resolver
 Boolean
enable_script
vpsAdmin user scripts
 Boolean
enable_cloud_init
Cloud-init
 Boolean
vendor
Vendor
 String
variant
Variant
 String
arch
Arch
 String
distribution
Distribution
 String
version
Version
 String 4 or 6
config
Config
 Text Advanced configuration in YAML