Instance templates are models of Instances which are used by Instance groups when scaling up.
List Instance templates
List all Instance templates, for a Scaleway Organization or Scaleway Project. By default, the Instance templates returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
path Parameters
zoneThe zone you want to target
query Parameters
order_bySort order of Instance groups in the response.
pagePage number to return, from the paginated results.
page_sizeNumber of Instance groups to return per page.
List Instance templates › Responses
total_countCount of all templates matching the requested criteria.
Paginated list of Instance templates.
Create Instance template
Create a new Instance template. This specifies the details of the Instance (commercial type, zone, image, volumes etc.) that will be in the Instance group.
path Parameters
zoneThe zone you want to target
Create Instance template › Request Body
commercial_typeName of Instance commercial type.
image_idInstance image ID. Can be an ID of a marketplace or personal image. This image must be compatible with volume and commercial_type template.
Template of Instance volume.
project_idID of the Project containing the Instance template resource.
nameName of Instance template.
tagsList of tags for the Instance template.
security_group_idInstance security group ID (optional).
placement_group_idInstance placement group ID. This is optional, but it is highly recommended to set a preference for Instance location within Availability Zone.
public_ips_v4_countNumber of flexible IPv4 addresses to attach to the new Instance.
public_ips_v6_countNumber of flexible IPv6 addresses to attach to the new Instance.
private_network_idsPrivate Network IDs to attach to the new Instance.
cloud_initCloud-config file must be passed in Base64 format. Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server.
Create Instance template › Responses
idID of Instance template resource.
commercial_typeName of Instance commercial type.
image_idInstance image ID. Can be an ID of a marketplace or personal image. This image must be compatible with volume and commercial_type template.
Template of Instance volume.
tagsList of tags for the Instance template.
security_group_idInstance security group ID (optional).
placement_group_idInstance placement group ID. This is optional, but it is highly recommended to set a preference for Instance location within Availability Zone.
public_ips_v4_countNumber of flexible IPv4 addresses to attach to the new Instance.
public_ips_v6_countNumber of flexible IPv6 addresses to attach to the new Instance.
project_idID of the Project containing the Instance template resource.
nameName of Instance template.
private_network_idsPrivate Network IDs to attach to the new Instance.
statusStatus of Instance template.
cloud_initCloud-config file must be passed in Base64 format. Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server.
created_atDate on which the Instance template was created. (RFC 3339 format)
updated_atDate on which the Instance template was last updated. (RFC 3339 format)
zoneZone for this resource.
Get Instance template
Get an existing Instance template from its template_id.
path Parameters
zoneThe zone you want to target
template_idTemplate ID of the resource.
Get Instance template › Responses
idID of Instance template resource.
commercial_typeName of Instance commercial type.
image_idInstance image ID. Can be an ID of a marketplace or personal image. This image must be compatible with volume and commercial_type template.
Template of Instance volume.
tagsList of tags for the Instance template.
security_group_idInstance security group ID (optional).
placement_group_idInstance placement group ID. This is optional, but it is highly recommended to set a preference for Instance location within Availability Zone.
public_ips_v4_countNumber of flexible IPv4 addresses to attach to the new Instance.
public_ips_v6_countNumber of flexible IPv6 addresses to attach to the new Instance.
project_idID of the Project containing the Instance template resource.
nameName of Instance template.
private_network_idsPrivate Network IDs to attach to the new Instance.
statusStatus of Instance template.
cloud_initCloud-config file must be passed in Base64 format. Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server.
created_atDate on which the Instance template was created. (RFC 3339 format)
updated_atDate on which the Instance template was last updated. (RFC 3339 format)
zoneZone for this resource.
Update Instance template
Update an Instance template, such as its commercial offer type, image or volume template.
path Parameters
zoneThe zone you want to target
template_idTemplate ID of the resource.
Update Instance template › Request Body
commercial_typeName of Instance commercial type.
image_idInstance image ID. Can be an ID of a marketplace or personal image. This image must be compatible with volume and commercial_type template.
Template of Instance volume.
tagsList of tags for the Instance template.
security_group_idInstance security group ID (optional).
placement_group_idInstance placement group ID. This is optional, but it is highly recommended to set a preference for Instance location within Availability Zone.
public_ips_v4_countNumber of flexible IPv4 addresses to attach to the new Instance.
public_ips_v6_countNumber of flexible IPv6 addresses to attach to the new Instance.
nameName of Instance template.
private_network_idsPrivate Network IDs to attach to the new Instance.
cloud_initCloud-config file must be passed in Base64 format. Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server.
Update Instance template › Responses
idID of Instance template resource.
commercial_typeName of Instance commercial type.
image_idInstance image ID. Can be an ID of a marketplace or personal image. This image must be compatible with volume and commercial_type template.
Template of Instance volume.
tagsList of tags for the Instance template.
security_group_idInstance security group ID (optional).
placement_group_idInstance placement group ID. This is optional, but it is highly recommended to set a preference for Instance location within Availability Zone.
public_ips_v4_countNumber of flexible IPv4 addresses to attach to the new Instance.
public_ips_v6_countNumber of flexible IPv6 addresses to attach to the new Instance.
project_idID of the Project containing the Instance template resource.
nameName of Instance template.
private_network_idsPrivate Network IDs to attach to the new Instance.
statusStatus of Instance template.
cloud_initCloud-config file must be passed in Base64 format. Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server.
created_atDate on which the Instance template was created. (RFC 3339 format)
updated_atDate on which the Instance template was last updated. (RFC 3339 format)
zoneZone for this resource.