Instance APIv1

Download OpenAPI

Introduction

Endpoints

Scaleway instance API can be reach on

  • https://api.scaleway.com/instance/v1/zones/fr-par-1
  • https://api.scaleway.com/instance/v1/zones/nl-ams-1

Older endpoints are still reachable but should not be used for new projects

  • https://cp-par1.scaleway.com
  • https://cp-ams1.scaleway.com

The following code is an example request to retrieve detailed information about a volume:

% curl -H 'X-Auth-Token: xxxxxxxx-xxxx-xxxxx-xxxx-xxxxxxxxxxxxx' -H 'Content-Type: application/json' https://api.scaleway.com/instance/v1/zones/fr-par-1/volumes/f929fe39-63f8-4be8-a80e-1e9c8ae22a76 -i

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 22 May 2014 07:55:00 GMT
Content-Type: application/json
Content-Length: 1345
Connection: keep-alive
Strict-Transport-Security: max-age=86400

{
  "volumes": [
    {
      "export_uri": null,
      "id": "f929fe39-63f8-4be8-a80e-1e9c8ae22a76",
      "name": "volume-0-1",
      "organization": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
      "server": null,
      "size": 10000000000,
      "volume_type": "l_ssd"
    },
    {
      "export_uri": null,
      "id": "0facb6b5-b117-441a-81c1-f28b1d723779",
      "name": "volume-0-2",
      "organization": "000a115d-2852-4b0a-9ce8-47f1134ba95a",
      "server": null,
      "size": 20000000000,
      "volume_type": "l_ssd"
    }
  ]
}

Servers

Server types are denomination of the different instances we provide. Scaleway offers Virtual Cloud and dedicated GPU instances.

Virtual Cloud Instances

Virtual cloud instances are offering the best performance/price ratio for most workloads. Different CPU architectures are proposed: The Development and General Purpose ranges are based on AMD EPYC CPUs. The ARM64 range is based on Cavium Thunder X ARM CPUs.

  • The Development instances range provides stable and consistent performance for development needs. Spin up a development or test environment within seconds. Refer to the Development Instance offer details for more information.

  • The General Purpose instances range is the solution for demanding workloads. Powerful AMD EPYC CPUs back those instances and offer up to 48 Cores, 256GB of RAM and 600GB of replicated local NVMe SSD storage. Refer to the General Purpose offer details for more information.

  • The ARM instances range is based on Cavium ThunderX SoCs and provides up to 64 Cores ARM 64bit, 128GB of RAM and 1TB SSD storage. Refer to the ARM offer details for more information.

Dedicated GPU Instances

GPU instances are very powerful compute instances, providing lots of RAM, vCPU, and storage.

They are equipped with Nvidia Tesla P100 GPUs, which are designed for handling rapidly, a massive amount of data. They are useful for heavy data processing, artificial intelligence and machine learning, video encoding, rendering, and so on. The GPU is dedicated to each instance and directly exposed through PCI-e. For more information, refer to GPU Instances.

List all servers

GET
/instance/v1/zones/{zone}/servers
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
Query Parameters
per_page
nullable number
A positive integer lower or equal to 100 to select the number of items to return. The default value is 50.
page
number
A positive integer to choose the page to return. The default value is 1.
organization
nullable string
List only servers of this organization ID.
project
nullable string
List only servers of this project ID.
name
nullable string
Filter servers by name (for eg. "server1" will return "server100" and "server1" but not "foo").
private_ip
nullable string
List servers by private_ip (IP address).
without_ip
nullable boolean
List servers that are not attached to a public IP.
commercial_type
nullable string
List servers of this commercial type.
state
string
List servers in this state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.
tags
nullable string
List servers with these exact tags.
private_network
nullable string
List servers in this Private Network.
200 Response
servers
array
id
string
The server unique ID.
name
string
The server name.
organization
string
The server organization ID.
project
string
The server project ID.
allowed_actions
array
Provide as list of allowed actions on the server.
tags
array
The server associated tags.
commercial_type
string
The server commercial type (eg. GP1-M).
creation_date
string
The server creation date.
dynamic_ip_required
boolean
True if a dynamic IP is required.
enable_ipv6
boolean
True if IPv6 is enabled.
hostname
string
The server host name.
image
object
Provide information on the server image.
id
string
name
string
arch
string
Possible values are x86_64 and arm. The default value is x86_64.
creation_date
string
modification_date
string
default_bootscript
object
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
extra_volumes
map
<extra_volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
from_server
string
organization
string
public
boolean
root_volume
object
id
string
name
string
size
number
(in bytes).
volume_type
string
Possible values are l_ssd and b_ssd. The default value is l_ssd.
state
string
Possible values are available, creating and error. The default value is available.
project
string
zone
string
protected
boolean
The server protection option is activated.
private_ip
nullable string
The server private IP address.
public_ip
object
Information about the public IP.
id
string
The unique ID of the IP address.
address
string
The server public IPv4 IP-Address (IPv4 address).
dynamic
boolean
True if the IP address is dynamic.
modification_date
string
The server modification date.
state
string
The server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.
location
object
The server location.
cluster_id
string
hypervisor_id
string
node_id
string
platform_id
string
zone_id
string
ipv6
object
The server IPv6 address.
address
string
The server IPv6 IP-Address (IPv6 address).
gateway
string
The IPv6 IP-addresses gateway (IPv6 address).
netmask
string
The IPv6 IP-addresses CIDR netmask.
bootscript
object
The server bootscript.
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
boot_type
string
The server boot type. Possible values are local, bootscript and rescue. The default value is local.
volumes
map
The server volumes.
<volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
security_group
object
The server security group.
id
string
name
string
maintenances
array
The server planned maintenances.
state_detail
string
The server state_detail.
arch
string
The server arch. Possible values are x86_64 and arm. The default value is x86_64.
placement_group
object
The server placement group.
id
string
The placement group unique ID.
name
string
The placement group name.
organization
string
The placement group organization ID.
project
string
The placement group project ID.
policy_mode
string
Select the failling mode when the placement cannot be respected, either optional or enforced. Possible values are optional and enforced. The default value is optional.
policy_type
string
Select the behavior of the placement group, either low_latency (group) or max_availability (spread). Possible values are max_availability and low_latency. The default value is max_availability.
policy_respected
boolean
Returns true if the policy is respected, false otherwise.
zone
string
The zone in which is the placement group.
private_nics
array
The server private NICs.
id
string
The private NIC unique ID.
server_id
string
The server the private NIC is attached to.
private_network_id
string
The private network where the private NIC is attached.
mac_address
string
The private NIC MAC address.
zone
string
The zone in which is the server.
total_count
number
Response Example
{
  "servers": [
    {
      "id": "string",
      "name": "string",
      "organization": "string",
      "project": "string",
      "allowed_actions": [
        "poweron"
      ],
      "tags": [
        "string"
      ],
      "commercial_type": "string",
      "creation_date": "string",
      "dynamic_ip_required": "boolean",
      "enable_ipv6": "boolean",
      "hostname": "string",
      "image": {
        "id": "string",
        "name": "string",
        "arch": "x86_64",
        "creation_date": "string",
        "modification_date": "string",
        "default_bootscript": {
          "bootcmdargs": "string",
          "default": "boolean",
          "dtb": "string",
          "id": "string",
          "initrd": "string",
          "kernel": "string",
          "organization": "string",
          "project": "string",
          "public": "boolean",
          "title": "string",
          "arch": "x86_64",
          "zone": "string"
        },
        "extra_volumes": {
          "<extra_volumeKey>": {
            "id": "string",
            "name": "string",
            "export_uri": "string",
            "size": 42,
            "volume_type": "l_ssd",
            "creation_date": "string",
            "modification_date": "string",
            "organization": "string",
            "project": "string",
            "server": {
              "id": "string",
              "name": "string"
            },
            "state": "available",
            "zone": "string"
          }
        },
        "from_server": "string",
        "organization": "string",
        "public": "boolean",
        "root_volume": {
          "id": "string",
          "name": "string",
          "size": 42,
          "volume_type": "l_ssd"
        },
        "state": "available",
        "project": "string",
        "zone": "string"
      },
      "protected": "boolean",
      "private_ip": "string",
      "public_ip": {
        "id": "string",
        "address": "1.2.3.4",
        "dynamic": "boolean"
      },
      "modification_date": "string",
      "state": "running",
      "location": {
        "cluster_id": "string",
        "hypervisor_id": "string",
        "node_id": "string",
        "platform_id": "string",
        "zone_id": "string"
      },
      "ipv6": {
        "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
        "gateway": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
        "netmask": "string"
      },
      "bootscript": {
        "bootcmdargs": "string",
        "default": "boolean",
        "dtb": "string",
        "id": "string",
        "initrd": "string",
        "kernel": "string",
        "organization": "string",
        "project": "string",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64",
        "zone": "string"
      },
      "boot_type": "local",
      "volumes": {
        "<volumeKey>": {
          "id": "string",
          "name": "string",
          "export_uri": "string",
          "size": 42,
          "volume_type": "l_ssd",
          "creation_date": "string",
          "modification_date": "string",
          "organization": "string",
          "project": "string",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available",
          "zone": "string"
        }
      },
      "security_group": {
        "id": "string",
        "name": "string"
      },
      "maintenances": [
        {}
      ],
      "state_detail": "string",
      "arch": "x86_64",
      "placement_group": {
        "id": "string",
        "name": "string",
        "organization": "string",
        "project": "string",
        "policy_mode": "optional",
        "policy_type": "max_availability",
        "policy_respected": "boolean",
        "zone": "string"
      },
      "private_nics": [
        {
          "id": "string",
          "server_id": "string",
          "private_network_id": "string",
          "mac_address": "string"
        }
      ],
      "zone": "string"
    }
  ],
  "total_count": 42
}

Create a server

POST
/instance/v1/zones/{zone}/servers
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
Body
name
required string
The server name.
dynamic_ip_required
nullable boolean
Define if a dynamic IP is required for the instance.
commercial_type
required string
Define the server commercial type (i.e. GP1-S).
image
string
The server image ID.
volumes
map
The volumes attached to the server.
<volumeKey>
object
id
string
UUID of the volume.
name
string
Name of the volume.
size
number
Disk size of the volume (in bytes).
volume_type
string
Type of the volume. Possible values are l_ssd and b_ssd. The default value is l_ssd.
organization
deprecated string
Organization ID of the volume. Only one of organization and project may be set.
project
string
Project ID of the volume. Only one of organization and project may be set.
enable_ipv6
boolean
True if IPv6 is enabled on the server.
public_ip
nullable string
The ID of the reserved IP to attach to the server.
boot_type
string
The boot type to use. Possible values are local, bootscript and rescue. The default value is local.
bootscript
nullable string
The bootscript ID to use when `boot_type` is set to `bootscript`.
organization
deprecated string
The server organization ID. Only one of organization and project may be set.
project
string
The server project ID. Only one of organization and project may be set.
tags
array
The server tags.
security_group
nullable string
The security group ID.
placement_group
nullable string
Placement group ID if server must be part of a placement group.
private_network
array
Private Network IDs if the server need to be part of one or more Private Networks.
Request Example
{
  "name": "string",
  "dynamic_ip_required": "boolean",
  "commercial_type": "string",
  "image": "string",
  "volumes": {
    "<volumeKey>": {
      "id": "string",
      "name": "string",
      "size": 42,
      "volume_type": "l_ssd",
      "organization": "string",
      "project": "string"
    }
  },
  "enable_ipv6": "boolean",
  "public_ip": "string",
  "boot_type": "local",
  "bootscript": "string",
  "organization": "string",
  "project": "string",
  "tags": [
    "string"
  ],
  "security_group": "string",
  "placement_group": "string",
  "private_network": [
    "string"
  ]
}
201 Response
server
object
id
string
The server unique ID.
name
string
The server name.
organization
string
The server organization ID.
project
string
The server project ID.
allowed_actions
array
Provide as list of allowed actions on the server.
tags
array
The server associated tags.
commercial_type
string
The server commercial type (eg. GP1-M).
creation_date
string
The server creation date.
dynamic_ip_required
boolean
True if a dynamic IP is required.
enable_ipv6
boolean
True if IPv6 is enabled.
hostname
string
The server host name.
image
object
Provide information on the server image.
id
string
name
string
arch
string
Possible values are x86_64 and arm. The default value is x86_64.
creation_date
string
modification_date
string
default_bootscript
object
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
extra_volumes
map
<extra_volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
from_server
string
organization
string
public
boolean
root_volume
object
id
string
name
string
size
number
(in bytes).
volume_type
string
Possible values are l_ssd and b_ssd. The default value is l_ssd.
state
string
Possible values are available, creating and error. The default value is available.
project
string
zone
string
protected
boolean
The server protection option is activated.
private_ip
nullable string
The server private IP address.
public_ip
object
Information about the public IP.
id
string
The unique ID of the IP address.
address
string
The server public IPv4 IP-Address (IPv4 address).
dynamic
boolean
True if the IP address is dynamic.
modification_date
string
The server modification date.
state
string
The server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.
location
object
The server location.
cluster_id
string
hypervisor_id
string
node_id
string
platform_id
string
zone_id
string
ipv6
object
The server IPv6 address.
address
string
The server IPv6 IP-Address (IPv6 address).
gateway
string
The IPv6 IP-addresses gateway (IPv6 address).
netmask
string
The IPv6 IP-addresses CIDR netmask.
bootscript
object
The server bootscript.
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
boot_type
string
The server boot type. Possible values are local, bootscript and rescue. The default value is local.
volumes
map
The server volumes.
<volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
security_group
object
The server security group.
id
string
name
string
maintenances
array
The server planned maintenances.
state_detail
string
The server state_detail.
arch
string
The server arch. Possible values are x86_64 and arm. The default value is x86_64.
placement_group
object
The server placement group.
id
string
The placement group unique ID.
name
string
The placement group name.
organization
string
The placement group organization ID.
project
string
The placement group project ID.
policy_mode
string
Select the failling mode when the placement cannot be respected, either optional or enforced. Possible values are optional and enforced. The default value is optional.
policy_type
string
Select the behavior of the placement group, either low_latency (group) or max_availability (spread). Possible values are max_availability and low_latency. The default value is max_availability.
policy_respected
boolean
Returns true if the policy is respected, false otherwise.
zone
string
The zone in which is the placement group.
private_nics
array
The server private NICs.
id
string
The private NIC unique ID.
server_id
string
The server the private NIC is attached to.
private_network_id
string
The private network where the private NIC is attached.
mac_address
string
The private NIC MAC address.
zone
string
The zone in which is the server.
Response Example
{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "hostname": "string",
    "image": {
      "id": "string",
      "name": "string",
      "arch": "x86_64",
      "creation_date": "string",
      "modification_date": "string",
      "default_bootscript": {
        "bootcmdargs": "string",
        "default": "boolean",
        "dtb": "string",
        "id": "string",
        "initrd": "string",
        "kernel": "string",
        "organization": "string",
        "project": "string",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64",
        "zone": "string"
      },
      "extra_volumes": {
        "<extra_volumeKey>": {
          "id": "string",
          "name": "string",
          "export_uri": "string",
          "size": 42,
          "volume_type": "l_ssd",
          "creation_date": "string",
          "modification_date": "string",
          "organization": "string",
          "project": "string",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available",
          "zone": "string"
        }
      },
      "from_server": "string",
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd"
      },
      "state": "available",
      "project": "string",
      "zone": "string"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "1.2.3.4",
      "dynamic": "boolean"
    },
    "modification_date": "string",
    "state": "running",
    "location": {
      "cluster_id": "string",
      "hypervisor_id": "string",
      "node_id": "string",
      "platform_id": "string",
      "zone_id": "string"
    },
    "ipv6": {
      "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "gateway": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "project": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64",
      "zone": "string"
    },
    "boot_type": "local",
    "volumes": {
      "<volumeKey>": {
        "id": "string",
        "name": "string",
        "export_uri": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "creation_date": "string",
        "modification_date": "string",
        "organization": "string",
        "project": "string",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available",
        "zone": "string"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "placement_group": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "project": "string",
      "policy_mode": "optional",
      "policy_type": "max_availability",
      "policy_respected": "boolean",
      "zone": "string"
    },
    "private_nics": [
      {
        "id": "string",
        "server_id": "string",
        "private_network_id": "string",
        "mac_address": "string"
      }
    ],
    "zone": "string"
  }
}

Get a server

Get the details of a specified Server.

GET
/instance/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
server_id
required string
UUID of the server you want to get.
200 Response
server
object
id
string
The server unique ID.
name
string
The server name.
organization
string
The server organization ID.
project
string
The server project ID.
allowed_actions
array
Provide as list of allowed actions on the server.
tags
array
The server associated tags.
commercial_type
string
The server commercial type (eg. GP1-M).
creation_date
string
The server creation date.
dynamic_ip_required
boolean
True if a dynamic IP is required.
enable_ipv6
boolean
True if IPv6 is enabled.
hostname
string
The server host name.
image
object
Provide information on the server image.
id
string
name
string
arch
string
Possible values are x86_64 and arm. The default value is x86_64.
creation_date
string
modification_date
string
default_bootscript
object
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
extra_volumes
map
<extra_volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
from_server
string
organization
string
public
boolean
root_volume
object
id
string
name
string
size
number
(in bytes).
volume_type
string
Possible values are l_ssd and b_ssd. The default value is l_ssd.
state
string
Possible values are available, creating and error. The default value is available.
project
string
zone
string
protected
boolean
The server protection option is activated.
private_ip
nullable string
The server private IP address.
public_ip
object
Information about the public IP.
id
string
The unique ID of the IP address.
address
string
The server public IPv4 IP-Address (IPv4 address).
dynamic
boolean
True if the IP address is dynamic.
modification_date
string
The server modification date.
state
string
The server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.
location
object
The server location.
cluster_id
string
hypervisor_id
string
node_id
string
platform_id
string
zone_id
string
ipv6
object
The server IPv6 address.
address
string
The server IPv6 IP-Address (IPv6 address).
gateway
string
The IPv6 IP-addresses gateway (IPv6 address).
netmask
string
The IPv6 IP-addresses CIDR netmask.
bootscript
object
The server bootscript.
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
boot_type
string
The server boot type. Possible values are local, bootscript and rescue. The default value is local.
volumes
map
The server volumes.
<volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
security_group
object
The server security group.
id
string
name
string
maintenances
array
The server planned maintenances.
state_detail
string
The server state_detail.
arch
string
The server arch. Possible values are x86_64 and arm. The default value is x86_64.
placement_group
object
The server placement group.
id
string
The placement group unique ID.
name
string
The placement group name.
organization
string
The placement group organization ID.
project
string
The placement group project ID.
policy_mode
string
Select the failling mode when the placement cannot be respected, either optional or enforced. Possible values are optional and enforced. The default value is optional.
policy_type
string
Select the behavior of the placement group, either low_latency (group) or max_availability (spread). Possible values are max_availability and low_latency. The default value is max_availability.
policy_respected
boolean
Returns true if the policy is respected, false otherwise.
zone
string
The zone in which is the placement group.
private_nics
array
The server private NICs.
id
string
The private NIC unique ID.
server_id
string
The server the private NIC is attached to.
private_network_id
string
The private network where the private NIC is attached.
mac_address
string
The private NIC MAC address.
zone
string
The zone in which is the server.
Response Example
{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "hostname": "string",
    "image": {
      "id": "string",
      "name": "string",
      "arch": "x86_64",
      "creation_date": "string",
      "modification_date": "string",
      "default_bootscript": {
        "bootcmdargs": "string",
        "default": "boolean",
        "dtb": "string",
        "id": "string",
        "initrd": "string",
        "kernel": "string",
        "organization": "string",
        "project": "string",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64",
        "zone": "string"
      },
      "extra_volumes": {
        "<extra_volumeKey>": {
          "id": "string",
          "name": "string",
          "export_uri": "string",
          "size": 42,
          "volume_type": "l_ssd",
          "creation_date": "string",
          "modification_date": "string",
          "organization": "string",
          "project": "string",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available",
          "zone": "string"
        }
      },
      "from_server": "string",
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd"
      },
      "state": "available",
      "project": "string",
      "zone": "string"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "1.2.3.4",
      "dynamic": "boolean"
    },
    "modification_date": "string",
    "state": "running",
    "location": {
      "cluster_id": "string",
      "hypervisor_id": "string",
      "node_id": "string",
      "platform_id": "string",
      "zone_id": "string"
    },
    "ipv6": {
      "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "gateway": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "project": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64",
      "zone": "string"
    },
    "boot_type": "local",
    "volumes": {
      "<volumeKey>": {
        "id": "string",
        "name": "string",
        "export_uri": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "creation_date": "string",
        "modification_date": "string",
        "organization": "string",
        "project": "string",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available",
        "zone": "string"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "placement_group": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "project": "string",
      "policy_mode": "optional",
      "policy_type": "max_availability",
      "policy_respected": "boolean",
      "zone": "string"
    },
    "private_nics": [
      {
        "id": "string",
        "server_id": "string",
        "private_network_id": "string",
        "mac_address": "string"
      }
    ],
    "zone": "string"
  }
}

Update a server

PATCH
/instance/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
server_id
required string
UUID of the server.
Body
name
nullable string
Name of the server.
boot_type
string
Possible values are local, bootscript and rescue. The default value is local.
tags
nullable array
Tags of the server.
volumes
map
<volumeKey>
object
id
string
UUID of the volume.
name
string
Name of the volume.
size
number
Disk size of the volume (in bytes).
volume_type
string
Type of the volume. Possible values are l_ssd and b_ssd. The default value is l_ssd.
organization
deprecated string
Organization ID of the volume. Only one of organization and project may be set.
project
string
Project ID of the volume. Only one of organization and project may be set.
bootscript
nullable string
dynamic_ip_required
nullable boolean
enable_ipv6
nullable boolean
protected
nullable boolean
security_group
object
id
string
name
string
placement_group
nullable string
Placement group ID if server must be part of a placement group.
private_nics
array
The server private NICs.
id
string
The private NIC unique ID.
server_id
string
The server the private NIC is attached to.
private_network_id
string
The private network where the private NIC is attached.
mac_address
string
The private NIC MAC address.
Request Example
{
  "name": "string",
  "boot_type": "local",
  "tags": [
    "string"
  ],
  "volumes": {
    "<volumeKey>": {
      "id": "string",
      "name": "string",
      "size": 42,
      "volume_type": "l_ssd",
      "organization": "string",
      "project": "string"
    }
  },
  "bootscript": "string",
  "dynamic_ip_required": "boolean",
  "enable_ipv6": "boolean",
  "protected": "boolean",
  "security_group": {
    "id": "string",
    "name": "string"
  },
  "placement_group": "string",
  "private_nics": [
    {
      "id": "string",
      "server_id": "string",
      "private_network_id": "string",
      "mac_address": "string"
    }
  ]
}
200 Response
server
object
id
string
The server unique ID.
name
string
The server name.
organization
string
The server organization ID.
project
string
The server project ID.
allowed_actions
array
Provide as list of allowed actions on the server.
tags
array
The server associated tags.
commercial_type
string
The server commercial type (eg. GP1-M).
creation_date
string
The server creation date.
dynamic_ip_required
boolean
True if a dynamic IP is required.
enable_ipv6
boolean
True if IPv6 is enabled.
hostname
string
The server host name.
image
object
Provide information on the server image.
id
string
name
string
arch
string
Possible values are x86_64 and arm. The default value is x86_64.
creation_date
string
modification_date
string
default_bootscript
object
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
extra_volumes
map
<extra_volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
from_server
string
organization
string
public
boolean
root_volume
object
id
string
name
string
size
number
(in bytes).
volume_type
string
Possible values are l_ssd and b_ssd. The default value is l_ssd.
state
string
Possible values are available, creating and error. The default value is available.
project
string
zone
string
protected
boolean
The server protection option is activated.
private_ip
nullable string
The server private IP address.
public_ip
object
Information about the public IP.
id
string
The unique ID of the IP address.
address
string
The server public IPv4 IP-Address (IPv4 address).
dynamic
boolean
True if the IP address is dynamic.
modification_date
string
The server modification date.
state
string
The server state. Possible values are running, stopped, stopped in place, starting, stopping and locked. The default value is running.
location
object
The server location.
cluster_id
string
hypervisor_id
string
node_id
string
platform_id
string
zone_id
string
ipv6
object
The server IPv6 address.
address
string
The server IPv6 IP-Address (IPv6 address).
gateway
string
The IPv6 IP-addresses gateway (IPv6 address).
netmask
string
The IPv6 IP-addresses CIDR netmask.
bootscript
object
The server bootscript.
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
boot_type
string
The server boot type. Possible values are local, bootscript and rescue. The default value is local.
volumes
map
The server volumes.
<volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.
organization
string
The volume organization ID.
project
string
The volume project ID.
server
object
The server attached to the volume.
id
string
name
string
state
string
The volume state. Possible values are available, snapshotting and error. The default value is available.
zone
string
The zone in which is the volume.
security_group
object
The server security group.
id
string
name
string
maintenances
array
The server planned maintenances.
state_detail
string
The server state_detail.
arch
string
The server arch. Possible values are x86_64 and arm. The default value is x86_64.
placement_group
object
The server placement group.
id
string
The placement group unique ID.
name
string
The placement group name.
organization
string
The placement group organization ID.
project
string
The placement group project ID.
policy_mode
string
Select the failling mode when the placement cannot be respected, either optional or enforced. Possible values are optional and enforced. The default value is optional.
policy_type
string
Select the behavior of the placement group, either low_latency (group) or max_availability (spread). Possible values are max_availability and low_latency. The default value is max_availability.
policy_respected
boolean
Returns true if the policy is respected, false otherwise.
zone
string
The zone in which is the placement group.
private_nics
array
The server private NICs.
id
string
The private NIC unique ID.
server_id
string
The server the private NIC is attached to.
private_network_id
string
The private network where the private NIC is attached.
mac_address
string
The private NIC MAC address.
zone
string
The zone in which is the server.
Response Example
{
  "server": {
    "id": "string",
    "name": "string",
    "organization": "string",
    "project": "string",
    "allowed_actions": [
      "poweron"
    ],
    "tags": [
      "string"
    ],
    "commercial_type": "string",
    "creation_date": "string",
    "dynamic_ip_required": "boolean",
    "enable_ipv6": "boolean",
    "hostname": "string",
    "image": {
      "id": "string",
      "name": "string",
      "arch": "x86_64",
      "creation_date": "string",
      "modification_date": "string",
      "default_bootscript": {
        "bootcmdargs": "string",
        "default": "boolean",
        "dtb": "string",
        "id": "string",
        "initrd": "string",
        "kernel": "string",
        "organization": "string",
        "project": "string",
        "public": "boolean",
        "title": "string",
        "arch": "x86_64",
        "zone": "string"
      },
      "extra_volumes": {
        "<extra_volumeKey>": {
          "id": "string",
          "name": "string",
          "export_uri": "string",
          "size": 42,
          "volume_type": "l_ssd",
          "creation_date": "string",
          "modification_date": "string",
          "organization": "string",
          "project": "string",
          "server": {
            "id": "string",
            "name": "string"
          },
          "state": "available",
          "zone": "string"
        }
      },
      "from_server": "string",
      "organization": "string",
      "public": "boolean",
      "root_volume": {
        "id": "string",
        "name": "string",
        "size": 42,
        "volume_type": "l_ssd"
      },
      "state": "available",
      "project": "string",
      "zone": "string"
    },
    "protected": "boolean",
    "private_ip": "string",
    "public_ip": {
      "id": "string",
      "address": "1.2.3.4",
      "dynamic": "boolean"
    },
    "modification_date": "string",
    "state": "running",
    "location": {
      "cluster_id": "string",
      "hypervisor_id": "string",
      "node_id": "string",
      "platform_id": "string",
      "zone_id": "string"
    },
    "ipv6": {
      "address": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "gateway": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "netmask": "string"
    },
    "bootscript": {
      "bootcmdargs": "string",
      "default": "boolean",
      "dtb": "string",
      "id": "string",
      "initrd": "string",
      "kernel": "string",
      "organization": "string",
      "project": "string",
      "public": "boolean",
      "title": "string",
      "arch": "x86_64",
      "zone": "string"
    },
    "boot_type": "local",
    "volumes": {
      "<volumeKey>": {
        "id": "string",
        "name": "string",
        "export_uri": "string",
        "size": 42,
        "volume_type": "l_ssd",
        "creation_date": "string",
        "modification_date": "string",
        "organization": "string",
        "project": "string",
        "server": {
          "id": "string",
          "name": "string"
        },
        "state": "available",
        "zone": "string"
      }
    },
    "security_group": {
      "id": "string",
      "name": "string"
    },
    "maintenances": [
      {}
    ],
    "state_detail": "string",
    "arch": "x86_64",
    "placement_group": {
      "id": "string",
      "name": "string",
      "organization": "string",
      "project": "string",
      "policy_mode": "optional",
      "policy_type": "max_availability",
      "policy_respected": "boolean",
      "zone": "string"
    },
    "private_nics": [
      {
        "id": "string",
        "server_id": "string",
        "private_network_id": "string",
        "mac_address": "string"
      }
    ],
    "zone": "string"
  }
}

Delete a server

Delete a server with the given ID.

DELETE
/instance/v1/zones/{zone}/servers/{server_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
server_id
required string
204 Response
Empty response

List server actions

Liste all actions that can currently be performed on a server.

GET
/instance/v1/zones/{zone}/servers/{server_id}/action
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
server_id
required string
200 Response
actions
array
Response Example
{
  "actions": [
    "poweron"
  ]
}

Perform action

Perform power related actions on a server. Be wary that when terminating a server, all the attached volumes (local and block storage) are deleted. So, if you want to keep your local volumes, you must use the archive action instead of terminate. And if you want to keep block-storage volumes, you must detach it beforehand you issue the terminate call. For more information, read the Volumes documentation.

POST
/instance/v1/zones/{zone}/servers/{server_id}/action
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
server_id
required string
UUID of the server.
Body
action
string
The action to perform on the server. Possible values are poweron, backup, stop_in_place, poweroff, terminate and reboot. The default value is poweron.
name
nullable string
The name of the backup you want to create. This field should only be specified when performing a backup action. .
Request Example
{
  "action": "poweron",
  "name": "string"
}
200 Response
task
object
id
string
The unique ID of the task.
description
string
The description of the task.
progress
number
The progress of the task in percent.
started_at
string
The task start date.
terminated_at
string
The task end date.
status
string
The task status. Possible values are pending, started, success, failure and retry. The default value is pending.
href_from
string
href_result
string
zone
string
The zone in which is the task.
Response Example
{
  "task": {
    "id": "string",
    "description": "string",
    "progress": 42,
    "started_at": "string",
    "terminated_at": "string",
    "status": "pending",
    "href_from": "string",
    "href_result": "string",
    "zone": "string"
  }
}

Images

Images are backups of your instances. You can reuse that image to restore your data or create a series of instances with a predefined configuration.

An image is a complete backup of your server including all volumes.

List instance images

List all images available in an account.

GET
/instance/v1/zones/{zone}/images
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1 and nl-ams-1.
Query Parameters
organization
nullable string
per_page
nullable number
page
number
Page number. The default value is 1.
name
nullable string
public
nullable boolean
arch
nullable string
project
nullable string
200 Response
images
array
id
string
name
string
arch
string
Possible values are x86_64 and arm. The default value is x86_64.
creation_date
string
modification_date
string
default_bootscript
object
bootcmdargs
string
The bootscript arguments.
default
boolean
Dispmay if the bootscript is the default bootscript if no other boot option is configured.
dtb
string
Provide information regarding a Device Tree Binary (dtb) for use with C1 servers.
id
string
The bootscript ID.
initrd
string
The initrd (initial ramdisk) configuration.
kernel
string
The server kernel version.
organization
string
The bootscript organization ID.
project
string
The bootscript project ID.
public
boolean
Provide information if the bootscript is public.
title
string
The bootscript title.
arch
string
The bootscript arch. Possible values are x86_64 and arm. The default value is x86_64.
zone
string
The zone in which is the bootscript.
extra_volumes
map
<extra_volumeKey>
object
id
string
The volume unique ID.
name
string
The volume name.
export_uri
string
Show the volume NBD export URI.
size
number
The volume disk size (in bytes).
volume_type
string
The volume type. Possible values are l_ssd and b_ssd. The default value is l_ssd.
creation_date
string
The volume creation date.
modification_date
string
The volume modification date.