Templates

Download schema

Templates are blueprints for creating Instances with predefined configurations. A template includes specifications such as Instance type, attached volumes, security groups, placement groups, private networks, and public IP settings. Using templates allows you to standardize and automate Instance deployment across your infrastructure.

List templates

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates

List all available templates.

List templates › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List templates › query Parameters

project_id

string · required

Filter by Project ID.

page_token

string

Token for pagination.

page_size

integer · uint32

Number of items to return per page.

order_by

string · enum

Field to sort results by.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

template_ids

string[]

Filter by specific template IDs.

name

string

Filter by template name.

tags

string[]

Filter by tags.

server_tags

string[]

Filter by server tags.

security_group_ids

string[]

Filter by security group IDs.

placement_group_ids

string[]

Filter by placement group IDs.

List templates › Responses

200

scaleway.instance.v2alpha1.ListTemplatesResponse

scaleway.instance.v2alpha1.TemplateSummary[]

List of template summaries.

next_page_token

string

Token for the next page.

total_count

integer · uint64

Total number of items.

GET/instance/v2alpha1/zones/{zone}/templates

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/templates?project_id=string"

Example Responses

{
  "templates": [
    {
      "project_id": "project_id",
      "id": "id",
      "name": "name",
      "tags": [
        "string"
      ],
      "server_tags": [
        "string"
      ],
      "server_type": "server_type",
      "security_group_id": "security_group_id",
      "placement_group_id": "placement_group_id",
      "public_ip_v4_count": 0,
      "public_ip_v6_count": 0,
      "filesystem_ids": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "zone": "zone"
    }
  ],
  "next_page_token": "next_page_token",
  "total_count": 0
}

json

application/json

Create a template

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates

Create a new template from an Instance.

Create a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Create a template › Request Body

project_id

string

Project ID for the template.

name

string

Name of the template.

tags

string[]

Tags to associate with the template.

server_tags

string[]

Tags to associate with servers created from the template.

server_type

string

Commercial type of the server defined by the template.

security_group_id

string

Security group ID for the template.

placement_group_id

string

Placement group ID for the template.

scaleway.instance.v2alpha1.CreateTemplateRequest.VolumeTemplate[]

List of volume templates to define volumes for servers.

scaleway.instance.v2alpha1.CreateTemplateRequest.PrivateNetworkTemplate[]

List of private networks to associate with the template.

filesystem_ids

string[]

List of filesystem IDs to associate with the template.

public_ip_v4_count

integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count

integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

windows_rdp_ssh_key_id

string

IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

Create a template › Responses

200

scaleway.instance.v2alpha1.Template

project_id

string

Project ID associated with the template.

id

string

Unique ID of the template.

name

string

Name of the template.

tags

string[]

Tags associated with the template.

server_tags

string[]

Tags associated with servers created from this template.

server_type

string

Commercial type of the server defined by the template.

security_group_id

string

Security group ID associated with the template.

placement_group_id

string

Placement group ID associated with the template.

public_ip_v4_count

integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count

integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

scaleway.instance.v2alpha1.CreateTemplateRequest.VolumeTemplate[]

List of volume templates used to create volumes for servers.

scaleway.instance.v2alpha1.CreateTemplateRequest.PrivateNetworkTemplate[]

List of private network associated with the template.

filesystem_ids

string[]

List of filesystem IDs associated with the template.

created_at

string · date-time

Creation timestamp of the template. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the template. (RFC 3339 format)

windows_rdp_ssh_key_id

string

IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

zone

string

Zone in which the template is located.

POST/instance/v2alpha1/zones/{zone}/templates

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "project_id": "string",
    "public_ip_v4_count": 42,
    "public_ip_v6_count": 42,
    "server_type": "string"
  }' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/templates"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "tags": [
    "string"
  ],
  "server_tags": [
    "string"
  ],
  "server_type": "server_type",
  "security_group_id": "security_group_id",
  "placement_group_id": "placement_group_id",
  "volumes": [
    {
      "volume_type": "unknown_volume_type",
      "name": "name",
      "tags": [
        "string"
      ],
      "size": 0,
      "base_snapshot_id": "base_snapshot_id",
      "image_label": "image_label",
      "perf_iops": 0
    }
  ],
  "private_networks": [
    {
      "private_network_id": "private_network_id"
    }
  ],
  "filesystem_ids": [
    "string"
  ],
  "public_ip_v4_count": 0,
  "public_ip_v6_count": 0,
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id"
}

json

Example Responses

{
  "project_id": "project_id",
  "id": "id",
  "name": "name",
  "tags": [
    "string"
  ],
  "server_tags": [
    "string"
  ],
  "server_type": "server_type",
  "security_group_id": "security_group_id",
  "placement_group_id": "placement_group_id",
  "public_ip_v4_count": 0,
  "public_ip_v6_count": 0,
  "volumes": [
    {
      "volume_type": "unknown_volume_type",
      "name": "name",
      "tags": [
        "string"
      ],
      "size": 0,
      "base_snapshot_id": "base_snapshot_id",
      "image_label": "image_label",
      "perf_iops": 0
    }
  ],
  "private_networks": [
    {
      "private_network_id": "private_network_id"
    }
  ],
  "filesystem_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id",
  "zone": "zone"
}

json

application/json

Get a template

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}

Get details of a specified template.

Get a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template to retrieve.

Get a template › Responses

200

scaleway.instance.v2alpha1.Template

project_id

string

Project ID associated with the template.

id

string

Unique ID of the template.

name

string

Name of the template.

tags

string[]

Tags associated with the template.

server_tags

string[]

Tags associated with servers created from this template.

server_type

string

Commercial type of the server defined by the template.

security_group_id

string

Security group ID associated with the template.

placement_group_id

string

Placement group ID associated with the template.

public_ip_v4_count

integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count

integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

scaleway.instance.v2alpha1.CreateTemplateRequest.VolumeTemplate[]

List of volume templates used to create volumes for servers.

scaleway.instance.v2alpha1.CreateTemplateRequest.PrivateNetworkTemplate[]

List of private network associated with the template.

filesystem_ids

string[]

List of filesystem IDs associated with the template.

created_at

string · date-time

Creation timestamp of the template. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the template. (RFC 3339 format)

windows_rdp_ssh_key_id

string

IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

zone

string

Zone in which the template is located.

GET/instance/v2alpha1/zones/{zone}/templates/{template_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/templates/{template_id}"

Example Responses

{
  "project_id": "project_id",
  "id": "id",
  "name": "name",
  "tags": [
    "string"
  ],
  "server_tags": [
    "string"
  ],
  "server_type": "server_type",
  "security_group_id": "security_group_id",
  "placement_group_id": "placement_group_id",
  "public_ip_v4_count": 0,
  "public_ip_v6_count": 0,
  "volumes": [
    {
      "volume_type": "unknown_volume_type",
      "name": "name",
      "tags": [
        "string"
      ],
      "size": 0,
      "base_snapshot_id": "base_snapshot_id",
      "image_label": "image_label",
      "perf_iops": 0
    }
  ],
  "private_networks": [
    {
      "private_network_id": "private_network_id"
    }
  ],
  "filesystem_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id",
  "zone": "zone"
}

json

application/json

Delete a template

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}

Delete a specified template.

Delete a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template to delete.

Delete a template › Request Body

Delete a template › Responses

No data returned

Update a template

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}

Update the properties of a template.

Update a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template to update.

Update a template › Request Body

name

string

New name for the template.

tags

string[]

New tags for the template.

server_tags

string[]

New server tags for the template.

server_type

string

New server type for the template.

security_group_id

string

New security group ID for the template.

placement_group_id

string

New placement group ID for the template.

object

Updated volume templates for the template.

object

Updated private networks list for the template.

filesystem_ids

string[]

New list of filesystem IDs for the template.

public_ip_v4_count

integer · uint32

New number of IPv4 public IPs to attach to servers.

public_ip_v6_count

integer · uint32

New number of IPv6 public IPs to attach to servers.

windows_rdp_ssh_key_id

string

New IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

Update a template › Responses

200

scaleway.instance.v2alpha1.Template

project_id

string

Project ID associated with the template.

id

string

Unique ID of the template.

name

string

Name of the template.

tags

string[]

Tags associated with the template.

server_tags

string[]

Tags associated with servers created from this template.

server_type

string

Commercial type of the server defined by the template.

security_group_id

string

Security group ID associated with the template.

placement_group_id

string

Placement group ID associated with the template.

public_ip_v4_count

integer · uint32

Number of IPv4 public IPs to attach to servers created from this template.

public_ip_v6_count

integer · uint32

Number of IPv6 public IPs to attach to servers created from this template.

scaleway.instance.v2alpha1.CreateTemplateRequest.VolumeTemplate[]

List of volume templates used to create volumes for servers.

scaleway.instance.v2alpha1.CreateTemplateRequest.PrivateNetworkTemplate[]

List of private network associated with the template.

filesystem_ids

string[]

List of filesystem IDs associated with the template.

created_at

string · date-time

Creation timestamp of the template. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the template. (RFC 3339 format)

windows_rdp_ssh_key_id

string

IAM ID of the SSH key used to encrypt the Windows Administrator password for RDP use.

zone

string

Zone in which the template is located.

PATCH/instance/v2alpha1/zones/{zone}/templates/{template_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/templates/{template_id}"

Example Request Body

{
  "name": "name",
  "tags": [
    "string"
  ],
  "server_tags": [
    "string"
  ],
  "server_type": "server_type",
  "security_group_id": "security_group_id",
  "placement_group_id": "placement_group_id",
  "update_volumes": {
    "volumes": [
      {
        "volume_type": "unknown_volume_type",
        "name": "name",
        "tags": [
          "string"
        ],
        "size": 0,
        "base_snapshot_id": "base_snapshot_id",
        "image_label": "image_label",
        "perf_iops": 0
      }
    ]
  },
  "update_private_networks": {
    "private_networks": [
      {
        "private_network_id": "private_network_id"
      }
    ]
  },
  "filesystem_ids": [
    "string"
  ],
  "public_ip_v4_count": 0,
  "public_ip_v6_count": 0,
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id"
}

json

Example Responses

{
  "project_id": "project_id",
  "id": "id",
  "name": "name",
  "tags": [
    "string"
  ],
  "server_tags": [
    "string"
  ],
  "server_type": "server_type",
  "security_group_id": "security_group_id",
  "placement_group_id": "placement_group_id",
  "public_ip_v4_count": 0,
  "public_ip_v6_count": 0,
  "volumes": [
    {
      "volume_type": "unknown_volume_type",
      "name": "name",
      "tags": [
        "string"
      ],
      "size": 0,
      "base_snapshot_id": "base_snapshot_id",
      "image_label": "image_label",
      "perf_iops": 0
    }
  ],
  "private_networks": [
    {
      "private_network_id": "private_network_id"
    }
  ],
  "filesystem_ids": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "windows_rdp_ssh_key_id": "windows_rdp_ssh_key_id",
  "zone": "zone"
}

json

application/json

Check a template

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/check

Validate that a template is usable.

Check a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template to check.

Check a template › Responses

No data returned

Create a server from a template

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/create-server

Create a new Instance using a specified template.

Create a server from a template › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template to use.

Create a server from a template › Request Body

name

string

Name of the new server.

Create a server from a template › Responses

200

scaleway.instance.v2alpha1.Server

id

string

Unique ID of the server.

name

string

Name of the server.

project_id

string

Project ID to which the server belongs.

tags

string[]

Tags associated with the server.

server_type

string

Type of the server.

placement_group_id

string

ID of the placement group the server belongs to.

status

string · enum

Current status of the server.

Enum values:

unknown_status

started

stopped

paused

starting

stopping

pausing

locked

Default: unknown_status

scaleway.instance.v2alpha1.Server.Volume[]

List of volumes attached to the server.

scaleway.instance.v2alpha1.Server.Filesystem[]

List of filesystems attached to the server.

architecture

string · enum

Architecture of the server.

Enum values:

unknown_architecture

x86_64

aarch64

Default: unknown_architecture

created_at

string · date-time

Creation timestamp of the server. (RFC 3339 format)

updated_at

string · date-time

Last update timestamp of the server. (RFC 3339 format)

scaleway.instance.v2alpha1.Server.PrivateNetworkInterface[]

List of private network interfaces attached to the server.

rescue_mode

boolean

Whether the server is in rescue mode.

boot_volume_id

string

ID of the boot volume.

status_detail

string

Detailed status information of the server.

object

Encrypted RDP password for Windows servers. The encryption scheme is RSA-PKCS1-v1_5, using the public part of the SSH key supplied in windows_rdp_ssh_key_id.

object

Public network interface of the server.

zone

string

Zone in which the server is located.

POST/instance/v2alpha1/zones/{zone}/templates/{template_id}/create-server

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/templates/{template_id}/create-server"

Example Request Body

{
  "name": "name"
}

json

Example Responses

{
  "id": "id",
  "name": "name",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "server_type": "server_type",
  "placement_group_id": "placement_group_id",
  "status": "unknown_status",
  "volumes": [
    {
      "id": "id",
      "volume_type": "unknown_volume_type"
    }
  ],
  "filesystems": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "status": "unknown_status"
    }
  ],
  "architecture": "unknown_architecture",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "private_network_interfaces": [
    {
      "id": "id",
      "private_network_id": "private_network_id",
      "mac_address": "mac_address",
      "status": "unknown_status",
      "ip_ids": [
        "string"
      ],
      "security_group_id": "security_group_id"
    }
  ],
  "rescue_mode": true,
  "boot_volume_id": "boot_volume_id",
  "status_detail": "status_detail",
  "windows_rdp_password": {
    "encrypted_password": "encrypted_password",
    "rdp_ssh_key_id": "rdp_ssh_key_id"
  },
  "public_network_interface": {
    "status": "unknown_status",
    "mac_address": "mac_address",
    "security_group_id": "security_group_id",
    "ips": [
      {
        "id": "id",
        "dynamic": true,
        "status": "unknown_status",
        "default": true
      }
    ],
    "dns": "dns"
  },
  "zone": "zone"
}

json

application/json

List template user data keys

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data

List all user data keys of a template.

List template user data keys › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

List template user data keys › query Parameters

page_token

string

Token for pagination.

page_size

integer · uint32

Number of items to return per page.

List template user data keys › Responses

200

scaleway.instance.v2alpha1.ListTemplateUserDataKeysResponse

keys

string[]

List of user data keys associated with the template.

next_page_token

string

Token for the next page.

total_count

integer · uint64

Total number of items.

Get template user data

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data/{key}

Get a specific user data key of a template.

Get template user data › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

key

string · required

Key of the user data to retrieve.

Get template user data › Responses

200

scaleway.instance.v2alpha1.UserData

key

string

The key of the user data.

content

string

The content of the user data.

Set template user data

PUT

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data/{key}

Set a user data key of a template.

Set template user data › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

key

string · required

Key of the user data to set.

Set template user data › Request Body

content

string

Content of the user data.

Set template user data › Responses

No data returned

Delete template user data

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data/{key}

Delete a specific user data key of a template.

Delete template user data › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

key

string · required

Key of the user data to delete.

Delete template user data › Responses

No data returned

Get template cloud-init

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data/cloud-init

Get the cloud-init configuration of a template.

Get template cloud-init › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

Get template cloud-init › Responses

200

scaleway.instance.v2alpha1.UserData

key

string

The key of the user data.

content

string

The content of the user data.

Set template cloud-init

PUT

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/templates/{template_id}/user-data/cloud-init

Set the cloud-init configuration of a template.

Set template cloud-init › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

template_id

string · required

Unique ID of the template.

Set template cloud-init › Request Body

content

string

Cloud-init configuration content.

Set template cloud-init › Responses

No data returned

User Data